For the complete documentation index, see llms.txt. This page is also available as Markdown.

POST /leverage

Set per-market leverage for the connected account

Set per-market leverage for the connected account.

operationId: setLeverage · CCXT method: setLeverage

Authentication: hmacAuth.

Stores the account's leverage for one market. It is a standing setting, not an order parameter: initial margin for every subsequent order in that market is notional / leverage, so raising it lowers the margin an order requires and lowering it raises it.

Accepts any whole number in 1..=max, where max is the market's effective ceiling — min(max_leverage, floor(1 / initial_margin_rate)), because the market's margin rate floors margin and so also caps leverage. Read max_leverage from GET /markets/{market_id}/risk-params. There is no fixed tier set; the preset chips a frontend offers (3x / 5x / 10x / 20x) are its own choice on top of this range.

Leverage left unset behaves as the market maximum, so a client need not call this before its first order. It changes the initial margin a NEW order requires; it does not move the projected liquidation price, which POST /orders/preview reports identically at any leverage because that price is set by the maintenance-margin rate.

Request body

Required. application/json. The contract declares no schema for this body — only the example below, so a generated client gets an untyped body here.

{
  "market_id": "BTC-USDX-PERP",
  "leverage": 10
}

Responses

Status
Body
Meaning

200

(no schema declared)

The stored setting, echoed back.

400

(no schema declared)

InvalidLeverage — below the 1x floor (including 0); or LeverageExceedsMax — above the market's effective ceiling, whose message carries both the requested value and that ceiling.

401

(no schema declared)

403

(no schema declared)

404

(no schema declared)

MarketNotFound — no such market.

429

(no schema declared)

Example

X-Signature is a placeholder: it is derived from this specific request. See Authentication for the canonical string and the HMAC rule.


Generated from eng/apps/exchange/api/openapi.json (spec 0.9.36). Do not edit by hand — regenerate with python3 product/docs/tools/api-reference/generate.py. Hand-authored context lives in the Guides pages.

Last updated