Skip to navigation
API ReferenceAccount

Set leverage

Set the leverage of an instrument or currency. There are 5 different combinations of leverage settings depending on margin mode and position mode.

Authentication

OK-ACCESS-KEYstring
Your API key.
OK-ACCESS-SIGNstring

Base64-encoded HMAC-SHA256 signature of the prehash string.

OK-ACCESS-TIMESTAMPstring

ISO 8601 UTC timestamp, e.g. 2020-12-08T09:08:57.715Z.

OK-ACCESS-PASSPHRASEstring
The passphrase you set when creating the API key.

Request

This endpoint expects an object.
leverstringRequired
Leverage.
mgnModeenumRequired
Margin mode. Can only be cross if ccy is passed.
Allowed values:
instIdstringOptional

Instrument ID, required for isolated margin or when setting per-instrument leverage.

ccystringOptional

Currency used for margin, only applicable to cross MARGIN of Multi-currency margin.

posSideenumOptional

Position side, required when margin mode is isolated in long/short mode for FUTURES/SWAP.

Allowed values:

Response

Successful response
codestringOptional

Result code. 0 means success; any other value is an error code.

msgstringOptional
Error message. Empty on success.
datalist of objectsOptional