Skip to navigation
API ReferenceSpread Trading

Get active spread orders

Retrieve all incomplete spread orders under the current account.

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

sprdIdstringOptional

Spread ID, e.g. BTC-USDT_BTC-USDT-SWAP.

ordTypeenumOptional
Order type.
Allowed values:
stateenumOptional
Order state.
Allowed values:
beginIdstringOptional
Start order ID the request to begin with. Pagination of data to return records newer than the requested ordId, not including beginId.
endIdstringOptional
End order ID the request to end with. Pagination of data to return records older than the requested ordId, not including endId.
limitstringOptional

Number of results per request. The maximum is 100; the default is 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