Skip to navigation
API ReferenceCopy Trading

Existing leading positions

Retrieve lead positions that are not closed.

Returns reverse chronological order with openTime

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 SPOT SWAP It returns all types by default.

Allowed values:
instIdstringOptional

Instrument ID, e.g. BTC-USDT-SWAP

uniqueCodestringOptional
Lead trader unique code. If left blank, the current lead trader's positions are returned.
subPosTypeenumOptional

Sub position type. lead: lead trade; copy: copy trade. Default is lead.

Allowed values:
afterstringOptional

Pagination of data to return records earlier than the requested subPosId.

beforestringOptional

Pagination of data to return records newer than the requested subPosId.

limitstringOptional
Number of results per request. Maximum is 500. Default is 500.

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