關於HTX合約API接口升級的公告
- 重要公告
API接入:https://huobiglobal.zendesk.com/hc/zh-tw/articles/360000188382
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、IOC】
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
- 修改下單
- rest接口api/v1/contract_order和批量下單
- rest接口api/v1/contract_batchorder
- 請求參數order_price_type中增加訂單價格類型“ioc”;
- 請求參數order_price_type中增加訂單價格類型“fok”;
- 修改查詢用戶當前的下單量限制
- rest接口api/v1/contract_order_limit返回參數的“ order_price_type”,表示訂單報價類型,
- 增加"fok":FOK訂單,"ioc":IOC訂單
- 新增查詢系統狀態的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限頻
- 私有接口限頻由原來的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日上線