# 订单频道
### 描述
获取订单信息，首次订阅不推送。
以下事件发生时将推送数据：
1. 挂单
2. 订单成交
3. 撤单
4. 订单修改
```json title="请求示例"
{
"op": "subscribe",
"args": [
{
"instType": "SPOT",
"channel": "orders",
"instId": "BTCUSDT"
}
]
}
```
### 请求参数
| 参数名 | 参数类型 | 是否必须 | 描述 |
|:--------------|:-------------------|:-----|:---------------------------------------|
| op | String | 是 | 操作，subscribe unsubscribe |
| args | List<Object> | 是 | 请求订阅的频道列表 |
| > instType | String | 是 | 产品线类型, `SPOT` |
| > channel | String | 是 | 频道名, `orders` |
| > instId | String | 是 | 产品id 例如：`ETHUSDT`
`default`: 订阅所有币对 |
```json title="订阅返回示例"
{
"event": "subscribe",
"arg": {
"instType": "SPOT",
"channel": "orders",
"instId": "BTCUSDT"
}
}
```
### 返回参数
| 返回字段 | 参数类型 | 字段说明 |
|:--------------|:-------|:----------------------|
| event | String | 事件，subscribe unsubscribe error |
| arg | Object | 订阅的频道 |
| > instType | String | 产品类型 |
| > channel | String | 频道名 |
| > instId | String | 是
产品id 例如：ETHUSDT |
| code | String | 错误码，错误时才会返回 |
| msg | String | 错误消息 |
```json title="推送返回示例"
{
"action": "snapshot",
"arg": {
"instType": "SPOT",
"channel": "orders",
"instId": "BTCUSDT"
},
"data": [
{
"instId": "BTCUSDT",
"orderId": "1",
"clientOid": "1",
"size": "8.0000",
"newSize": "500.0000",
"notional": "8.000000",
"orderType": "market",
"force": "gtc",
"side": "buy",
"fillPrice": "26256.0",
"tradeId": "1",
"baseVolume": "0.0003",
"fillTime": "1695797773286",
"fillFee": "-0.00000018",
"fillFeeCoin": "BTC",
"tradeScope": "T",
"stpMode": "cancel_taker",
"accBaseVolume": "0.0003",
"priceAvg": "26256.0",
"status": "partially_filled",
"cTime": "1695797773257",
"uTime": "1695797773326",
"feeDetail": [
{
"feeCoin": "BTC",
"fee": "-0.00000018"
}
],
"enterPointSource": "WEB"
}
],
"ts": 1695797773370
}
```
### 推送数据参数
| 返回字段 | 参数类型 | 字段说明 |
|:------------------------------|:-------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| arg | Object | 订阅成功的频道 |
| > instType | String | 产品类型 |
| > channel | String | 频道名 |
| > instId | String | 是 |
| action | String | 推送数据动作, `snapshot` or `update` |
| data | List<Object> | 订阅的数据 |
| > instId | String | 产品id 例如：ETHUSDT |
| > orderId | String | 订单ID |
| > clientOid | String | 自定义订单id |
| > price | String | 委托价格 |
| > size | String | 委托数量
`side=buy` 时，该值为计价币数量
`side=sell` 时，该值为基础币数量 |
| > newSize | String | - 当`orderType=limit`时，`newSize`表示base coin数量;
当`orderType=market`且`side=buy`时，`newSize`表示quote coin数量；
当`orderType=market`且`side=sell`时，`newSize`表示base coin数量 |
| > notional | String | 买入金额，市价买入时返回 |
| > ordType | String | 订单类型，market：市价单 limit：限价单 |
| > force | String | 订单有效期，gtc普通限价单，一直有效直至取消；post_only 只做 maker 订单；fok全部成交或立即取消；ioc立即成交并取消剩余 |
| > side | String | 订单方向 |
| > fillPrice | String | 最新成交价格 |
| > tradeId | String | 最新成交ID |
| > baseVolume | String | 最新成交数量 |
| > fillTime | String | 最新成交时间 Unix毫秒时间戳，例如1690196141868 |
| > fillFee | String | 最新数量 |
| > fillFeeCoin | String | 最新成交币种 |
| > tradeScope | String | 最新一笔成交的流动性方向
`T`:taker;
`M`:maker; |
| > accBaseVolume | String | 累计已成交数量 |
| > priceAvg | String | 累计成交均价，如果成交数量为0，该字段也为0 |
| > status | String | 订单状态
`live`:新建订单;
`partially_filled`:部分成交;
`filled`:全部成交;
`cancelled`: 已撤销; |
| > enterPointSource | String | 订单来源
WEB WEB客户端
IOS IOS客户端
ANDROID Andriod客户端
API API客户端
SYS 系统, 通常为爆仓 |
| > feeDetail | List<Object> | 手续费list |
| >> feeCoin | String | 交易手续费币种 |
| >> fee | String | 订单交易手续费，平台向用户收取的交易手续费 （仅订单，不包括折扣） |
| > cTime | String | 订单创建时间，Unix时间戳的毫秒数格式，如 1630410492847 |
| > uTime | String | 订单更新时间，Unix时间戳的毫秒数格式，如 1597026383085 |
| > stpMode | String | STP模式
`none` 不设置STP
`cancel_taker` 取消taker单
`cancel_maker` 取消maker单
`cancel_both` 两者都取消 |