Orders

Description

When placing an order, canceling an order, or executing an order, the following information will be pushed.

Pushing Frequency

Real Time

Channel

orders

Request Parameters

Parameter	Required	Type	Description
event	Yes	String	Operation: subscribe, unsubscribe
channel	Yes	Array	orders
symbols	Yes	Array	trading pair array

Request Response

Parameter	Type	Description
event	String	Operation: subscribe, unsubscribe
channel	String	orders
symbols	Array	trading pair array
message	String	Error message

Push Data

Parameter	Type	Description
channel	String	orders
data	Array	The subscribed data
> symbol	String	A trading pair
> side	String	Enumerate: BUY, SELL
> type	String	Enumerate: MARKET, LIMIT, LIMIT_MAKER
> mgnMode	String	Enumerate: ISOLATED, CROSS
> timeInForce	String	Enumerate: FOK, IOC, GTC
> clOrdId	String	Client order ID
> sz	String	Amount or Conts of the order
> px	String	Price, applicable for limit orders only.
> reduceOnly	Boolean	Only applicable to futures; serves solely as a reduction indicator.
> posSide	String	Only applicable to futures. Enumerate BOTH, LONG, and SHORT; with BOTH by default under the hedge mode.
> ordId	String	Order ID
> state	String	Order status. Enumerate: NEW PARTIALLY_FILLED FILLED PARTIALLY_CANCELED CANCELED
> cancelReason	String	Enumerate: USER_CANCEL_ORDER_ACTION LIMIT_MAKER_ORDER_INCORRECT_PRICE_CONDITION LIMIT_MATCH_IOC_OR_FOK_ORDER_PRICE_CANNOT_MATCH LIMIT_MATCH_FOK_ORDER_MAKER_INSUFFICIENT_AVAILABLE_QUANTITY LIMIT_MATCH_IOC_ORDER_CANNOT_FILLED LIMIT_MATCH_ORDER_TAKER_SELF_TRADE MARKET_ORDER_NO_OTHER_SIDE_ORDER INVALID_PARAM_WHEN_PLACE_ORDER INVALID_ORDER_TYPE_WHEN_PLACE_ORDER INVALID_SEQUENCE_PLACE_ORDER_AFTER_CANCEL_SAME_ORDER MATCH_SYMBOL_TRADE_LIMIT_NOT_EXIST EXCEED_SLIPPAGE_TOLERANCE OUT_OF_RANGE_LIMIT_PRICE NO_MARGIN_QUANTITY_GREAT_THAN_POSITION LIMIT_MATCH_ORDER_ONLY_SELF_TRADE FL_CANCEL_ORDER_ACTION RISK_CANCEL_ORDER_ACTION SYS_CANCEL_ORDER_ACTION
> source	String	Order source
> avgPx	String	Average execution price
> execQty	String	Cumulative execution amount
> execAmt	String	Cumulative execution value
> feeCcy	String	Name of the currency used for trading fees
> feeAmt	String	Cumulative amount of trading fee
> deductCcy	String	Name of the currency used to deduct trading fees
> deductAmt	String	Cumulative amount of trading fee deducted
> fillSz	String	Amount or Conts of the last filled
> cTime	Long	Order creation time with a UTC timestamp (millisecond)
> uTime	Long	Order update time with a UTC timestamp (millisecond)
> ts	Long	Push time (millisecond)

Request Example

{
  "event": "subscribe",
  "channel": ["orders"],
  "symbols": ["BTC_USDT_PERP"]
}

Push Data Example

{
    "channel": "orders",
    "data": [
        {
            "symbol": "BTC_USDT_PERP",
            "side": "BUY",
            "type": "LIMIT",
            "mgnMode": "CROSS",
            "timeInForce": "GTC",
            "clOrdId": "polo353849510130364416",
            "sz": "1",
            "px": "64999",
            "reduceOnly": false,
            "posSide": "BOTH",
            "ordId": "353849510130364416",
            "state": "NEW",
            "source": "WEB",
            "avgPx": "0",
            "execQty": "0",
            "execAmt": "0",
            "feeCcy": "",
            "feeAmt": "0",
            "deductCcy": "",
            "deductAmt": "0",
            "fillSz": "2",
            "cTime": 1725330697421,
            "uTime": 1725330697421,
            "ts": 1725330697451
        }
    ]
}