Trigger Order Channel

Description

Subscribe trigger order channel

Request Example

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

Request Parameters

Parameter	Type	Required	Description
op	String	Yes	Operation, subscribe unsubscribe
args	List<Object>	Yes	List of channels to request subscription
> channel	String	Yes	Channel name: orders-algo
> instType	String	Yes	Product type SPOT
> instId	String	No	Trading pair or default

Response Example

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

Response Parameters

Parameter	Type	Description
event	String	Event
arg	Object	Subscribed channels
> channel	String	Channel name: orders-algo
> instType	String	Product type SPOT
> instId	String	Product ID/default
code	String	Error code
msg	String	Error 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

Parameter	Type	Description
action	String	Push action
arg	Object	Channels with successful subscription
> channel	String	Channel name: orders-algo
> instType	String	Product type SPOT
> instId	String	Product ID
data	List<Object>	Subscription data
> instId	String	Product ID
> orderId	String	Bot order ID
> clientOid	String	Customized bot order ID
> triggerPrice	String	Trigger price
> triggerType	String	Trigger type fill_price: filled price mark_price: mark price
> planType	String	Websocket planType, ws Trigger order type amount total
> price	String	Order price
> size	String	Original order amount in coin
> actualSize	String	Actual number of orders in coin
> orderType	String	Order type limit: limit order market
> side	String	Order direction,
> status	String	Order status
> executePrice	String	Execute price
> enterPointSource	String	Order 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
> cTime	String	Order create time, Milliseconds format of updated data timestamp Unix, e.g. 1597026383085
> uTime	String	Order update time, Milliseconds format of updated data timestamp Unix, e.g. 1597026383085
> stpMode	String	STP Mode none not setting STP cancel_taker cancel taker order cancel_maker cancel maker order cancel_both cancel both of taker and maker orders