Get Order List

Description

List your current orders.

Any limit order on the exchange order book is in active status. Orders removed from the order book will be marked with done status. After an order becomes done, there may be a few milliseconds latency before it’s fully settled.

You can check the orders in any status. If the status parameter is not specified, orders of done status will be returned by default.

When you query orders in active status, there is no time limit. However, when you query orders in done status, the start and end time range cannot exceed 24 * 7 hours. An error will occur if the specified time window exceeds the range. If you specify the end time only, the system will automatically calculate the start time as end time minus 24 hours, and vice versa.

POLLING
For high-volume trading, it is highly recommended that you maintain your own list of open orders and use one of the streaming market data feeds to keep it updated. You should poll the open orders endpoint to obtain the current state of any open order.

If you need to get your recent trade history with low latency, you may query the endpoint Get List of Orders Completed in 24h.

API KEY PERMISSIONS
This endpoint requires the General permission.

REQUEST URL
This endpoint support Futures URL

REQUEST RATE LIMIT
Futures weight：2

Request

Query Params

status

enum<string>

optional

active or done, done as default. Only list orders for a specific status

Allowed values:

activedone

Example:

done

symbol

string

optional

Symbol of the contract, Please refer to Get Symbol endpoint: symbol

side

enum<string>

optional

buy or sell

Allowed values:

buysell

type

enum<string>

optional

Order Type

Allowed values:

limitmarketlimit_stopmarket_stopoco_limitoco_stop

startAt

integer <int64>

optional

Start time (milisecond)

endAt

integer <int64>

optional

End time (milisecond)

currentPage

integer

optional

Current request page, The default currentPage is 1

Default:

pageSize

integer

optional

pageSize, The default pageSize is 50, The maximum cannot exceed 1000

<= 1000

Default:

Responses

🟢200OK

application/json

Body

code

string

required

data

object

required

currentPage

integer

required

Current request page, The default currentPage is 1

pageSize

integer

required

pageSize, The default pageSize is 50, The maximum cannot exceed 1000

totalNum

integer

required

totalPage

integer

required

items

array [object {38}]

required

Example

{
  "code": "200000",
  "data": {
    "currentPage": 1,
    "pageSize": 50,
    "totalNum": 1,
    "totalPage": 1,
    "items": [
      {
        "id": "230181737576050688",
        "symbol": "PEOPLEUSDTM",
        "type": "limit",
        "side": "buy",
        "price": "0.05",
        "size": 10,
        "value": "5",
        "dealValue": "0",
        "dealSize": 0,
        "stp": "",
        "stop": "",
        "stopPriceType": "",
        "stopTriggered": false,
        "stopPrice": null,
        "timeInForce": "GTC",
        "postOnly": false,
        "hidden": false,
        "iceberg": false,
        "leverage": "1",
        "forceHold": false,
        "closeOrder": false,
        "visibleSize": 0,
        "clientOid": "5a80bd847f1811ef8a7faa665a37b3d7",
        "remark": null,
        "tags": "",
        "isActive": true,
        "cancelExist": false,
        "createdAt": 1727692804813,
        "updatedAt": 1727692804813,
        "endAt": null,
        "orderTime": 1727692804808418000,
        "settleCurrency": "USDT",
        "marginMode": "ISOLATED",
        "avgDealPrice": "0",
        "filledSize": 0,
        "filledValue": "0",
        "status": "open",
        "reduceOnly": false
      }
    ]
  }
}

Request

Request samples

Responses