Skip to navigation
API ReferenceAccount

Get positions

Retrieve information on your positions. When the account is in net mode, net positions are returned; in long/short mode, long or short positions are returned.

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

instTypeenumOptional
Instrument type.
Allowed values:
instIdstringOptional

Instrument ID, e.g. BTC-USDT-SWAP. Multiple instrument IDs (no more than 10) separated with comma.

posIdstringOptional

Single position ID or multiple position IDs (no more than 20) separated with comma.

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