Skip to navigation
API ReferenceAccount

Get positions history

Retrieve the position history of the account. Records are retained for the last 3 months.

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.
mgnModeenumOptional
Margin mode.
Allowed values:
typeenumOptional

The type of the latest close position: 1 close partially, 2 close all, 3 liquidation, 4 partial liquidation, 5 ADL.

Allowed values:
posIdstringOptional
Position ID.
afterstringOptional
Pagination of data to return records earlier than the requested uTime, Unix timestamp in milliseconds.
beforestringOptional
Pagination of data to return records newer than the requested uTime, Unix timestamp in milliseconds.
limitstringOptional
Number of results per request. Maximum 100, default 100.

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