Order
Subscribe to the order stream to see new orders, when an order's order status changes, etc.
Topic:
user.order.unifiedAccount
Response Parameters
Parameter | Type | Comments |
---|---|---|
id | string | Message id |
topic | string | Topic name |
type | string | Message type. snapshot |
ts | number | The timestamp (ms) that system generates the data. |
data | Object | |
> version | integer | Version |
> result | array | Object |
>> symbol | string | Symbol name |
>> side | string | Side. Buy ,Sell |
>> orderId | string | Order id |
>> orderLinkId | string | User customised order id |
>> orderType | string | Order type. Market ,Limit |
>> stopOrderType | string | Stop order type |
>> orderStatus | string | Order status |
>> price | string | Order price |
>> qty | string | Order qty |
>> timeInForce | string | Time in force |
>> cumExecQty | string | Cumulative executed order qty |
>> cumExecValue | string | Cumulative executed order value |
>> cumExecFee | string | Cumulative executed trading fee |
>> leavesQty | string | The remaining qty not executed |
>> triggerBy | string | The price type of trigger price |
>> triggerPrice | string | Trigger price. If stopOrderType =TrailingStop, it is activate price. Otherwise, it is trigger price |
>> reduceOnly | boolean | Reduce only. true means reduce position size |
>> closeOnTrigger | boolean | Close on trigger. What is a close on trigger order? |
>> iv | string | Implied volatility |
>> orderIM | string | Order initial margin. For portfolio margin mode, it returns "" |
>> takeProfit | string | Take profit price |
>> stopLoss | string | Stop loss price |
>> tpTriggerBy | string | The price type to trigger take profit |
>> slTriggerBy | string | The price type to trigger stop loss |
>> basePrice | string | Base price |
>> blockTradeId | string | Block trade ID |
>> createdTime | number | Order created timestamp (ms) |
>> updatedTime | number | Order 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"
}