Skip to main content

Order

Subscribe to the order stream to see new orders, when an order's order status changes, etc.

Topic:
user.order.unifiedAccount

Response Parameters

ParameterTypeComments
idstringMessage id
topicstringTopic name
typestringMessage type. snapshot
tsnumberThe timestamp (ms) that system generates the data.
dataObject
> versionintegerVersion
> resultarrayObject
>> symbolstringSymbol name
>> sidestringSide. Buy,Sell
>> orderIdstringOrder id
>> orderLinkIdstringUser customised order id
>> orderTypestringOrder type. Market,Limit
>> stopOrderTypestringStop order type
>> orderStatusstringOrder status
>> pricestringOrder price
>> qtystringOrder qty
>> timeInForcestringTime in force
>> cumExecQtystringCumulative executed order qty
>> cumExecValuestringCumulative executed order value
>> cumExecFeestringCumulative executed trading fee
>> leavesQtystringThe remaining qty not executed
>> triggerBystringThe price type of trigger price
>> triggerPricestringTrigger price. If stopOrderType=TrailingStop, it is activate price. Otherwise, it is trigger price
>> reduceOnlybooleanReduce only. true means reduce position size
>> closeOnTriggerbooleanClose on trigger. What is a close on trigger order?
>> ivstringImplied volatility
>> orderIMstringOrder initial margin. For portfolio margin mode, it returns ""
>> takeProfitstringTake profit price
>> stopLossstringStop loss price
>> tpTriggerBystringThe price type to trigger take profit
>> slTriggerBystringThe price type to trigger stop loss
>> basePricestringBase price
>> blockTradeIdstringBlock trade ID
>> createdTimenumberOrder created timestamp (ms)
>> updatedTimenumberOrder updated timestamp (ms)

Stream Example

{
"id": "533285293a44e9-7925-445c-a62c-01d7726c6543",
"topic": "user.order.unifiedAccount",
"ts": 1672063477614,
"data": {
"result": [
{
"orderId": "38554b22-e4fa-4327-9250-3fc81aa4e30a",
"orderLinkId": "",
"symbol": "SCUSDT",
"side": "Sell",
"orderType": "Market",
"price": "0.00224",
"qty": "100",
"timeInForce": "ImmediateOrCancel",
"orderStatus": "Filled",
"cumExecQty": "100",
"cumExecValue": "0.234",
"cumExecFee": "0.0001404",
"stopOrderType": "UNKNOWN",
"triggerBy": "UNKNOWN",
"triggerPrice": "0",
"reduceOnly": true,
"closeOnTrigger": true,
"createdTime": 1672063477568,
"updatedTime": 1672063477578,
"iv": "",
"orderIM": "",
"takeProfit": "0",
"stopLoss": "0",
"tpTriggerBy": "UNKNOWN",
"slTriggerBy": "UNKNOWN",
"basePrice": "0.00235",
"blockTradeId": "",
"leavesQty": "0"
}
],
"version": 17965
},
"type": "snapshot"
}