Skip to navigation
API ReferenceAccount

Get max order size

Retrieve the maximum buy or sell amount for a specific instrument under a given trade 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.

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 in Single-currency/Multi-currency margin.

pxstringOptional

Price. Used for calculating available amount; defaults to last traded price if omitted.

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