订单

描述

当订单发生下单、订单撤单等事件时，推送消息。

推送频率

Real Time

订阅频道

orders

请求参数

参数	是否必填	类型	描述
event	是	String	事件类型：subscribe, unsubscribe
channel	是	String	orders
symbols	是	Array	交易对列表

请求响应

参数	类型	描述
event	String	事件类型：subscribe, unsubscribe
channel	String	orders
symbols	Array	交易对列表
message	String	错误消息

推送数据

参数	类型	描述
channel	String	orders
data	Array	The subscribed data
> symbol	String	交易对
> side	String	枚举值：BUY, SELL
> type	String	订单类型；枚举：MARKET, LIMIT, LIMIT_MAKER
> mgnMode	String	枚举：ISOLATED, CROSS, CASH
> timeInForce	String	枚举：FOK, IOC, GTC
> clOrdId	String	客户端订单id
> sz	String	委托数量或者委托张数
> px	String	仅当限价单的时候有效
> reduceOnly	Boolean	只适用于合约；只减仓标识
> posSide	String	只适用于合约；枚举：BOTH、LONG、SHORT；默认 BOTH 在双向持仓模式下；
> ordId	String	订单编号
> role	String	Enumerate: MAKER, TAKER
> state	String	订单状态；枚举： NEW PARTIAL_FILLED FILLED PARTIAL_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	订单来源
> avgPx	String	平均成交价格
> execQty	String	累计成交数量
> execAmt	String	累计成交金额
> feeCcy	String	手续费币种名称
> feeAmt	String	累计手续费数量
> deductCcy	String	手续费抵扣币种名称
> deductAmt	String	累计手续费抵扣数量
> cTime	Long	订单创建时间, UTC时间戳(毫秒)
> uTime	Long	订单更新时间, UTC时间戳(毫秒)
> ts	Long	推送的时间(毫秒)

请求示例

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

推送示例

{
    "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",
            "cTime": 1725330697421,
            "uTime": 1725330697421
        }
    ]
}