Orders Channel
Get the order updates
Request Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| op | string | Yes | Operation, subscribe unsubscribe |
| args | list | Yes | List of channels to request subscription |
| > instType | string | Yes | Product type: USDT-FUTURES |
| > channel | string | Yes | Channel name: orders |
| > instId | string | No | Product 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
| Parameter | Type | Description |
|---|---|---|
| action | string | Push data action |
| arg | object | Channels with successful subscription |
| > instType | string | Product type |
| > channel | string | Channel name |
| > instId | string | Product ID |
| data | object | Order data |
| > symbol | string | Symbol |
| > size | string | Order size |
| > orderId | string | Order ID |
| > clientOid | string | Client order ID |
| > priceAvg | string | Average filled price |
| > fee | string | Fee |
| > price | string | Order price |
| > status | string | Order status |
| > side | string | Order side: LONG / SHORT |
| > force | string | Time in force: POST_ONLY, etc. |
| > totalProfits | string | Total profits |
| > posSide | string | Position side |
| > marginCoin | string | Margin coin |
| > orderType | string | Order type: LIMIT / MARKET |
| > leverage | string | Leverage |
| > marginMode | string | Margin mode |
| > tradeSide | string | Trade side: OPEN / CLOSE |
| > presetTakeProfitPrice | string | Preset take profit price |
| > presetTakeProfitExecutePrice | string | TP trigger price |
| > presetTakeProfitType | string | TP order type |
| > presetStopLossPrice | string | Preset stop loss price |
| > presetStopLossExecutePrice | string | SL trigger price |
| > presetStopLossType | string | SL order type |
| > cTime | number | Create time |
| > uTime | number | Update time |
| ts | number | Push 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
}