Skip to main content

Orders Channel

Get the order updates

Request Parameters

ParameterTypeRequiredDescription
opstringYesOperation, subscribe unsubscribe
argslistYesList of channels to request subscription
> instTypestringYesProduct type: USDT-FUTURES
> channelstringYesChannel name: orders
> instIdstringNoProduct ID (optional)

Request Example

{
"op": "subscribe",
"args": [
{
"instType": "USDT-FUTURES",
"channel": "orders",
"instId": "default"
}
]
}

Response Example

{
"event": "subscribe",
"arg": {
"instType": "USDT-FUTURES",
"channel": "orders",
"instId": "default"
}
}

Push Parameters

ParameterTypeDescription
actionstringPush data action
argobjectChannels with successful subscription
> instTypestringProduct type
> channelstringChannel name
> instIdstringProduct ID
dataobjectOrder data
> symbolstringSymbol
> sizestringOrder size
> orderIdstringOrder ID
> clientOidstringClient order ID
> priceAvgstringAverage filled price
> feestringFee
> pricestringOrder price
> statusstringOrder status
> sidestringOrder side: LONG / SHORT
> forcestringTime in force: POST_ONLY, etc.
> totalProfitsstringTotal profits
> posSidestringPosition side
> marginCoinstringMargin coin
> orderTypestringOrder type: LIMIT / MARKET
> leveragestringLeverage
> marginModestringMargin mode
> tradeSidestringTrade side: OPEN / CLOSE
> presetTakeProfitPricestringPreset take profit price
> presetTakeProfitExecutePricestringTP trigger price
> presetTakeProfitTypestringTP order type
> presetStopLossPricestringPreset stop loss price
> presetStopLossExecutePricestringSL trigger price
> presetStopLossTypestringSL order type
> cTimenumberCreate time
> uTimenumberUpdate time
tsnumberPush timestamp

Push Data

{
"action": "snapshot",
"arg": {
"instType": "USDT-FUTURES",
"channel": "orders",
"instId": "default"
},
"data": {
"symbol": "BTCUSDT",
"size": "0.1",
"orderId": "123456789",
"clientOid": "my-order-001",
"priceAvg": "27000.0",
"fee": "2.70",
"price": "27000.0",
"status": "FILLED",
"side": "LONG",
"force": "",
"totalProfits": "0",
"posSide": "LONG",
"marginCoin": "USDT",
"orderType": "LIMIT",
"leverage": "10",
"marginMode": "ISOLATED",
"tradeSide": "OPEN",
"presetTakeProfitPrice": "28000.0",
"presetTakeProfitExecutePrice": "28000.0",
"presetTakeProfitType": "MARKET",
"presetStopLossPrice": "26000.0",
"presetStopLossExecutePrice": "26000.0",
"presetStopLossType": "MARKET",
"cTime": 1695716700000,
"uTime": 1695716760565
},
"ts": 1695716761589
}