Order Channel

Description

Subscribe the order channel

Data will be pushed when the following events occured:

1. Open/Close orders are created
2. Open/Close orders are filled
3. Orders canceled

Request Example

{
    "op": "subscribe",
    "args": [
        {
            "instType": "USDT-FUTURES",
            "channel": "orders",
            "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
> instType	String	Yes	Product type USDT-FUTURES USDT-M Futures COIN-FUTURES Coin-M Futures USDC-FUTURES USDC-M Futures
> instId	String	No	Trading pair, e.g. BTCUSDT default: All trading pairs For settled Futures, it only supports default

Response Example

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

Response Parameters

Parameter	Type	Description
event	String	Event
arg	Object	Subscribed channels
> channel	String	Channel name: orders
> instType	String	Product type USDT-FUTURES USDT-M Futures COIN-FUTURES Coin-M Futures USDC-FUTURES USDC-M Futures
> instId	String	Product ID
code	String	Error code
msg	String	Error message

Push Data

{
  "data": [
    {
      "leverage": "12",
      "orderType": "limit",
      "presetStopLossType": "fill_price",
      "tradeSide": "open",
      "orderId": "13333333333333333333",
      "presetStopSurplusExecutePrice": "3200",
      "feeDetail": [
        {
          "feeCoin": "USDT",
          "fee": "0.00000000"
        }
      ],
      "cTime": "1760461517274",
      "posMode": "hedge_mode",
      "marginMode": "crossed",
      "presetStopLossExecutePrice": "2800",
      "posSide": "long",
      "price": "3000",
      "enterPointSource": "API",
      "cancelReason": "",
      "accBaseVolume": "0",
      "stpMode": "none",
      "side": "buy",
      "totalProfits": "0",
      "marginCoin": "USDT",
      "notionalUsd": "1200",
      "instId": "ETHUSDT",
      "presetStopSurplusPrice": "3200",
      "size": "0.4",
      "reduceOnly": "no",
      "presetStopLossPrice": "2800",
      "force": "gtc",
      "uTime": "1760461517274",
      "presetStopSurplusType": "fill_price",
      "clientOid": "12354678990111",
      "status": "live"
    }
  ],
  "arg": {
    "instType": "USDT-FUTURES",
    "instId": "default",
    "channel": "orders"
  },
  "action": "snapshot",
  "ts": 1760461517285
}

Push Parameters

Parameter	Type	Description
arg	Object	Channels with successful subscription
> channel	String	Channel name: orders
> instType	String	Product type USDT-FUTURES USDT-M Futures COIN-FUTURES Coin-M Futures USDC-FUTURES USDC-M Futures
> instId	String	Product ID delivery contract reference：https://www.bitget.com/api-doc/common/release-note
data	List<Object>	Subscription data
> orderId	String	Order ID
> clientOid	String	Customized order ID
> price	String	Order price
> size	String	Original order amount in coin
> posMode	String	Position Mode one_way_mode：one-way mode hedge-mode: hedge mode
> 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
> tradeSide	String	Direction close: Close (open and close mode) open: Open (open and close mode) reduce_close_long: Liquidate partial long positions for hedge position mode reduce_close_short：Liquidate partial short positions for hedge position mode burst_close_long：Liquidate long positions for hedge position mode burst_close_short：Liquidate short positions for hedge position mode offset_close_long：Liquidate partial long positions for netting for hedge position mode offset_close_short：Liquidate partial short positions for netting for hedge position mode delivery_close_long：Delivery long positions for hedge position mode delivery_close_short：Delivery short positions for hedge position mode dte_sys_adl_close_long：ADL close long position for hedge position mode dte_sys_adl_close_short：ADL close short position for hedge position mode buy_single：Buy, one way postion mode sell_single：Sell, one way postion mode reduce_buy_single：Liquidate partial positions, buy, one way position mode reduce_sell_single：Liquidate partial positions, sell, one way position mode burst_buy_single：Liquidate short positions, buy, one way postion mode burst_sell_single：Liquidate partial positions, sell, one way position mode delivery_sell_single：Delivery sell, one way position mode delivery_buy_single：Delivery buy, one way position mode dte_sys_adl_buy_in_single_side_mode：ADL close position, buy, one way position mode dte_sys_adl_sell_in_single_side_mode：ADL close position, sell, one way position mode
> notionalUsd	String	Estimated USD value of orders
> orderType	String	Order type limit: limit order market: market order
> force	String	Order validity period
> side	String	Order direction
> posSide	String	Position direction long: hedge-mode, long position short: hedge-mode, short position net: one-way-mode position
> marginMode	String	Margin mode crossed: crossed mode isolated: isolated mode
> marginCoin	String	Margin coin
> fillPrice	String	Latest filled price
> tradeId	String	Latest transaction ID
> baseVolume	String	Number of latest filled orders
> fillTime	String	Latest transaction time. Unix millisecond timestamp, e.g. 1690196141868
> fillFee	String	Transaction fee of the latest transaction, negative value
> fillFeeCoin	String	Currency of transaction fee of the latest transaction
> tradeScope	String	The liquidity direction of the latest transaction T: taker M maker
> accBaseVolume	String	Total filled quantity
> fillNotionalUsd	String	USD value of filled orders
> priceAvg	String	Average filled price If the filled size is 0, the field is 0; if the order is not filled, the field is also 0; This field will not be pushed if the order is cancelled
> status	String	Order status live: New order, waiting for a match in orderbook partially_filled: Partially filled filled: All filled canceled: the order is cancelled
> cancelReason	String	Cancel reason normal_cancel Normal cancel stp_cancel Cancelled by STP Detailed enumerations can be obtained on the Enumeration page.
> leverage	String	Leverage
> feeDetail	List<Object>	Transaction fee of the order
>> feeCoin	String	The currency of the transaction fee. The margin is charged.
>> fee	String	Order transaction fee, the transaction fee charged by the platform from the user.
> pnl	String	Profit
> uTime	String	Order update time, Milliseconds format of updated data timestamp Unix, e.g. 1597026383085
> cTime	String	Order creation time, milliseconds format of Unix timestamp, e.g.1597026383085
> reduceOnly	String	Reduce-only yes: Yes no: No
> presetStopSurplusPrice	String	Set TP price
> presetStopLossPrice	String	Set SL price
> 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
> totalProfits	String	Total profits
> presetStopSurplusPrice	String	Take-profit value
> presetStopLossPrice	String	Stop-loss value
> presetStopSurplusExecutePrice	String	Preset stop - profit execution price
> presetStopLossExecutePrice	String	Preset stop-loss execution price