Skip to navigation

Get max available size

Retrieve the maximum available tradable amount that can be opened for a specific instrument, considering existing balances and positions.

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.

Query parameters

instIdstringRequired

Single instrument or multiple instruments (no more than 5) separated with comma, e.g. BTC-USDT.

tdModeenumRequired
Trade mode.
Allowed values:
ccystringOptional
Currency used for margin, only applicable to MARGIN.
reduceOnlybooleanOptional
Whether to reduce position only. Only applicable to MARGIN.
unSpotOffsetbooleanOptional
true disables the spot offset mode. Only applicable to Portfolio margin.
quickMgnTypeenumOptional
Quick margin type. Only applicable to quick margin mode of isolated MARGIN.
Allowed values:
tradeQuoteCcystringOptional
The quote currency used for trading.

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