# 订单频道

### 描述

订阅订单频道

以下事件发生时推送数据：
1. 下开/平仓委托
2. 开/平仓委托成交
3. 撤单

<div className="api-aligning">

```json title="请求示例"
{
    "op": "subscribe",
    "args": [
        {
            "instType": "USDT-FUTURES",
            "channel": "orders",
            "instId": "default"
        }
    ]
}
```

### 请求参数

| 参数名 | 参数类型 | 是否必须 | 描述                                                                                | 
| :---- | :---- | :---- |:----------------------------------------------------------------------------------|
| op | String | 是 | 操作, subscribe unsubscribe                                                         |
| args | List&lt;Object&gt; | 是 | 请求订阅的频道列表                                                                         |
| &gt; channel | String | 是 | 频道名                                                                               |
| &gt; instType | String | 是 | 产品类型<br/>`USDT-FUTURES` U本位合约<br/>`COIN-FUTURES` 币本位合约<br/>`USDC-FUTURES` USDC合约  |
| &gt; instId | String | 否 | 交易对，如BTCUSDT<br/>`defalut`代表订阅所有交易对<br/>交割合约只支持`default`                          |

</div>

<div className="api-br-10"></div>

<div className="api-aligning">

```json title="订阅返回示例"
{
    "event": "subscribe",
    "arg": {
        "instType": "USDT-FUTURES",
        "channel": "orders",
        "instId": "default"
    }
}
```

### 返回参数

| 返回字段 | 参数类型 | 字段说明                                                                              | 
| :---- | :---- |:----------------------------------------------------------------------------------|
| event | String | 事件                                                                                |
| arg | Object | 订阅的频道                                                                             |
| &gt; channel | String | 频道名                                                                               |
| &gt; instType | String | 产品类型<br/>`USDT-FUTURES` U本位合约<br/>`COIN-FUTURES` 币本位合约<br/>`USDC-FUTURES` USDC合约  |
| &gt; instId | String | 产品id                                                                              |
| code | String | 错误码                                                                               |
| msg | String | 错误消息                                                                              |

</div>

<div className="api-br-10"></div>

<div className="api-aligning">

```json title="推送返回示例"
{
  "data": [
    {
      "leverage": "12",
      "orderType": "limit",
      "presetStopLossType": "fill_price",
      "tradeSide": "open",
      "orderId": "13333333333333333",
      "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
}
```

### 推送数据参数

