关于API将在现有接口中支持交易手续费返佣的公告
- API 公告
尊敬的用户:
火币Global 将在现有API接口中支持交易手续费返佣 –
1) 现有REST节点GET /v2/reference/transact-fee-rate中的makerFeeRate & actualMakerRate字段可返回实际返佣费率(如有);
2) 现有REST节点GET /v1/order/orders/{order-id}/matchresults中的filled-fees字段可返回交易手续费返佣(如有);
3) 现有REST节点GET /v1/order/matchresults中的filled-fees字段可返回交易手续费返佣(如有);
4) 现有v2版本清算后成交明细订阅主题trade.clearing#${symbol}中的transactFee字段可推送交易手续费返佣(如有);
5) 现有REST节点GET /v1/account/history中的transact-type字段可返回返佣类型(如有);
6) 现有v1版本账户更新订阅主题accounts可推送批量返佣金额(如有);
7) 现有v2版本账户更新订阅主题accounts.update#${mode}可推送批量返佣金额(如有)。
注:
- 现有v1版本订单更新订阅主题orders.$symbol中的filled-fees字段将不推送返佣金额。如以maker成交并适用返佣,filled-fees将更新为零值;
- 现有REST查询接口GET /v1/order/orders/{order-id}中的field-fees字段将不支持返佣金额;
- 现有REST查询接口GET /v1/order/orders/getClientOrder中的field-fees字段将不支持返佣金额;
- 现有REST查询接口GET /v1/order/orders中的field-fees字段将不支持返佣金额;
- 现有REST查询接口GET /v1/order/history中的field-fees字段将不支持返佣金额。
生效日期:2020年6月1日(GMT+8)
具体变更细节及参数要求,请参考API文档:https://huobiapi.github.io/docs/spot/v1/cn/
火币全球站
2020年5月27日
自本通知生效之日起,火币Global 将在现有API接口中支持交易手续费返佣 –
1) 现有REST节点GET /v2/reference/transact-fee-rate中的makerFeeRate & actualMakerRate字段可返回实际返佣费率(如有)-
响应数据
字段名称 | 数据类型 | 描述 |
code | integer | 状态码 |
message | string | 错误描述(如有) |
data | object | |
{ symbol | string | 交易代码 |
makerFeeRate | string | 基础费率 - 被动方,如适用交易手续费返佣,返回返佣费率(负值) |
takerFeeRate | string | 基础费率 - 主动方 |
actualMakerRate | string | 抵扣后费率 - 被动方,如不适用抵扣或未启用抵扣,返回基础费率;如适用交易手续费返佣,返回返佣费率(负值) |
actualTakerRate } | string | 抵扣后费率 – 主动方,如不适用抵扣或未启用抵扣,返回基础费率 |
注:
- 如makerFeeRate/actualMakerRate为正值,该字段意为交易手续费率;
- 如makerFeeRate/actualMakerRate为负值,该字段意为返佣费率。
2) 现有REST节点GET /v1/order/orders/{order-id}/matchresults中的filled-fees字段可返回交易手续费返佣(如有)-
响应数据
字段名称 | 是否必须 | 数据类型 | 描述 | 取值范围 |
created-at | true | long | 成交时间戳timestamp | |
filled-amount | true | string | 成交数量 | |
filled-fees | true | string | 成交手续费,如果为空或为0,代表使用了其他币种进行了抵扣,可根据filled-points和fee-deduct-currency字段判断;如适用交易手续费返佣,返回为返佣金额(负值) | |
id | true | long | 订单成交记录ID | |
match-id | true | long | 撮合ID,订单在撮合中执行的顺序ID | |
order-id | true | long | 订单ID,成交所属订单的ID | |
trade-id | false | integer | Unique trade ID (NEW)唯一成交编号,成交时产生的唯一编号ID | |
price | true | string | 成交价格 | |
source | true | string | 订单来源 | api |
symbol | true | string | 交易对 | btcusdt, ethbtc, rcneth ... |
type | true | string | 订单类型 | buy-market:市价买, sell-market:市价卖, buy-limit:限价买, sell-limit:限价卖, buy-ioc:IOC买单, sell-ioc:IOC卖单, buy-limit-maker, sell-limit-maker, buy-stop-limit,sell-stop-limit, buy-limit-fok, sell-limit-fok, buy-stop-limit-fok, sell-stop-limit-fok |
role | true | string | 成交角色 | maker,taker |
filled-points | true | string | 抵扣数量(可为ht或hbpoint) | |
fee-deduct-currency | true | string | 抵扣类型 | 如果为空,代表扣除的手续费是原币;如果为"ht",代表抵扣手续费的是HT;如果为"hbpoint",代表抵扣手续费的是点卡 |
注:
- filled-fees中的返佣金额可能不会实时到账;
- maker买单的返佣基于计价币种,maker卖单的返佣基于基础币种。
3) 现有REST节点GET /v1/order/matchresults中的filled-fees字段可返回交易手续费返佣(如有)-
响应数据
参数名称 | 是否必须 | 数据类型 | 描述 | 取值范围 |
created-at | true | long | 成交时间戳timestamp | |
filled-amount | true | string | 成交数量 | |
filled-fees | true | string | 成交手续费;如适用交易手续费返佣,返回为返佣金额(负值) | |
id | true | long | 订单成交记录 ID | |
match-id | true | long | 撮合 ID | |
order-id | true | long | 订单 ID | |
trade-id | false | integer | Unique trade ID (NEW)唯一成交编号 | |
price | true | string | 成交价格 | |
source | true | string | 订单来源 | api |
symbol | true | string | 交易对 | btcusdt, ethbtc, rcneth ... |
type | true | string | 订单类型 | buy-market:市价买, sell-market:市价卖, buy-limit:限价买, sell-limit:限价卖, buy-ioc:IOC买单, sell-ioc:IOC卖单, buy-limit-maker, sell-limit-maker, buy-stop-limit,sell-stop-limit, buy-limit-fok, sell-limit-fok, buy-stop-limit-fok, sell-stop-limit-fok |
role | true | string | 成交角色 | maker,taker |
filled-points | true | string | 抵扣数量(可为ht或hbpoint) | |
fee-deduct-currency | true | string | 抵扣类型 | ht,hbpoint |
注:
- filled-fees中的返佣金额可能不会实时到账;
- maker买单的返佣基于计价币种,maker卖单的返佣基于基础币种。
4) 现有v2版本清算后成交明细订阅主题trade.clearing#${symbol}中的transactFee字段可返回交易手续费返佣(如有)-
数据更新字段列表
字段 | 数据类型 | 描述 |
symbol | string | 交易代码 |
orderId | long | 订单ID |
tradePrice | string | 成交价 |
tradeVolume | string | 成交量 |
orderSide | string | 订单方向,有效值: buy, sell |
orderType | 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,buy-limit-fok, sell-limit-fok, buy-stop-limit-fok, sell-stop-limit-fok |
aggressor | bool | 是否交易主动方,有效值: true, false |
tradeId | long | 交易ID |
tradeTime | long | 成交时间,unix time in millisecond |
transactFee | string | 交易手续费;如适用交易手续费返佣,返回为返佣金额(负值) |
feeDeduct | string | 交易手续费抵扣 |
feeDeductType | string | 交易手续费抵扣类型,有效值: ht,point |
注:
- transactFee中的返佣金额可能不会实时到账;
- maker买单的返佣基于计价币种,maker卖单的返佣基于基础币种。
5) 现有REST节点GET /v1/account/history中的transact-type字段可返回返佣类型(如有)-
响应数据
字段名称 | 数据类型 | 描述 | 取值范围 |
status | string | 状态码 | |
data | object | ||
{ account-id | long | 账户编号 | |
currency | string | 币种 | |
transact-amt | string | 变动金额(入账为正 or 出账为负) | |
transact-type | string | 变动类型,包括:trade (交易),etf(ETF申购), transact-fee(交易手续费), deduction(手续费抵扣), transfer(划转), credit(借币), liquidation(清仓), interest(币息), deposit(充币),withdraw(提币), withdraw-fee(提币手续费), exchange(兑换), other-types(其他), rebate(返佣) | |
avail-balance | string | 可用余额 | |
acct-balance | string | 账户余额 | |
transact-time | long | 交易时间(数据库记录时间) | |
record-id } | string | 数据库记录编号(全局唯一) |
注:
账户流水中返回的返佣金额为到账金额,多笔成交产生的多笔返佣可能会合并到帐,成为一笔流水。
6) 现有v1版本账户更新订阅主题accounts可推送批量返佣金额(如有)-
数据更新字段列表
字段 | 数据类型 | 描述 |
event | string | 资产变化通知相关事件说明,比如订单创建(order.place) 、订单成交(order.match)、订单成交退款(order.refund)、订单撤销(order.cancel) 、点卡抵扣交易手续费(order.fee-refund)、杠杆账户划转(margin.transfer)、借币本金(margin.loan)、借币计息(margin.interest)、归还借币本金币息(margin.repay)、其他资产变化(other) |
account-id | integer | 账户 id |
currency | string | 币种 |
type | string | 账户类型, 交易子账户(trade),借币子账户(loan),币息子账户(interest) |
balance | string | 账户余额 (当订阅model=0时,该余额为可用余额;当订阅model=1时,该余额为总余额) |
注:
账户更新推送的是到账金额,多笔成交产生的多笔返佣可能会合并到帐。
7) 现有v2版本账户更新订阅主题accounts.update#${mode}可推送批量返佣金额(如有)-
数据更新字段列表
字段 | 数据类型 | 描述 |
currency | string | 币种 |
accountId | long | 账户ID |
balance | string | 账户余额(仅当账户余额发生变动时推送) |
available | string | 可用余额(仅当可用余额发生变动时推送) |
changeType | string | 余额变动类型,有效值:order-place(订单创建),order-match(订单成交),order-refund(订单成交退款),order-cancel(订单撤销),order-fee-refund(点卡抵扣交易手续费),margin-transfer(杠杆账户划转),margin-loan(借币本金),margin-interest(借币计息),margin-repay(归还借币本金币息),other(其他资产变化) |
accountType | string | 账户类型,有效值:trade, frozen, loan, interest |
changeTime | long | 余额变动时间,unix time in millisecond |
注:
账户更新推送的是到账金额,多笔成交产生的多笔返佣可能会合并到帐。
对用户的影响:
API用户需自行评估此新接口上线对用户自身业务的适配,并更新相关应用。
所有变更将自本通知生效之日起更新至 HTX API Docs。