Skip to navigation
API ReferenceTrade

Get order list

Retrieve all incomplete 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

instTypeenumOptional

Instrument type SPOT MARGIN SWAP FUTURES OPTION EVENTS

Allowed values:
ulystringOptional

Underlying, e.g. BTC-USD. Applicable to FUTURES/SWAP/OPTION.

instFamilystringOptional

Instrument family Applicable to FUTURES/SWAP/OPTION

instIdstringOptional

Instrument ID, e.g. BTC-USD-200927

ordTypestringOptional

Order type market: Market order limit: Limit order post_only: Post-only order fok: Fill-or-kill order ioc: Immediate-or-cancel order optimal_limit_ioc: Market order with immediate-or-cancel order mmp: Market Maker Protection (only applicable to Option in Portfolio Margin mode) mmp_and_post_only: Market Maker Protection and Post-only order(only applicable to Option in Portfolio Margin mode) op_fok: Simple options (fok) rpi: Retail Price Improvement order elp: Enhanced Liquidity Program order (Deprecated; use rpi. Accepted until October 31, 2026.)

stateenumOptional

State live partially_filled

Allowed values:
afterstringOptional

Pagination of data to return records earlier than the requested ordId

beforestringOptional

Pagination of data to return records newer than the requested ordId

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