| 返回字段                               | 参数类型               | 字段说明                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | 
|:-----------------------------------|:-------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| action                             | String             | 推送动作, `snapshot` or `update`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| arg                                | Object             | 订阅成功的频道                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| &gt; channel                       | String             | 频道名                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| &gt; instType                      | String             | 产品类型<br/>`USDT-FUTURES` U本位合约<br/>`COIN-FUTURES` 币本位合约<br/>`USDC-FUTURES` USDC合约                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| &gt; instId                        | String             | 产品ID                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| data                               | List&lt;Object&gt; | 订阅的数据                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| &gt; orderId                       | String             | 订单ID                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| &gt; clientOid                     | String             | 自定义订单id                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| &gt; price                         | String             | 委托价格                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| &gt; size                          | String             | 原始委托数量，以币为单位                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| &gt; posMode                       | String             | 持仓模式<br/>`one_way_mode`：单向持仓<br/>`hedge-mode`: 双向持仓                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |  持仓模式 |
| &gt; enterPointSource              | String             | 订单来源<br/>WEB    WEB客户端<br/>IOS    IOS客户端<br/>ANDROID    Andriod客户端<br/>API    API客户端<br/>SYS    系统, 通常为爆仓                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| &gt; tradeSide                     | String             | 交易方向<br/>`open` 开（开平仓模式）<br/>`close` 平（开平仓模式）<br/>`reduce_close_long` 双向持仓强制减多<br/>`reduce_close_short` 双向持仓强制减空<br/>`offset_close_long` 双向持仓轧差强制减多<br/>`offset_close_short` 双向持仓轧差强制减空<br/>`burst_close_long` 双向持仓爆仓平多<br/>`burst_close_short` 双向持仓爆仓平空<br/>`delivery_close_long` 双向持仓多头交割<br/>`delivery_close_short` 双向持仓空头交割<br/>`dte_sys_adl_close_long` 双向持仓ADL减多仓<br/>`dte_sys_adl_close_short` 双向持仓ADL减空仓<br/>`buy_single` 单向持仓买<br/>`sell_single` 单向持仓卖<br/>`reduce_buy_single` 单向持仓强制减仓买<br/>`reduce_sell_single` 单向持仓强制减仓卖<br/>`burst_buy_single` 单向持仓爆仓买<br/>`burst_sell_single` 单向持仓爆仓卖<br/>`delivery_sell_single` 单向持仓交割卖<br/>`delivery_buy_single` 单向持仓交割买<br/>`dte_sys_adl_buy_in_single_side_mode` 单向持仓ADL减仓买<br/>`dte_sys_adl_sell_in_single_side_mode` 单向持仓ADL减仓卖 |
| &gt; notionalUsd                   | String             | 委托单预估美元价值                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| &gt; orderType                     | String             | 订单类型<br/>limit 限价单，<br/>market 市价单                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| &gt; force                         | String             | 订单有效期                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| &gt; side                          | String             | 订单方向                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| &gt; posSide                       | String             | 持仓方向<br/>`long`: 双向持仓多头<br/>`short`: 双向持仓空头<br/>`net`: 单向持仓                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| &gt; marginMode                    | String             | 交易模式保证金模式<br/>`crossed`: 全仓<br/>`isolated`: 逐仓                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | 保证金模式  |
| &gt; marginCoin                    | String             | 保证金币种                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| &gt; fillPrice                     | String             | 最新成交价格                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| &gt; tradeId                       | String             | 最新成交ID                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| &gt; baseVolume                    | String             | 最新成交数量                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| &gt; fillTime                      | String             | 最新成交时间, Unix毫秒时间戳，例如1690196141868                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| &gt; fillFee                       | String             | 最新一笔成交的手续费, 负数                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| &gt; fillFeeCoin                   | String             | 最新一笔成交的手续费币种                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| &gt; tradeScope                    | String             | 最新一笔成交的流动性方向 `T`：taker `M`：maker                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| &gt; accBaseVolume                 | String             | 累计成交数量                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| &gt; fillNotionalUsd               | String             | 委托单已成交的美元价值                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| &gt; priceAvg                      | String             | 成交均价<br/>如果成交数量为0，该字段为0；若未成交，该字段也为0；取消订单不会推送此字段                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| &gt; status                        | String             | 订单状态<br/>live 新建订单，orderbook中等待撮合<br/>partially_filled 部分成交<br/>filled 全部成交<br/>canceled 已撤销                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| &gt; cancelReason                  | String             | 取消原因<br/>`normal_cancel` 普通取消<br/>`stp_cancel` 因STP规则取消                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| &gt; leverage                      | String             | 杠杆倍数                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| &gt; feeDetail                     | List&lt;Object&gt; | 订单手续费                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| &gt;&gt; feeCoin                   | String             | 交易手续费币种 收取的就是保证金                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| &gt;&gt; fee                       | String             | 订单交易手续费，平台向用户收取的交易手续费                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| &gt; pnl                           | String             | 收益                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| &gt; uTime                         | String             | 订单更新时间，Unix时间戳的毫秒数格式，如 1597026383085                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| &gt; cTime                         | String             | 订单创建时间，Unix时间戳的毫秒数格式，如 1597026383085                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| &gt; reduceOnly                    | String             | 是否只减仓<br/>`yes`: 是<br/>`no`: 否                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| &gt; presetStopSurplusPrice        | String             | 预设止盈价格                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| &gt; presetStopLossPrice           | String             | 预设止损价格                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| &gt; stpMode                       | String             | STP模式 <br/> `none` 不设置STP <br/> `cancel_taker` 取消taker单 <br/>  `cancel_maker` 取消maker单 <br/>  `cancel_both` 两者都取消                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| &gt; totalProfits                  | String             | 总盈亏                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| &gt; presetStopSurplusPrice        | String             | 预设止盈值                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| &gt; presetStopLossPrice           | String             | 预设止损值                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| &gt; presetStopSurplusExecutePrice | String             | 预设止盈执行价格                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| &gt; presetStopLossExecutePrice    | String             | 预设止损执行价格                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |

</div>
