【API 公告】关于API新增批量下单节点和API支持client-order-id批量撤单的公告
尊敬的用户,
自本通知生效之日起,火币Global将在现有REST API私有接口中新增批量下单节点,并在现有批量撤单节点中新增client-order-id请求参数。
新增批量下单节点:POST /v1/order/batch-orders
请求参数(填在Body中,最少批量下单数量为1;最大批量下单数量为10。)
字段名称 | 数据类型 | 是否必需 | 描述 |
[{ price | string | 非必需 | 订单价格(市价单无需此字段) |
amount | string | 必需 | 订单数量 |
type | string | 必需 | 订单类型,包括buy-market, sell-market, buy-limit, sell-limit, buy-ioc, sell-ioc, buy-limit-maker, sell-limit-maker, buy-stop-limit, sell-stop-limit |
client-order-id | string | 非必需 | 用户自编订单号(最长64位) |
stop-price | string | 非必需 | 触发价(仅对止盈止损订单有效) |
operator | string | 非必需 | 触发价运算符(仅对止盈止损订单有效,gte – greater than and equal (>=), lte – less than and equal (<=)) |
symbol | string | 必需 | 交易代码 |
account-id }] | string | 必需 | 账户编号 |
示例:
[
{
"account-id": "123456",
"price": "7801",
"amount": "0.001",
"symbol": "btcusdt",
"type": "sell-limit",
"client-order-id": "c1"
},
{
"account-id": "123456",
"price": "7802",
"amount": "0.001",
"symbol": "btcusdt",
"type": "sell-limit",
"client-order-id": "d2"
}
]
返回数据(返回的订单顺序与请求一致)
字段名称 | 数据类型 | 是否必需 | 描述 |
status | string | 必需 | 状态信息 |
err-code | string | 非必需 | 错误码 |
err-msg | string | 非必需 | 错误信息 |
data | object | 必需 | 按用户请求顺序排列 |
[{ order-id | long | 非必需 | 订单编号(如订单被拒此字段不传) |
client-order-id | string | 非必需 | 用户自编订单号(如用户创建订单时包含clientOrderID,返回中也须包含此字段) |
err-code | string | 非必需 | 订单被拒错误码(仅对被拒订单有效) |
err-msg }] | string | 非必需 | 订单被拒错误信息(仅对被拒订单有效) |
示例:
{
"status": "ok",
"data": [
{
"order-id": 61713400772,
"client-order-id": "c1"
},
{
"order-id": 61713400940,
"client-order-id": "d2"
}
]
}
现有批量撤单节点:POST /v1/order/orders/batchcancel
请求参数(填在Body中,最少批量撤单数量为1;最大批量撤单数量为50。)
字段名称 | 数据类型 | 是否必需 | 描述 |
order-ids | string[] | 非必需 | 订单编号列表(order-ids和client-order-ids必须且只能选一个填写,不超过50张订单) |
client-order-ids | string[] | 非必需 | 用户自编订单号列表(order-ids和client-order-ids必须且只能选一个填写,不超过50张订单) |
示例:
{
"client-order-ids": [
"5983466", "5722939", "5721027","5719487"
]
}
返回数据
字段名称 | 数据类型 | 是否必需 | 描述 |
status | string | 必需 | 状态信息 |
err-code | string | 非必需 | 错误码 |
err-msg | string | 非必需 | 错误信息 |
data | object | 必需 | |
{ success | string[] | 非必需 | 撤单成功订单列表(可为order-id列表或client-order-id列表,以用户请求为准) |
failed } | string[] | 非必需 | 撤单失败订单列表(可为order-id列表或client-order-id列表,以用户请求为准) |
撤单失败订单列表:
字段名称 | 数据类型 | 是否必需 | 描述 |
[{ order-id | long | 非必需 | 订单编号(如用户创建订单时包含order-id,返回中也须包含此字段) |
client-order-id | string | 非必需 | 用户自编订单号(如用户创建订单时包含client-order-id,返回中也须包含此字段) |
err-code | string | 非必需 | 订单被拒错误码(仅对被拒订单有效) |
err-msg | string | 非必需 | 订单被拒错误信息(仅对被拒订单有效) |
order-state }] | string | 非必需 | 当前订单状态(若有) |
示例:
{
"status": "ok",
"data": {
"success": [
"5983466"
],
"failed": [
{
"err-msg": "订单状态错误",
"order-id":"",
"client-order-id": "5722939",
"err-code": "order-orderstate-error"
},
{
"err-msg": "订单状态错误",
"order-id":"",
"client-order-id": "5721027",
"err-code": "order-orderstate-error"
},
{
"err-msg": "订单状态错误",
"order-id":"",
"client-order-id": "5719487",
"err-code": "order-orderstate-error"
}
]
}
}
生效日期:2019年12月27日(GMT+8)
具体变更细节及参数要求,请参考API文档:https://huobiapi.github.io/docs/spot/v1/cn/
火币全球站
2019年12月29日
微信掃描關注公眾號,及時掌握新動向