Skip to main content

Trigger Order Channel

Get the trigger order updates

Request Parameters

ParameterTypeRequiredDescription
opstringYesOperation, subscribe unsubscribe
argslistYesList of channels to request subscription
> instTypestringYesProduct type: USDT-FUTURES
> channelstringYesChannel name: orders-algo
> instIdstringNoProduct ID (optional)

Request Example

{
"op": "subscribe",
"args": [
{
"instType": "USDT-FUTURES",
"channel": "orders-algo",
"instId": "default"
}
]
}

Response Example

{
"event": "subscribe",
"arg": {
"instType": "USDT-FUTURES",
"channel": "orders-algo",
"instId": "default"
}
}

Push Parameters

ParameterTypeDescription
actionstringPush data action
argobjectChannels with successful subscription
> instTypestringProduct type
> channelstringChannel name
> instIdstringProduct ID
dataobjectTrigger order data
> symbolstringSymbol
> sizestringOrder size
> orderIdstringOrder ID
> clientOidstringClient order ID
> executePricestringExecute price
> statusstringOrder status
> sidestringOrder side
> posSidestringPosition side
> marginCoinstringMargin coin
> triggerPricestringTrigger price
> triggerPriceTypestringTrigger price type
> orderTypestringOrder type: TRIGGER
> leveragestringLeverage
> marginModestringMargin mode
> tradeSidestringTrade side: OPEN / CLOSE
> presetTakeProfitPricestringPreset take profit price
> presetTakeProfitExecutePricestringTP trigger price
> presetTakeProfitTypestringTP order type
> presetStopLossPricestringPreset stop loss price
> presetStopLossExecutePricestringSL trigger price
> presetStopLossTypestringSL order type
> cTimenumberCreate time
> uTimenumberUpdate time
tsnumberPush timestamp

Push Data

{
"action": "snapshot",
"arg": {
"instType": "USDT-FUTURES",
"channel": "orders-algo",
"instId": "default"
},
"data": {
"symbol": "BTCUSDT",
"size": "0.1",
"orderId": "123456790",
"clientOid": "my-trigger-001",
"executePrice": "27500.0",
"status": "WAIT",
"side": "LONG",
"posSide": "LONG",
"marginCoin": "USDT",
"triggerPrice": "27400.0",
"triggerPriceType": "MARK_PRICE",
"orderType": "TRIGGER",
"leverage": "10",
"marginMode": "ISOLATED",
"tradeSide": "OPEN",
"presetTakeProfitPrice": "",
"presetTakeProfitExecutePrice": "",
"presetTakeProfitType": "",
"presetStopLossPrice": "",
"presetStopLossExecutePrice": "",
"presetStopLossType": "",
"cTime": 1695716700000,
"uTime": 1695716700000
},
"ts": 1695716761589
}