Skip to main content

Get Order History

info
  • orderId & orderLinkId has a higher priority than startTime & endTime
  • Fully cancelled orders are stored for up to 24 hours.

Single leg orders can also be found with "createType"=CreateByFutureSpread via Get Order History

HTTP Request

GET /v5/spread/order/history

Request Parameters

ParameterRequiredTypeComments
symbolfalsestringSpread combination symbol name
baseCoinfalsestringBase coin
orderIdfalsestringSpread combination order ID
orderLinkIdfalsestringUser customised order ID
startTimefalselongThe start timestamp (ms)
  • startTime and endTime are not passed, return 7 days by default
  • Only startTime is passed, return range between startTime and startTime+7 days
  • Only endTime is passed, return range between endTime-7 days and endTime
  • If both are passed, the rule is endTime - startTime <= 7 days
endTimefalselongThe end timestamp (ms)
limitfalseintegerLimit for data size per page. [1, 50]. Default: 20
cursorfalsestringCursor. Use the nextPageCursor token from the response to retrieve the next page of the result set

Response Parameters

ParameterTypeComments
listarray<object>Order info
> symbolstringSpread combination symbol name
> orderTypestringOrder type, Market, Limit
> orderLinkIdstringUser customised order ID
> orderIdstringSpread combination order ID
> contractTypestringCombo type
  • FundingRateArb: perpetual & spot combination
  • CarryTrade: futures & spot combination
  • FutureSpread: different expiry futures combination
  • PerpBasis: futures & perpetual
> cxlRejReasonstringReject reason
> orderStatusstringOrder status, Rejected, Cancelled, Filled
> pricestringOrder price
> orderQtystringOrder qty
> timeInForcestringTime in force, GTC, FOK, IOC, PostOnly
> baseCoinstringBase coin
> createdAtstringOrder created timestamp (ms)
> updatedAtstringOrder updated timestamp (ms)
> sidestringSide, Buy, Sell
> leavesQtystringThe remaining qty not executed. It is meaningless for a cancelled order
> settleCoinstringSettle coin
> cumExecQtystringCumulative executed order qty
> qtystringOrder qty
> leg1SymbolstringLeg1 symbol name
> leg1ProdTypestringLeg1 product type, Futures, Spot
> leg1OrderIdstringLeg1 order ID
> leg1SidestringLeg1 order side
> leg2ProdTypestringLeg2 product type, Futures, Spot
> leg2OrderIdstringLeg2 order ID
> leg2SymbolstringLeg2 symbol name
> leg2SidestringLeg2 orde side
nextPageCursorstringRefer to the cursor request parameter

Request Example

GET /v5/spread/order/history?orderId=aaaee090-fab3-42ea-aea0-c9fbfe6c4bc4 HTTP/1.1
Host: api-testnet.bybit.com
X-BAPI-SIGN: XXXXXX
X-BAPI-API-KEY: XXXXXX
X-BAPI-TIMESTAMP: 1744100522465
X-BAPI-RECV-WINDOW: 5000
Content-Type: application/json

Response Example

{
"retCode": 0,
"retMsg": "Success",
"result": {
"nextPageCursor": "aaaee090-fab3-42ea-aea0-c9fbfe6c4bc4%3A1744096099767%2Caaaee090-fab3-42ea-aea0-c9fbfe6c4bc4%3A1744096099767",
"list": [
{
"symbol": "SOLUSDT_SOL/USDT",
"orderType": "Limit",
"orderLinkId": "",
"orderId": "aaaee090-fab3-42ea-aea0-c9fbfe6c4bc4",
"contractType": "FundingRateArb",
"orderStatus": "Cancelled",
"createdAt": "1744096099767",
"price": "-4",
"leg2Symbol": "SOLUSDT",
"orderQty": "0.1",
"timeInForce": "PostOnly",
"baseCoin": "SOL",
"updatedAt": "1744098396079",
"side": "Buy",
"leg2Side": "Sell",
"leavesQty": "0",
"leg1Side": "Buy",
"settleCoin": "USDT",
"cumExecQty": "0",
"qty": "0.1",
"leg1OrderId": "82335b0a-b7d9-4ea5-9230-e71271a65100",
"leg2OrderId": "1924011967786517249",
"leg2ProdType": "Spot",
"leg1ProdType": "Futures",
"leg1Symbol": "SOLUSDT"
}
]
},
"retExtInfo": {},
"time": 1744102655725
}