Skip to main content

Trigger Order Channel

Description

Subscribe trigger order channel

Request Example
{
"op": "subscribe",
"args": [
{
"instType": "SPOT",
"channel": "orders-algo",
"instId": "default"
}
]
}

Request Parameters

ParameterTypeRequiredDescription
opStringYesOperation, subscribe unsubscribe
argsList<Object>YesList of channels to request subscription
> channelStringYesChannel name: orders-algo
> instTypeStringYesProduct type
SPOT
> instIdStringNoTrading pair or default
Response Example
{
"event": "subscribe",
"arg": {
"instType": "SPOT",
"channel": "orders-algo",
"instId": "default"
}
}

Response Parameters

ParameterTypeDescription
eventStringEvent
argObjectSubscribed channels
> channelStringChannel name: orders-algo
> instTypeStringProduct type
SPOT
> instIdStringProduct ID/default
codeStringError code
msgStringError message
Push Data
{
"action": "snapshot",
"arg": {
"instType": "USDT-FUTURES",
"channel": "orders-algo",
"instId": "default"
},
"data": [
{
"instId": "BTCUSDT",
"orderId": "1",
"clientOid": "1",
"triggerPrice": "27000.000000000",
"triggerType": "fill_price",
"planType": "amount",
"price": "27000.000000000",
"size": "0.020000000",
"actualSize": "0.000000000",
"orderType": "market",
"side": "buy",
"status": "live",
"executePrice": "0.1",
"enterPointSource": "web",
"cTime": "1695719197612",
"uTime": "1695719197612",
"stpMode": "cancel_taker"
}
],
"ts": 1695719197733
}

Push Parameters

ParameterTypeDescription
actionStringPush action
argObjectChannels with successful subscription
> channelStringChannel name: orders-algo
> instTypeStringProduct type
SPOT
> instIdStringProduct ID
dataList<Object>Subscription data
> instIdStringProduct ID
> orderIdStringBot order ID
> clientOidStringCustomized bot order ID
> triggerPriceStringTrigger price
> triggerTypeStringTrigger type
fill_price: filled price
mark_price: mark price
> planTypeStringWebsocket planType, ws Trigger order type
amount
total
> priceStringOrder price
> sizeStringOriginal order amount in coin
> actualSizeStringActual number of orders in coin
> orderTypeStringOrder type
limit: limit order
market
> sideStringOrder direction,
> statusStringOrder status
> executePriceStringExecute price
> enterPointSourceStringOrder source
WEB: Orders created on the website
API: Orders created on API
SYS: System managed orders, usually generated by forced liquidation logic
ANDROID: Orders created on the Android app
IOS: Orders created on the iOS app
> cTimeStringOrder create time, Milliseconds format of updated data timestamp Unix, e.g. 1597026383085
> uTimeStringOrder update time, Milliseconds format of updated data timestamp Unix, e.g. 1597026383085
> stpModeStringSTP Mode
none not setting STP
cancel_taker cancel taker order
cancel_maker cancel maker order
cancel_both cancel both of taker and maker orders

How was your Reading Experience with us?