Get Order List

tip

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

HTTP Request

GET /contract/v3/private/order/list

Request Parameters

Parameter	Required	Type	Comments
symbol	false	string	Symbol name
orderId	false	string	Order id
orderLinkId	false	string	User customised order id
orderStatus	false	string	Order status. Return all status orders if not passed
orderFilter	false	string	Order,StopOrder
limit	false	string	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	Cursor. Used to pagination
list	list	Object
> symbol	string	Symbol name
> orderId	string	Order ID
> orderLinkId	string	User customised order ID.
> side	string	Buy,Sell
> orderType	string	Order type. Market,Limit. For TP/SL order, it means the order type after triggered
> price	string	Order price
> iv	string	Implied volatility
> qty	string	Order quantity
> timeInForce	string	Time in force
> orderStatus	string	Order status
> positionIdx	integer	Position index. 0: one-way mode, 1: buy side hedge mode, 2: sell side hedge mode
> lastPriceOnCreated	string	Last price when place the order
> createdTime	string	Order created timestamp (ms)
> updatedTime	string	Order updated timestamp (ms)
> cancelType	string	Cancel type
> rejectReason	string	Reject reason
> stopOrderType	string	Stop order type
> triggerDirection	string	Trigger direction. 1: rise, 2: fall
> triggerBy	string	The trigger type of trigger price
> triggerPrice	string	Trigger price
> cumExecValue	string	Cumulative executed order value
> cumExecFee	string	Cumulative executed trading fee
> cumExecQty	string	Cumulative executed order qty
> leavesValue	string	The estimated value not executed
> leavesQty	string	The remaining qty not executed
> takeProfit	string	Take profit price
> stopLoss	string	Stop loss price
> tpslMode	string	TP/SL mode, Full: entire position for TP/SL. Partial: partial position tp/sl
> tpLimitPrice	string	The limit order price when take profit price is triggered
> slLimitPrice	string	The limit order price when stop loss price is triggered
> tpTriggerBy	string	The price type to trigger take profit
> slTriggerBy	string	The price type to trigger stop loss
> reduceOnly	boolean	Reduce only. true means reduce position size
> closeOnTrigger	boolean	Close on trigger. What is a close on trigger order?. Keeps "" for option
> blockTradeId	string	Paradigm block trade ID
> smpType	string	SMP execution type
> smpGroup	integer	Smp group ID. If the uid has no group, it is 0 by default
> smpOrderId	string	The counterparty's orderID which triggers this SMP execution

Request Example

GET /contract/v3/private/order/list?symbol=BTCUSDT&orderId=806f5fc6-d487-46d1-9a57-4b4964126c90 HTTP/1.1
Host: api-testnet.bybit.com
X-BAPI-SIGN: XXXXX
X-BAPI-API-KEY: XXXXX
X-BAPI-TIMESTAMP: 1673420679798
X-BAPI-RECV-WINDOW: 5000
cdn-request-id: test-10

Response Example

{
    "retCode": 0,
    "retMsg": "OK",
    "result": {
        "list": [
            {
                "symbol": "BTCUSDT",
                "side": "Buy",
                "orderType": "Limit",
                "price": "26864.40",
                "qty": "0.003",
                "reduceOnly": false,
                "timeInForce": "PostOnly",
                "orderStatus": "Cancelled",
                "leavesQty": "0.000",
                "leavesValue": "0",
                "cumExecQty": "0.000",
                "cumExecValue": "0",
                "cumExecFee": "0",
                "lastPriceOnCreated": "0.00",
                "rejectReason": "EC_PerCancelRequest",
                "orderLinkId": "YLxaWKMiHU",
                "createdTime": "1684810640078",
                "updatedTime": "1684810770380",
                "orderId": "806f5fc6-d487-46d1-9a57-4b4964126c90",
                "stopOrderType": "UNKNOWN",
                "takeProfit": "0.00",
                "stopLoss": "0.00",
                "tpTriggerBy": "UNKNOWN",
                "slTriggerBy": "UNKNOWN",
                "triggerPrice": "0.00",
                "closeOnTrigger": false,
                "triggerDirection": 0,
                "positionIdx": 1,
                "cancelType": "CancelByUser",
                "iv": "",
                "triggerBy": "UNKNOWN",
                "blockTradeId": "",
                "tpslMode": "Full",
                "tpLimitPrice": "",
                "slLimitPrice": "",
                "smpType": "None",
                "smpGroup": 0,
                "smpOrderId": ""
            }
        ],
        "nextPageCursor": "eyJza2lwX2xvY2FsX3N5bWJvbCI6ZmFsc2UsInBhZ2VfdG9rZW4iOiIzOTQ3NCJ9",
        "category": ""
    },
    "retExtInfo": {},
    "time": 1684810802126
}