Order Channel
Description
Subscribe to order channel
Request Parameters
Parameter | Type | Required | Description |
---|---|---|---|
event | String | Yes | Operation: subscribe, unsubscribe |
channel | String | Yes | Channel name |
Request Example
{
"event": "subscribe",
"channel": "orders"
}
Response Parameters
Field | Type | Description |
---|---|---|
event | String | Operation: subscribed, unsubscribed |
channel | String | Channel name |
Subscription Response Example
{
"event": "subscribed",
"channel": "orders"
}
Push Data Parameters
Field | Type | Description |
---|---|---|
Return Field | Parameter Type | Field Description |
:------------------------ | :-------------- | :----------------------------------------------------------------------------------------------------- |
id | String | Order ID (value > 0) |
symbolName | String | Trading pair name |
baseCoin | String | Base currency |
quoteCoin | String | Quote currency |
orderSide | String | Order direction (BUY/SELL) |
price | String | Order price (worst acceptable price) |
size | String | Order quantity |
value | String | Order value |
clientOrderId | String | Client-defined ID (for idempotency verification) |
type | String | Order type |
timeInForce | String | Order execution strategy (valid when type is LIMIT/STOP_LIMIT/TAKE_PROFIT_LIMIT) |
reduceOnly | String | Whether reduce-only order |
triggerPrice | String | Trigger price (valid for STOP_LIMIT/STOP_MARKET/TAKE_PROFIT_LIMIT/TAKE_PROFIT_MARKET). 0 means empty. |
orderSource | String | Order source |
openTpslParentOrderId | String | Opening order ID for take-profit/stop-loss orders |
isSetOpenTp | String | Whether take-profit is set for opening |
openTpParam | String | Take-profit parameters for opening |
isSetOpenSl | String | Whether stop-loss is set for opening |
openSlParam | String | Stop-loss parameters for opening |
takerFeeRate | String | Taker fee rate when placing order |
makerFeeRate | String | Maker fee rate when placing order |
feeDiscount | String | Fee discount rate when placing order |
liquidateFeeRate | String | Liquidation fee rate when placing order |
status | String | Order status |
triggerTime | String | Conditional order trigger time |
triggerPriceTime | String | Conditional order trigger price time |
triggerPriceValue | String | Conditional order trigger price value |
cancelReason | String | Order cancellation reason |
latestFillPrice | String | Latest execution price of current order |
maxFillPrice | String | Highest execution price of current order |
minFillPrice | String | Lowest execution price of current order |
cumFillSize | String | Cumulative filled quantity after matching |
cumFillValue | String | Cumulative filled value after matching |
cumFillFee | String | Cumulative filled fees after matching |
createdTime | String | Creation time |
updatedTime | String | Update time |
Push Response Example
{
"type": "trade-event",
"channel": "orders",
"msg": {
"msgEvent": "OrderUpdate",
"version": 38,
"data": {
"order": [
{
"id": "625138763307155610",
"symbolName": "BTCUSDT_SPBL",
"baseCoin": "BTC",
"quoteCoin": "USDT",
"orderSide": "BUY",
"price": "0",
"size": "0",
"value": "100.0000000",
"clientOrderId": "1749044695347g1xrdKa2xuDzbDHgTTkbubUoRd3x7s9c2I2mdtdj5qt7M6Evz5m",
"type": "MARKET",
"timeInForce": "IMMEDIATE_OR_CANCEL",
"reduceOnly": false,
"triggerPrice": "0",
"orderSource": "UNKNOWN_ORDER_SOURCE",
"openTpslParentOrderId": "0",
"isSetOpenTp": false,
"isSetOpenSl": false,
"takerFeeRate": "0.001",
"makerFeeRate": "0",
"feeDiscount": "1",
"takerFeeDiscount": "1",
"makerFeeDiscount": "1",
"status": "FILLED",
"triggerTime": "0",
"triggerPriceTime": "0",
"triggerPriceValue": "0",
"cancelReason": "UNKNOWN_ORDER_CANCEL_REASON",
"latestFillPrice": "105008.0",
"maxFillPrice": "105008.0",
"minFillPrice": "105008.0",
"cumFillSize": "0.000952",
"cumFillValue": "99.9676160",
"cumFillFee": "0.00000095",
"createdTime": "1749044695689",
"updatedTime": "1749044695720"
}
]
},
"time": 1749044695720
},
"event": "payload"
}