Skip to main content
Version: V2

Order Channel

Description

Subscribe to order channel

Request Parameters

ParameterTypeRequiredDescription
eventStringYesOperation: subscribe, unsubscribe
channelStringYesChannel name

Request Example

{  
"event": "subscribe",
"channel": "orders"
}

Response Parameters

FieldTypeDescription
eventStringOperation: subscribed, unsubscribed
channelStringChannel name

Subscription Response Example

{  
"event": "subscribed",
"channel": "orders"
}

Push Data Parameters

FieldTypeDescription
Return FieldParameter TypeField Description
:------------------------:--------------:-----------------------------------------------------------------------------------------------------
idStringOrder ID (value > 0)
symbolNameStringTrading pair name
baseCoinStringBase currency
quoteCoinStringQuote currency
orderSideStringOrder direction (BUY/SELL)
priceStringOrder price (worst acceptable price)
sizeStringOrder quantity
valueStringOrder value
clientOrderIdStringClient-defined ID (for idempotency verification)
typeStringOrder type
timeInForceStringOrder execution strategy (valid when type is LIMIT/STOP_LIMIT/TAKE_PROFIT_LIMIT)
reduceOnlyStringWhether reduce-only order
triggerPriceStringTrigger price (valid for STOP_LIMIT/STOP_MARKET/TAKE_PROFIT_LIMIT/TAKE_PROFIT_MARKET). 0 means empty.
orderSourceStringOrder source
openTpslParentOrderIdStringOpening order ID for take-profit/stop-loss orders
isSetOpenTpStringWhether take-profit is set for opening
openTpParamStringTake-profit parameters for opening
isSetOpenSlStringWhether stop-loss is set for opening
openSlParamStringStop-loss parameters for opening
takerFeeRateStringTaker fee rate when placing order
makerFeeRateStringMaker fee rate when placing order
feeDiscountStringFee discount rate when placing order
liquidateFeeRateStringLiquidation fee rate when placing order
statusStringOrder status
triggerTimeStringConditional order trigger time
triggerPriceTimeStringConditional order trigger price time
triggerPriceValueStringConditional order trigger price value
cancelReasonStringOrder cancellation reason
latestFillPriceStringLatest execution price of current order
maxFillPriceStringHighest execution price of current order
minFillPriceStringLowest execution price of current order
cumFillSizeStringCumulative filled quantity after matching
cumFillValueStringCumulative filled value after matching
cumFillFeeStringCumulative filled fees after matching
createdTimeStringCreation time
updatedTimeStringUpdate 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"
}