Skip to main content

Orders Channel

Get the order updates

Request Parameters

ParameterTypeRequiredDescription
opstringYesOperation, subscribe unsubscribe
argslistYesList of channels to request subscription
> instTypestringYesProduct type: SPOT
> channelstringYesChannel name: orders
> instIdstringNoProduct ID (optional, e.g. BTCUSDT)

Request Example

{
"op": "subscribe",
"args": [
{
"instType": "SPOT",
"channel": "orders",
"instId": "BTCUSDT"
}
]
}

Response Example

{
"event": "subscribe",
"arg": {
"instType": "SPOT",
"channel": "orders",
"instId": "BTCUSDT"
}
}

Push Parameters

ParameterTypeDescription
actionstringPush data action: snapshot / update
argobjectChannels with successful subscription
> instTypestringProduct type: SPOT
> channelstringChannel name: orders
> instIdstringProduct ID
datalistOrder data list
> instIdstringProduct ID (e.g. BTCUSDT)
> orderIdstringOrder ID
> pricestringOrder price
> sizestringOrder size
> orderTypestringOrder type: limit / market
> sidestringOrder side: buy / sell
> filledSizestringFilled size
> priceAvgstringAverage filled price
> statusstringOrder status
> feeDetaillistFee details
> cTimestringCreate time
> uTimestringUpdate time
tsnumberPush timestamp

Order Status

StatusDescription
liveOrder is active
partially_filledOrder is partially filled
filledOrder is completely filled
cancelledOrder is cancelled

Push Data

{
"action": "snapshot",
"arg": {
"instType": "SPOT",
"channel": "orders",
"instId": "BTCUSDT"
},
"data": [
{
"instId": "BTCUSDT",
"orderId": "123456789",
"price": "27000.0",
"size": "0.1",
"orderType": "limit",
"side": "buy",
"filledSize": "0.05",
"priceAvg": "27000.0",
"status": "partially_filled",
"feeDetail": [
{
"feeCoin": "USDT",
"fee": "1.35"
}
],
"cTime": "1695716700000",
"uTime": "1695716760565"
}
],
"ts": 1695716761589
}