Get Order List

tip

Query order list.
As order creation/cancellation is asynchronous, the data returned from this endpoint may delay.

HTTP Request

GET /unified/v3/private/order/list

Request Parameters

Parameter	Required	Type	Comments
category	true	string	Product type. linear, option
symbol	false	string	Symbol name
baseCoin	false	string	Base coin. Ifcategory=option，then it returns BTC data when this field is not passed
orderId	false	string	Order id
orderLinkId	false	string	User customised order id
orderStatus	false	string	Return all status orders if not passed. You could pass multiple status, separated by comma
orderFilter	false	string	Order: active order, StopOrder: conditional order
direction	false	string	Page direction. prev, next. Default: next
limit	false	integer	Limit for data size per page. [1, 50]. Default: 20
cursor	false	string	Cursor. Use the nextPageCursor token from the response to retrieve the next page of the result set

Response Parameters

Parameter	Type	Comments
category	string	Product type
nextPageCursor	string	Refer to the cursor request parameter
list	array	Object
> orderId	string	Order ID
> orderLinkId	string	User customised order ID
> blockTradeId	string	Paradigm block trade ID
> symbol	string	Symbol name
> iv	string	Implied volatility. linear does not have this field
> price	string	Order price
> qty	string	Order qty
> side	string	Side. Buy,Sell
> orderStatus	string	Order status
> orderType	string	Order type. Market,Limit
> stopOrderType	string	Stop order type. option does not have this field
> rejectReason	string	The reason of rejection
> cumExecValue	string	Cumulative executed order value
> cumExecFee	string	Cumulative executed trading fee
> cumExecQty	string	Cumulative executed order qty
> tpTriggerBy	string	The price type to trigger take profit. option does not have this field
> slTriggerBy	string	Stop loss price. option does not have this field
> timeInForce	string	Time in force
> basePrice	string	Base price
> triggerBy	string	The price type of trigger price. option does not have this field
> triggerPrice	string	Trigger price. If stopOrderType=TrailingStop, it is activate price. Otherwise, it is trigger price. option does not have this field
> leavesQty	string	The remaining qty not executed
> leavesValue	string	The remaining value not executed. option does not have this field
> reduceOnly	boolean	Reduce only. true means reduce position size
> closeOnTrigger	boolean	Close on trigger. option does not have this field
> takeProfit	string	Take profit price. option does not have this field
> stopLoss	string	Stop loss price. option does not have this field
> orderIM	string	Order initial margin. For portfolio margin mode, it returns ""
> createdTime	number	Order created timestamp (ms)
> updatedTime	number	Order updated timestamp (ms)

Request Example

GET /unified/v3/private/order/list?category=linear&orderFilter=StopOrder&limit=1 HTTP/1.1
Host: api-testnet.bybit.com
X-BAPI-SIGN: XXXXX
X-BAPI-API-KEY: XXXXX
X-BAPI-TIMESTAMP: 1672811957817
X-BAPI-RECV-WINDOW: 5000
cdn-request-id: test-002

Response Example

{
    "retCode": 0,
    "retMsg": "OK",
    "result": {
        "nextPageCursor": "c6f055d9-7f21-4079-913d-e6523a9cfffa%3A1672216686849%2Cc6f055d9-7f21-4079-913d-e6523a9cfffa%3A1672216686849",
        "category": "linear",
        "list": [
            {
                "symbol": "ETHPERP",
                "orderType": "Limit",
                "orderLinkId": "linear-004",
                "orderId": "c6f055d9-7f21-4079-913d-e6523a9cfffa",
                "stopOrderType": "Stop",
                "orderStatus": "Deactivated",
                "takeProfit": "",
                "cumExecValue": "0",
                "blockTradeId": "",
                "rejectReason": "EC_NoError",
                "price": "1050",
                "createdTime": 1672216686849,
                "tpTriggerBy": "UNKNOWN",
                "timeInForce": "GoodTillCancel",
                "basePrice": "1188",
                "leavesValue": "0",
                "updatedTime": 1672217377166,
                "side": "Sell",
                "triggerPrice": "1145.00000000",
                "cumExecFee": "0",
                "slTriggerBy": "UNKNOWN",
                "leavesQty": "0",
                "closeOnTrigger": false,
                "cumExecQty": "0",
                "reduceOnly": false,
                "qty": "0.15",
                "stopLoss": "",
                "triggerBy": "MarkPrice",
                "orderIM": ""
            }
        ]
    },
    "retExtInfo": {},
    "time": 1672811958171
}