币本位交割合约API版本历史记录
- API公告
API接入:https://huobiglobal.zendesk.com/hc/zh-cn/articles/360000188382
1.2.3 2021年1月29日 【新增:批量获取聚合行情接口。 2-14 修改接口,新增字段。修改:计划委托订单的订单ID由原本的自然数自增ID 改为长度为 18 位的唯一标识ID。推荐使用下单后返回的 order_id_str(字符串类型的订单 ID),避免发生长度过大而被系统截断的情况。】
1、新增批量获取聚合行情接口
- 接口名称:批量获取聚合行情
- 接口类型:公共接口
- 接口URL:/market/detail/batch_merged
2、修改全部撤单接口(请求参数新增 2 个选填字段:direction,表示买卖方向,不填默认撤销全部。参数可选值为“buy”:买,“sell”:卖。 offset,表示开平方向,不填默认撤销全部。参数可 选值为“open”:开仓,“close”:平仓。)
- 接口名称:全部撤单
- 接口类型:私有接口
- 接口URL:/api/v1/contract_cancelall
3、修改获取合约订单信息接口(返参data中新增real_profit字段,表示真实收益,类型decimal)
- 接口名称:获取合约订单信息
- 接口类型:私有接口
- 接口URL:/api/v1/contract_order_info
4、修改获取订单明细信息接口(返回参数中的 data 和 trades 下各新增以下字段:real_profit(真实收益)。同时 trades 下新增每笔成交收益字段:profit(平仓盈亏))
- 接口名称:获取订单明细信息
- 接口类型:私有接口
- 接口URL:/api/v1/contract_order_detail
5、修改获取合约当前未成交委托接口(请求参数新增选填 2 个字段:sort_by,表示排序字段,不填默认按创建时间倒序。参数可选值为“created_at”(按照创建时间倒序),“update_time”(按照更新时间倒 序)。trade_type,表示交易类型,不填默认查询全部。参数可选值为 0:全部,1:买入开多,2: 卖出开空,3: 买入平空,4: 卖出平多。返回参数中的 orders 下新增以下字段:update_time(订单更新时间,单位毫秒)、 real_profit(真实收益)。)
- 接口名称:获取合约当前未成交委托接口
- 接口类型:私有接口
- 接口URL:/api/v1/contract_openorders
6、修改获取合约历史委托接口(返参orders中新增real_profit字段,表示真实收益,类型decimal)
- 接口名称:获取合约历史委托
- 接口类型:私有接口
- 接口URL:/api/v1/contract_hisorders
7、修改组合查询合约历史委托接口(返参orders中新增real_profit字段,表示真实收益,类型decimal)
- 接口名称:组合查询合约历史委托
- 接口类型:私有接口
- 接口URL:/api/v1/contract_hisorders_exact
8、修改获取历史成交记录接口(返参trades中新增real_profit字段,表示真实收益,类型decimal)
- 接口名称:获取历史成交记录
- 接口类型:私有接口
- 接口URL:/api/v1/contract_matchresults
9、修改组合查询历史成交记录接口(返参trades中新增real_profit字段,表示真实收益,类型decimal)
- 接口名称:组合查询历史成交记录
- 接口类型:私有接口
- 接口URL:/api/v1/contract_matchresults_exact
10、修改订阅订单成交数据接口(返参外层新增real_profit字段,表示真实收益,类型decimal.返参trade中新增:real_profit字段,表示真实收益、profit字段,表示平仓盈亏。)
- 接口名称:订阅订单成交数据
- 接口类型:私有接口
- 订阅地址:orders.$symbol
11、修改计划委托全部撤单接口(请求参数新增 2 个选填字段:direction,表示买卖方向,不填默认撤销全部。参数可选值为“buy”:买,“sell”:卖。offset,表示开平方向,不填默认撤销全部。参数可 选值为“open”:开仓,“close”:平仓。)
- 接口名称:计划委托全部撤单
- 接口类型:私有接口
- 接口URL:/api/v1/contract_trigger_cancelall
12、修改止盈止损订单全部撤单接口(请求参数新增选填字段:direction,表示买卖方向,不填默认撤销全部。参数可选值为“buy”:买,“sell”:卖。)
- 接口名称:止盈止损订单全部撤单
- 接口类型:私有接口
- 接口URL:/api/v1/contract_tpsl_cancelall
13、修改查询计划委托当前委托接口(请求参数新增选填字段:trade_type,表示交易类型,不填默认查询全部。参数可选值为 0:全部,1:买入开多,2: 卖出开空,3: 买入平空,4: 卖出平多。)
- 接口名称:查询计划委托当前委托
- 接口类型:私有接口
- 接口URL:/api/v1/contract_trigger_openorders
14、修改查询止盈止损订单当前委托接口(请求参数新增选填字段:trade_type,表示交易类型,不填默认查询全部。参数可选值为 0:全部,3: 买入平空,4: 卖出平多。)
- 接口名称:查询止盈止损订单当前委托
- 接口类型:私有接口
- 接口URL:/api/v1/contract_tpsl_openorders
1.2.2 2021年01月12号 【1 新增获取预估结算价。2-7 新增止盈止损API接口,8-23 修改接口,新增字段。新增【合约策略订单】一级菜单,将本次新增的双向止盈止损相关接口以及原有的计划委托相关接口挪到该菜单下】
1、新增获取预估结算价
- 接口名称: 获取预估结算价
- 接口类型: 公共接口
- 接口URL: /api/v1/contract_estimated_settlement_price
2、新增对仓位设置止盈止损订单
- 接口名称: 对仓位设置止盈止损订单
- 接口类型: 私有接口
- 接口URL: /api/v1/contract_tpsl_order
3、新增止盈止损订单撤单接口
- 接口名称: 止盈止损订单撤单
- 接口类型: 私有接口
- 接口URL: /api/v1/contract_tpsl_cancel
4、新增止盈止损订单全部撤单接口
- 接口名称: 止盈止损订单全部撤单
- 接口类型: 私有接口
- 接口URL: /api/v1/contract_tpsl_cancelall
5、新增查询止盈止损订单当前委托接口
- 接口名称: 查询止盈止损订单当前委托
- 接口类型: 私有接口
- 接口URL: /api/v1/contract_tpsl_openorders
6、新增查询止盈止损订单历史委托接口
- 接口名称: 查询止盈止损订单历史委托
- 接口类型: 私有接口
- 接口URL: /api/v1/contract_tpsl_hisorders
7、新增查询开仓单关联的止盈止损订单详情接口
- 接口名称: 查询开仓单关联的止盈止损订单详情
- 接口类型: 私有接口
- 接口URL: /api/v1/contract_relation_tpsl_order
8、修改合约下单接口(新增选填入参:tp_trigger_price(止盈触发价格)、tp_order_price(止盈委托价格)、tp_order_price_type(止盈委托类型)、sl_trigger_price(止损触发价格)、sl_order_price(止损委托价格)、sl_order_price_type(止损委托类型)。)
- 接口名称: 合约下单
- 接口类型: 私有接口
- 接口URL: /api/v1/contract_order
9、修改合约批量下单接口(在入参orders_data中新增选填参数:tp_trigger_price(止盈触发价格)、tp_order_price(止盈委托价格)、tp_order_price_type(止盈委托类型)、sl_trigger_price(止损触发价格)、sl_order_price(止损委托价格)、sl_order_price_type(止损委托类型)。)
- 接口名称: 合约批量下单
- 接口类型: 私有接口
- 接口URL: /api/v1/contract_batchorder
10、修改获取合约订单信息接口(新增返回参数:is_tpsl(表示是否设置止盈止损,1:是;0:否),在返回参数order_source订单来源新增枚举值(tpsl:止盈止损触发))
- 接口名称: 获取合约订单信息
- 接口类型: 私有接口
- 接口URL: /api/v1/contract_order_info
11、修改获取订单明细信息接口(新增返回参数:is_tpsl(表示是否设置止盈止损,1:是;0:否),在返回参数order_source订单来源新增枚举值(tpsl:止盈止损触发))
- 接口名称: 获取订单明细信息
- 接口类型: 私有接口
- 接口URL: /api/v1/contract_order_detail
12、修改获取合约当前未成交委托接口(新增返回参数:is_tpsl(表示是否设置止盈止损,1:是;0:否),在返回参数order_source订单来源新增枚举值(tpsl:止盈止损触发))
- 接口名称: 获取合约当前未成交委托
- 接口类型: 私有接口
- 接口URL: /api/v1/contract_openorders
13、修改获取合约历史委托接口(新增入参:sort_by(表示:排序字段,可选值为“create_date”,“update_time”)。新增返回参数:is_tpsl(表示是否设置止盈止损,1:是;0:否),update_time(表示:订单的更新时间),在返回参数order_source订单来源新增枚举值(tpsl:止盈止损触发))
- 接口名称: 获取合约历史委托
- 接口类型: 私有接口
- 接口URL: /api/v1/contract_hisorders
14、修改组合查询合约历史委托接口(新增返回参数:is_tpsl(表示是否设置止盈止损,1:是;0:否),在返回参数order_source订单来源新增枚举值(tpsl:止盈止损触发))
- 接口名称: 组合查询合约历史委托
- 接口类型: 私有接口
- 接口URL: /api/v1/contract_hisorders_exact
15、修改订阅订单成交数据接口(新增返回参数:is_tpsl(表示是否设置止盈止损,1:是;0:否),在返回参数order_source订单来源新增枚举值(tpsl:止盈止损触发))
- 接口名称: 订阅订单成交数据
- 接口类型: 私有接口
- 订阅主题: orders.$symbol
16、修改订阅订单撮合数据接口(新增返回参数:is_tpsl(表示是否设置止盈止损,1:是;0:否),在返回参数order_source订单来源新增枚举值(tpsl:止盈止损触发))
- 接口名称: 订阅订单撮合数据
- 接口类型: 私有接口
- 订阅主题: matchOrders.$symbol
17、修改获取计划委托历史委托接口(新增入参:sort_by(表示:排序字段,可选值为“created_at”,“update_time”)。新增返回参数:update_time(表示:订单的更新时间))
- 接口名称: 获取计划委托历史委托
- 接口类型: 私有接口
- 接口URL: /api/v1/contract_trigger_hisorders
18、修改查询K线数据(支持查询已下市四周内的合约的K线数据(即到期日在过去最近四周的合约),可输入已下市四周内的合约的合约代码进行查询K线数据。)
- 接口名称: 查询K线数据
- 接口类型: 公共接口
- 接口URL: market/history/kline
19、修改请求K线数据(支持查询已下市四周内的合约的K线数据(即到期日在过去最近四周的合约),可输入已下市四周内的合约的合约代码进行查询K线数据。)
- 接口名称: 请求K线数据
- 接口类型: 公共接口
- 订阅主题: market.$symbol.kline.$period
20、修改获取当前可用合约总持仓量(在返回参数data中新增trade_volume:最近24小时成交量(张),trade_amount:最近24小时成交量(币),trade_turnover:最近24小时成交额。这三个字段 )
- 接口名称: 获取当前可用合约总持仓量
- 接口类型: 公共接口
- 接口URL: /api/v1/contract_open_interest
21、修改订阅Market Detail数据(在返参tick中新增ask表示卖一,bid表示买一。)
- 接口名称: 订阅Market Detail数据
- 接口类型: 公共接口
- 订阅主题: market.$symbol.detail
22、修改获取合约信息接口(新增返回参数:settlement_time(表示下次结算时间(毫秒时间戳)),delivery_time(表示交割时间(毫秒时间戳)))
- 接口名称: 获取合约信息
- 接口类型: 公共接口
- 接口URL: /api/v1/contract_contract_info
23、修改订阅合约信息变动(新增返回参数:settlement_time(表示下次结算时间(毫秒时间戳)),delivery_time(表示交割时间(毫秒时间戳)))
- 接口名称: 订阅合约信息变动
- 接口类型: 公共接口
- 订阅主题: public.$symbol.contract_info
1.2.1 2020年12月2日 【修改获取订单明细信息接口(查询无成交撤单数据时,如果不传“created_at”和“order_type”参数,由原来的只能查询到最近12小时数据,改为只能查询到最近2小时数据);修改获取合约历史委托接口(查询无成交撤单数据时,由原来的只保留最近24小时数据,改为只保留最近2小时数据。);修改组合查询合约历史委托接口(查询无成交撤单数据时,由原来的只保留最近24小时数据,改为只保留最近2小时数据。)】
1、修改获取订单明细信息接口(查询无成交撤单数据时,如果不传“created_at”和“order_type”参数,由原来的只能查询到最近12小时数据,改为只能查询到最近2小时数据)
- 接口名称:获取订单明细信息
- 接口类型:私有接口
- 接口URL:api/v1/contract_order_detail
2、修改获取合约历史委托接口(查询无成交撤单数据时,由原来的只保留最近24小时数据,改为只保留最近2小时数据。)
- 接口名称:获取合约历史委托
- 接口类型:私有接口
- 接口URL:api/v1/contract_hisorders
3、修改组合查询合约历史委托接口(查询无成交撤单数据时,由原来的只保留最近24小时数据,改为只保留最近2小时数据。)
- 接口名称:组合查询合约历史委托
- 接口类型:私有接口
- 接口URL:api/v1/contract_hisorders_exact
1.2.0 2020年11月24日 【新增:查询平台历史结算记录;修改:获取强平订单接口新增返参字段,订阅强平订单数据接口新增返参字段】
1、新增查询平台历史结算记录接口
- 接口名称:查询平台历史结算记录
- 接口类型:公共接口
- 接口URL:api/v1/contract_settlement_records
2、获取强平订单接口新增返参字段(返回参数中的 orders 参数下增加 amount 字段,表示强平数量(币))
- 接口名称:获取强平订单接口
- 接口类型:公共接口
- 接口URL:api/v1/contract_liquidation_orders
3、订阅强平订单数据接口新增返参字段(返回参数中的data参数下增加amount字段,表示强平数量(币))
- 接口名称:订阅强平订单数据
- 接口类型:公共接口
- 订阅主题:public.$symbol.liquidation_orders
1.1.9 2020年10月28日【新增:组合查询合约历史成交记录接口、组合查询合约历史委托接口、组合查询财务记录接口】
1、新增组合查询合约历史成交记录接口
- 接口名称:组合查询合约历史成交记录
- 接口类型:私有接口
- 接口地址:api/v1/contract_matchresults_exact
2、新增组合查询合约历史委托接口
- 接口名称:组合查询合约历史委托
- 接口类型:私有接口
- 接口地址:api/v1/contract_hisorders_exact
3、新增组合查询财务记录接口
- 接口名称:组合查询财务记录
- 接口类型:私有接口
- 接口地址:api/v1/contract_financial_record_exact
1.1.8 2020年10月15日 【新增:切换倍数接口;修改:切换倍数成功时 WS 资产接口推送更新信息,切换倍数成功时 WS 持仓接口推送更新信息,订单撮合推送接口新增返参字段,获取合约订单信息接口(将原支持查询 24 小时的撤单数据改为支持查询 4 小时撤单数据)】
1、新增切换倍数接口
- 接口名称:切换倍数
- 接口类型:私有接口
- 接口地址:api/v1/contract_switch_lever_rate
2、订阅资产接口推送更新(返参event新增事件类型,switch_lever_rate表示切换倍数。在用户切换倍数成功时,需推送一次最新的资产信息,event为switch_lever_rate。)
- 接口名称:订阅资产变动数据
- 接口类型:私有接口
- 订阅主题:$symbol
3、订阅持仓接口推送更新(返参event新增事件类型,switch_lever_rate表示切换倍数。在用户切换倍数成功时,需推送一次最新的持仓信息(若用户持仓量为0,则不会触发推送),event为switch_lever_rate。)
- 接口名称:订阅持仓变动数据
- 接口类型:私有接口
- 订阅主题:$symbol
4、订阅订单撮合推送接口更新(返回参数新增以下字段:direction(买卖方向)、offset (开平方向)、lever_rate(倍数)、price(委托价格)、created_at(创建时间)、order_source (订单来源)、order_price_type(订单报价类型)。)
- 接口名称:订阅订单撮合推送
- 接口类型:私有接口
- 订阅主题:$symbol
5、获取合约订单信息接口(将原支持查询 24 小时的撤单数据改为支持查询 4 小时撤单数据)
- 接口名称:获取合约订单信息
- 接口类型:私有接口
- 接口地址:api/v1/contract_order_info
1.1.7 2020年10月10日【新增:订阅系统状态更新推送的WebSocket接口】
1、新增订阅系统状态更新推送的 WebSocket 接口
- 接口名称:订阅系统状态更新
- 接口类型: 公共接口
- 订阅主题:public.$service.heartbeat
1.1.6 2020年9月22日 【新增:市场行情接口已支持按照合约code调用,包括rest和ws接口。请求参数的“symbol”字段中,新增合约code类型,格式固定为“品种”、“年”、“月”、“日”,比如:BTC200925;通过合约code调用暂时只支持查询当前上市中的合约。】
1、获取行情深度数据
- 接口名称:获取行情深度数据
- 接口类型: 公共接口
- 接口URL:/market/depth
2、获取K线数据
- 接口名称:获取K线数据
- 接口类型: 公共接口
- 接口URL:/market/history/kline
3、获取聚合行情
- 接口名称:获取聚合行情
- 接口类型: 公共接口
- 接口URL:/market/detail/merged
4、获取市场最近成交记录
- 接口名称:获取市场最近成交记录
- 接口类型: 公共接口
- 接口URL:/market/trade
5、批量获取最近的交易记录
- 接口名称:批量获取最近的交易记录
- 接口类型: 公共接口
- 接口URL:/market/history/trade
6、订阅 KLine 数据
- 接口名称:订阅 KLine 数据
- 接口类型: 公共接口
- 订阅主题:$symbol.kline.$period
7、请求 KLine 数据
- 接口名称:请求 KLine 数据
- 接口类型: 公共接口
- 订阅主题:$symbol.kline.$period
8、订阅 Market Depth 数据
- 接口名称:订阅 Market Depth 数据
- 接口类型: 公共接口
- 订阅主题:$symbol.depth.$type
9、订阅 Market Detail 数据
- 接口名称:订阅 Market Detail 数据
- 接口类型: 公共接口
- 订阅主题:$symbol.detail
10、订阅 Trade Detail 数据
- 接口名称:订阅 Trade Detail 数据
- 接口类型: 公共接口
- 订阅主题:$symbol.trade.detail
11、请求 Trade Detail 数据
- 接口名称:请求 Trade Detail 数据
- 接口类型: 公共接口
- 订阅主题:$symbol.trade.detail
12、订阅 Market Depth 增量数据
- 接口名称:订阅 Market Depth 增量数据
- 接口类型: 公共接口
- 订阅主题:$symbol.depth.size_${size}.high_freq
13、订阅买一卖一逐笔行情推送
- 接口名称:订阅买一卖一逐笔行情推送
- 接口类型: 公共接口
- 订阅主题:$symbol.bbo
1.1.5 2020年8月6日【新增:查询用户结算记录接口;订阅计划委托订单更新接口】
1、新增查询用户结算记录接口
- 接口名称:查询用户结算记录
- 接口类型:私有接口
- 接口地址:api/v1/contract_user_settlement_records
2、订阅计划委托订单更新
- 接口名称:订阅计划委托订单更新
- 接口类型:私有接口
- 订阅主题:trigger_order.$symbol
1.1.4 2020年6月19日【订阅订单撮合数据接口推送结果新增client_order_id字段】
1、订阅订单撮合数据接口推送结果新增client_order_id字段
- 接口名称:订阅订单撮合数据
- 接口类型: 私有接口
- 订阅主题:matchOrders.$symbol
1.1.3 2020年6月14日上线 【增加合约信息变动 WS 接口; 增加买一卖一逐笔行情 WS 接口; 订阅 Market Depth 接口新增 4 个深度类型可选值; 新增查询用户可用杠杆倍数; 资产变动与持仓变动 WS 接口新增定期推送; 下单接口支持高倍杠杆; 优化查询订单相关接口的返回参数; 私有推送接口新增 uid 返回参数;订单撮合推送接口新增字段;合约类型参数新增次季度合约】
1、增加合约信息变动ws推送接口
- 接口名称:增加合约信息变动ws推送接口
- 接口类型:公开接口
- 订阅主题:public.$symbol.contract_info
2、增加买一卖一逐笔行情 WS 接口
- 接口名称:订阅买一卖一逐笔行情推送
- 接口类型:公开接口
- 订阅主题:market.$symbol.bbo
3、订阅 Market Depth 接口新增 4 个深度类型可选值:step12、step13、step14、step15
- 接口名称:订阅 Market Depth 数据
- 接口类型:公开接口
- 订阅主题:market.$symbol.depth.$type
4、新增查询用户可用杠杆倍数
- 接口名称:查询用户可用杠杆倍数
- 接口类型:私有接口
- 接口地址:api/v1/contract_available_level_rate
5、资产变动WS 接口新增定期推送: 5秒一次定期推送
- 接口名称:订阅资产变动数据
- 接口类型:私有接口
- 订阅主题: accounts.$symbol
6、仓位变动WS 接口新增定期推送: 5秒一次定期推送
- 接口名称:订阅持仓变动数据
- 接口类型:私有接口
- 订阅主题:positions.$symbol
7、下单接口支持高倍杠杆
- 接口名称:合约下单
- 接口类型:私有接口
- 接口地址:api/v1/contract_order
- 接口名称:合约批量下单
- 接口类型:私有接口
- 接口地址:api/v1/contract_batchorder
- 接口名称:合约计划委托下单
- 接口类型:私有接口
- 接口地址:api/v1/contract_trigger_order
8、获取订单明细信息接口返回参数,增加9个字段:fee(总手续费)、order_id(订单id)、order_id_str(string格式的订单id)、client_order_id(客户订单id)、order_type(订单类型)、status(订单状态)、trade_avg_price(成交均价)、trade_turnover(成交总金额)、trade_volume(成交总数量)
- 接口名称:获取订单明细信息
- 接口类型:私有接口
- 接口地址:api/v1/contract_order_detail
9、获取订单信息接口返回参数,增加2个字段:liquidation_type(强平类型)、 canceled_at(撤单时间)
- 接口名称:获取订单信息接口
- 接口类型:私有接口
- 接口地址:api/v1/contract_order_info
10、订阅成交订单推送,增加2个字段:canceled_at(撤单时间)、fee_asset (手续费币种)
- 接口名称:订阅成交订单推送
- 接口类型:私有接口
- 订阅主题:orders.$symbol
11、私有推送接口新增 uid 返回参数
- 接口名称:订阅成交订单推送
- 接口类型:私有接口
- 订阅主题:orders.$symbol
- 接口名称:订阅资产变动推送
- 接口类型:私有接口
- 订阅主题:accounts.$symbol
- 接口名称:订阅持仓变动推送
- 接口类型:私有接口
- 订阅主题:positions.$symbol
- 接口名称:订阅订单撮合推送
- 接口类型:私有接口
- 订阅主题:matchOrders.$symbol
12、订单撮合推送新增接口新增字段,在返回参数的外层新增两个字段:trade_volume(订单已成交数量) 、volume(订单总委托数量)
- 接口名称:订阅订单撮合推送
- 接口类型:私有接口
- 订阅主题:matchOrders.$symbol
13、合约类型参数新增次季度合约,合约类型(contract_type)参数新增次季度合约可选值
- 接口名称:行情市场、资产以及交易(restful及websocket)接口
- 接口类型: 公开/私有
1.1.2 2020年4月9日 【增加:增加免鉴权的强平订单WS推送接口】
- 接口名称:WS订阅强平订单(免鉴权)
- 接口类型:公共接口
- 订阅主题:public.$symbol.liquidation_orders
1.1.1 2020年3月12日 【增加:增加WS订阅推送指数K线数据接口;增加WS订阅推送基差数据接口;增加获取指数K线数据restful接口;增加获取基差数据restful接口】
1、增加WS订阅推送指数K线数据
- 接口名称:WS指数K线推送
- 接口类型:公共接口
- 订阅主题:market.$symbol.index.$period
2、增加WS订阅推送基差数据
- 接口名称:WS指数基差推送
- 接口类型: 公共接口
- 订阅主题:market.$symbol.basis.$period.$basis_price_type
3、增加restful接口获取指数K线数据
- 接口名称: 获取指数K线数据
- 接口类型: 公共接口
- 接口URL:/index/market/history/index
4、增加restful接口获取基差数据
- 接口名称:获取基差数据
- 接口类型:公共接口
- 接口URL:/index/market/history/basis
1.1.0 【增加:增加母子账号划转;增加多个下单类型;WS增加撮合订单推送】
1、在Web端和API端新增合约母子账户资产划转功能,Web端只有母账户有划转权限,可以进行母转子或者子转母,但是不能进行子账户之间相互划转。API端划转只能通过母账户的API Key进行母子账户的互相划转。
1.1、增加母子账户划转的API接口,母账户与每个子账户相互划转限频10次/分钟。
接口名称:母子账户划转
接口类型:私有接口
接口URL:api/v1/contract_master_sub_transfer
1.2、查询系统状态的接口增加母子划转权限参数,在返回参数的数组"data"中,增加两个字段:"master_transfer_sub"、"sub_transfer_master"。
接口名称:查询系统状态
接口类型:公共接口
接口URL:api/v1/contract_api_state
1.3、增加查询母账户下的所有母子账户的划转记录的功能。
接口名称:获取母账户下的所有母子账户划转记录
接口类型:私有接口
接口URL:api/v1/contract_master_sub_transfer_record
1.4、返回财务记录的接口中,增加返回4种母子账户划转的流水
接口名称:查询用户财务记录
接口类型:私有接口
接口URL:api/v1/contract_financial_record
2、合约资产接口和合约交易接口中涉及到更改的如下:
2.1、获取下单量限制的接口增加10种订单价格类型,包括:opponent_ioc(对手价-IOC下单),lightning_ioc(闪电平仓-IOC下单),optimal_5_ioc(最优5档-IOC下单),optimal_10_ioc(最优10档-IOC下单),optimal_20_ioc(最优20档-IOC下单),opponent_fok(对手价-FOK下单),lightning_fok(闪电平仓-FOK下单),optimal_5_fok(最优5档-FOK下单),optimal_10_fok(最优10档-FOK下单),optimal_20_fok(最优20档-FOK下单)。
接口名称:查询用户当前的下单量限制
接口类型:私有接口
接口URL:POST api/v1/contract_order_limit
2.2、合约下单接口增加8种订单价格类型,分别为:opponent_ioc(对手价-IOC下单),optimal_5_ioc(最优5档-IOC下单),optimal_10_ioc(最优10档-IOC下单),optimal_20_ioc(最优20档-IOC下单),opponent_fok(对手价-FOK下单),optimal_5_fok(最优5档-FOK下单),optimal_10_fok(最优10档-FOK下单),optimal_20_fok(最优20档-FOK下单)。
接口名称:合约下单
接口类型:私有接口
接口URL:api/v1/contract_order
2.3、合约批量下单接口增加8种订单价格类型,分别为:opponent_ioc(对手价-IOC下单),optimal_5_ioc(最优5档-IOC下单),optimal_10_ioc(最优10档-IOC下单),optimal_20_ioc(最优20档-IOC下单),opponent_fok(对手价-FOK下单),optimal_5_fok(最优5档-FOK下单),optimal_10_fok(最优10档-FOK下单),optimal_20_fok(最优20档-FOK下单)。
接口名称:合约批量下单
接口类型:私有接口
接口URL:api/v1/contract_batchorder
2.4、获取订单明细信息增加字段liquidation_type
接口名称:获取订单明细信息
接口类型:私有接口
接口URL:POST api/v1/contract_order_detail
2.5、获取合约历史委托trade_type和orders修改,请求参数的trade_type中,增加类型:减仓平多,减仓平空;返回参数的orders数组增加字段"liquidation_type"。
接口名称:获取合约历史委托
接口类型:私有接口
接口URL:POST api/v1/contract_hisorders
2.6、闪电平仓下单接口请求参数增加字段order_price_type,值分别为:lightning_ioc(闪电平仓-IOC下单),lightning_fok(闪电平仓-FOK下单),lightning(闪电平仓-默认值)。
接口名称:闪电平仓下单
接口类型:私有接口
接口URL:api/v1/lightning_close_position
2.7、WS订单成交推送增加字段liquidation_type
接口名称:WS订单成交
接口类型:私有接口
订阅主题:orders.$symbol
2.8、增加WS撮合订单成交推送接口
接口名称:WS撮合订单成交推送
接口类型:私有接口
订阅主题:matchOrders.$symbol
2.9、查询系统是否可用接口,增加永续合约相关状态字段,在返回参数的数组"data"中,增加两个字段:"swap_heartbeat"、"swap_estimated_recovery_time"。
接口名称:查询系统是否可用
接口类型:公共接口
接口URL:https://www.hbdm.com/heartbeat
2.10、增加获取用户的API指标禁用信息的API接口
接口名称:获取用户的API指标禁用信息
接口类型:私有接口
接口URL:api/v1/contract_api_trading_status
1.0.11 【更新:批量20个订单改成批量最多10个订单】
1、接口名称:合约批量下单
接口URL:api/v1/contract_batchorder
接口类型:私有接口
优化点:批量下单的请求参数“orders_data”的一次最多允许批量撤销订单数由20个改为10个。
2、接口名称:撤销订单
接口URL:api/v1/contract_cancel
接口类型:私有接口
优化点:撤单接口的请求参数“order_id” 与 “client_order_id” 的一次最多允许撤消订单数由20个改为10个,多个订单ID中间以","分隔。
1.0.10【更新:更改K线等接口】
- 获取K线数据的接口中增加了两个请求参数“from”和“to”,“from”表示开始时间点(时间戳精确到秒),“to”表示结束时间点(时间戳精确到秒),最多可获取连续两年的数据。请求参数“size”改为非必填项
- /market/history/kline 获取K线数据
- 获取合约订单信息接口查询撤单信息,只能查询最近24小时内的撤单信息
- /api/v1/contract_order_info 获取合约订单信息
- 历史委托查询接口查询撤单信息,只能查询最近24小时内的撤单信息
- /api/v1/contract_hisorders 历史委托查询
- 获取订单明细接口查询撤单数据时,如果传“created_at”和“order_type”参数则能查询最近90天数据,如果不传“created_at”和“order_type”参数只能查询到最近24小时数据
- /api/v1/contract_order_detail 获取订单明细
1.0.9【更新:新增计划委托接口】
- 新增查询资金持仓接口
- rest接口api/v1/contract_account_position_info,用于获取到当前的资产和持仓信息
- 新增计划委托接口
- api/v1/contract_trigger_order合约计划委托下单接口
- api/v1/contract_ trigger_cancel合约计划委托撤单接口
- api/v1/contract_trigger_cancelall合约计划委托全部撤单接口
- api/v1/contract_trigger_openorders获取计划委托当前委托接口
- api/v1/contract_trigger_hisorders获取计划委托历史委托接口
- 部分接口增加返回“手续费币种”字段
部分API和内部接口增加返回字段表示手续费对应的币种:
- api/v1/contract_fee查询用户当前的手续费费率
- api/v1/contract_order_info获取合约订单信息
- api/v1/contract_order_detail获取订单明细
- api/v1/contract_openorders获取合约当前未成交委托
- api/v1/contract_hisorders获取合约历史委托
- api/v1/contract_matchresults获取历史成交记录
- WS成交推送,增加返回“手续费币种”字段
- 部分接口请求参数的天数改为可随意输入
部分接口的请求参数“create_date”,由只能填写7或90 改为 可随意输入正整数,如果参数超过90则 默认查询90天的数据:
- api/v1/contract_hisorders获取限价单历史委托的接口
- api/v1/contract_trigger_hisorders获取计划委托的历史委托接口
- api/v1/contract_matchresults获取成交记录的接口
- api/v1/contract_financial_record获取财务记录的接口
1.0.8【更新:增加order_id_str字段】
- 为了解决nodejs和Javascript的用户order_id返回是18位数字长度过长的问题,接口返回增加order_id_str字段,类型为字符串,来表示订单号
涉及接口:
- api/v1/contract_order
- api/v1/contract_batchorder
- api/v1/contract_matchresults
- api/v1/contract_hisorders
- api/v1/contract_openorders
- api/v1/lightning_close_position
- api/v1/contract_order_info
- 订单推送ws 增加 order_id_str
1.0.7【更新:新增FOK】
nodejs和Javascript的用户请特别注意:order_id返回是18位,nodejs和javascript默认解析18位有问题,nodejs和javascript里面JSON.parse默认是int,大于等于18位的数字用json-bigint的包解析。具体参考nodejs的demo,点击查看。 详细说明,请点击查看。
- 修改获取订单明细信息
- rest接口api/v1/contract_order_detail请求参数“ created_at”改为选填
- 修改接口获取用户账户信息
- rest接口api/v1/contract_account_info增加返回字段‘ margin_static’,表示用户的静态权益
- 修改获取订单明细信息
- rest接口api/v1/contract_order_detail、查询用户的成交记录
- rest接口api/v1/contract_matchresults、用户订单的成交推送的ws增加字段id,表示成交唯一ID。具体使用方式是用match_id和id作为联合主键,拼接成unique的成交ID。
- 修改下单
- rest接口api/v1/contract_order和批量下单
- rest接口api/v1/contract_batchorder
- 请求参数order_price_type中增加订单价格类型“fok”;
- 修改查询用户当前的下单量限制
- rest接口api/v1/contract_order_limit返回参数的“ order_price_type”,表示订单报价类型,
- 增加"fok":FOK订单
- 新增查询系统状态的API
- rest接口api/v1/contract_api_state
- 新增账户多空持仓对比-账户数
- rest接口api/v1/contract_elite_account_ratio
- 新增精英账户多空持仓对比-持仓量
- rest接口api/v1/contract_elite_position_ratio
- 新增获取强平订单
- rest接口api/v1/contract_liquidation_orders和ws推送
1.0.6【更新:新增rest接口】
1.新增rest接口:
- 请求访问地址:https://www.hbdm.com/heartbeat
- 备注:查询系统是否可用,其中heartbeat为1是可用,为0不可用。
1.0.5【更新:查询及下单功能】
- 新增接口:
- 新增rest接口,查询用户的下单量限制;
- 新增rest接口,查询用户的手续费费率;
- 新增rest接口,查询用户的划转限制;
- 新增rest接口,查询用户的持仓量限制;
- 新增rest接口,查询平台的风险准备金、预估分摊比例;
- 新增rest接口,查询平台持仓量;
- 新增rest接口,查询平台的风险准备金历史数据;
- 新增rest接口,查询平台的阶梯调整系数;
- 新增rest接口,闪电平仓下单;
- 对已有接口的修改:
- rest接口,查询用户账户信息接口增加返回用户的调整系数;
- rest接口,查询单个子账户资产信息接口增加返回用户的调整系数;
- ws接口,资金推送增加返回用户的调整系数;
- rest接口,下单接口和批量下单接口新增最优5、10、20档下单;
- rest接口,获取成交记录增加按照合约code查询;
1.0.4【更新: Restful查询接口】
1.查询母账户下所有子账户资产信息
- URL:api/v1/contract_sub_account_list
- 备注:只返回已经开通合约交易的子账户数据
2.查询单个子账户资产信息
- URL:api/v1/contract_sub_account_info
- 备注:只能查询到开通合约交易的子账户信息;子账户来过合约系统但是未开通合约交易也不返回对应的数据
3.查询单个子账户持仓信息的
- URL:api/v1/contract_sub_position_info
4.查询用户财务记录
- URL:api/v1/contract_financial_record
1.0.3【更新:WS增加资产信息推送】
- WS增加资产信息推送
- WS增加持仓信息推送
- rest接口获取用户的持仓信息接口api/v1/contract_position_info增加返回字段“最新价”
1.0.2【更新: 币币账户和合约账户间进行资金的划转】
- 账户接口/v1/futures/transfer
- 币币账户和合约账户间进行资金的划转
- 从现货现货账户转至合约账户,类型为pro-to-futures; 从合约账户转至现货账户,类型为futures-to-pro
- 该接口的访问频次的限制为1分钟10次
- API限频
- 限频时间间隔从1秒变为3秒
- 私有接口限频由原来的10次/s变更为30次/3s,即请求发送3秒内不超过30次
- 其他非行情类的公开接口限频由原来的20次/s变更为60次/3s,即请求发送3秒内不超过60次
1.0.1【更新:post_only高级限价委托功能上线】
- 全部撤单接口/v1/contract_cancelall
- 只传symbol,撤该该品种下所有周期的合约
- 只要有contract_code,则撤销该code的合约
- 只传symbol+contract_type, 则撤销二者拼接所成的合约订单
- 下单接口/v1/ contract_order
- 报单字段order_price_type中增加订单价格类型post_only,post_only是“只做Maker(post_only)”,不会立刻在市场成交,保证用户始终为Maker;如果委托会立即与已有委托成交,那么该委托会被取消。
- Post only只受用户持仓数量限制,单笔下单不受下单数量限制。
- 批量下单接口/v1/ contract_batchorder
- 报单字段order_price_type中增加订单价格类型post_only,post_only是“只做Maker(post_only)”,不会立刻在市场成交,保证用户始终为Maker;如果委托会立即与已有委托成交,那么该委托会被取消。
- Post only只受用户持仓数量限制,单笔下单不受下单数量限制。
- 所有API接口返回数据中增加限频信息
- 将在api接口response中的header返回以下字段
- ratelimit-limit: 单轮请求数上限,单位:次数
- ratelimit-interval:请求数重置的时间间隔,单位:毫秒
- ratelimit-remaining:本轮剩余可用请求数,单位:次数
- ratelimit-reset:请求数上限重置时间,单位:毫秒
- 查询订单详细信息/v1/contract_order_detail
- trades增加成交角色字段role:taker或maker
- 获取成交记录/v1/contract_matchresults
- trades增加成交角色字段role:taker或maker
- 获取该用户在某品种上的最新成交记录,可以按照交易类型进行过滤筛选。注意,该接口是需要API KEY验签的私有接口,只能查询属于该用户自己的最新成交记录。
- WS成交推送接口
- trades增加成交角色字段role:taker或maker
- WebSocket私有订单成交推送接口(需要API KEY验签)
- 一个UID最多同时建立10个私有订单成交推送WS链接。该用户在一个品种(包含该品种的所有周期的合约)上,仅需要维持一个订单推送WS链接即可。
- 注意: 订单推送WS的限频,跟用户RESTFUL私有接口的限频是分开的,相互不影响。
1.0.0 于2018年12月10日上线