【API 公告】关于API将上线V2版本Websocket订单更新推送接口“orders#${symbol}”的通知
尊敬的用户:
自2020年4月3日起,火币Global将上线V2版本Websocket订单更新推送接口“orders#$”。
生效日期:2020年4月3日(GMT+8)
具体变更细节及参数要求,请参考API文档:https://huobiapi.github.io/docs/spot/v1/cn/
火币全球站
2020年4月4日
## 订阅订单更新
API Key权限:读取
订单的更新推送由任一以下事件触发:
- 订单创建(eventType=creation);
- 订单成交(eventType=trade);
- 订单撤销(eventType=cancellation)。
但根据不同事件类型所推送的消息中,字段列表略有不同。
### 订阅主题
` orders#$`
### 订阅参数
参数 | 数据类型 | 描述 |
symbol | string | 交易代码(支持通配符 * ) |
> Subscribe request
```json
{
"action": "sub",
"ch": " orders#btcusdt"
}
```
> Response
```json
{
"action": "sub",
"code": 200,
"ch": " orders#btcusdt",
"data": {}
}
```
### 数据更新字段列表
当订单被创建后 –
字段 | 数据类型 | 描述 |
eventType | string | 事件类型,有效值:creation |
symbol | string | 交易代码 |
orderId | long | 订单ID |
clientOrderId | string | 用户自编订单号(如有) |
orderPrice | string | 订单价格 |
orderSize | string | 订单数量 |
type | string | 订单类型,有效值:buy-limit, sell-limit, buy-limit-maker, sell-limit-maker |
orderStatus | string | 订单状态,有效值:submitted |
orderCreateTime | long | 订单创建时间 |
注:止盈止损订单在尚未被触发时,接口将不会推送此订单的创建。仅当止盈止损订单被触发且未成交,接口才会被推送此订单的“creation”事件类型。并且,推送消息中的订单类型不再是原始订单类型“buy-stop-limit”或“sell-stop-limit”,而是变为“buy-limit”或“sell-limit”。
```json
{
"action":"push",
"ch":"orders#btcusdt",
"data":
{
"orderSize":"2.000000000000000000",
"orderCreateTime":1583853365586,
"orderPrice":"77.000000000000000000",
"type":"sell-limit",
"orderId":27163533,
"clientOrderId":"a001",
"orderStatus":"submitted",
"symbol":"btcusdt",
"eventType":"creation"
}
}
```
当订单成交后 –
字段 | 数据类型 | 描述 |
eventType | string | 事件类型,有效值:trade |
symbol | string | 交易代码 |
tradePrice | string | 成交价 |
tradeVolume | string | 成交量 |
orderId | long | 订单ID |
clientOrderId | string | 用户自编订单号(如有) |
tradeId | long | 成交ID |
tradeTime | long | 成交时间 |
aggressor | bool | 是否交易主动方,有效值: true, false |
orderStatus | string | 订单状态,有效值:partial-filled, filled |
execAmt | string | 已成交数量 |
remainAmt | string | 未成交数量 |
注:当一张taker订单同时与对手方多张订单成交后,所产生的每笔成交将被分别推送(而不是合并推送一笔)。
```json
{
"action":"push",
"ch":"orders#btcusdt",
"data":
{
"tradePrice":"76.000000000000000000",
"tradeVolume":"1.013157894736842100",
"tradeId":301,
"tradeTime":1583854188883,
"aggressor":true,
"execAmt":"1.013157894736842100",
"remainAmt":"0.000000000000000400000000000000000000",
"orderId":27163536,
"clientOrderId":"",
"orderStatus":"filled",
"symbol":"btcusdt",
"eventType":"trade"
}
}
```
当订单被撤销后 –
字段 | 数据类型 | 描述 |
eventType | string | 事件类型,有效值:cancellation |
symbol | string | 交易代码 |
orderId | long | 订单ID |
clientOrderId | string | 用户自编订单号(如有) |
orderStatus | string | 订单状态,有效值:partial-canceled, canceled |
remainAmt | string | 未成交数量 |
lastActTime | long | 订单最近更新时间 |
```json
{
"action":"push",
"ch":"orders#btcusdt",
"data":
{
"lastActTime":1583853475406,
"remainAmt":"2.000000000000000000",
"orderId":27163533,
"clientOrderId":"a001",
"orderStatus":"canceled",
"symbol":"btcusdt",
"eventType":"cancellation"
}
}
```
对用户的影响:
API用户需自行评估此新接口上线对用户自身业务的适配,以及即将下线接口的迁移,并更新相关应用。
所有变更将自本通知生效之日起更新至 Huobi API Docs。
微信扫描关注公众号,及时掌握新动向