关于API将支持子用户充值的公告

尊敬的用户:

自本通知生效之日起,火币Global API将新增子用户充值功能,涉及接口改动如下:

-充币地址查询接口“GET /v2/account/deposit/address”,新增子用户可用;

-新增查询子用户充币地址接口“GET /v2/sub-user/deposit-address”,限母用户可用;

-充提记录查询接口“GET /v1/query/deposit-withdraw”, 新增子用户可用;

-新增查询子用户充值记录接口“GET /v2/sub-user/query-deposit”, 限母用户可用;

 

 

生效日期:2020年4月17日(GMT+8)

具体变更细节及参数要求,请参考API文档:https://huobiapi.github.io/docs/spot/v1/cn/

火币全球站
2020年4月17日

 

充币地址查询接口

GET /v2/account/deposit/address

新增支持子用户可用,接口字段无变化

 

查询子用户充币地址接口(母用户可用)

GET /v2/sub-user/deposit-address

API Key 权限:读取

此节点用于母用户查询子用户特定币种(IOTA除外)在其所在区块链中的充币地址,限母用户可用

 

请求参数

参数名称数据类型是否必需描述
 subUid longTRUE子用户UID,限填1个
currencystring TRUE币种

返回数据

字段名称数据类型是否必需描述
codeintegerTRUE状态码
messagestringFALSE错误描述(如有)
dataobjectTRUE 
{ currencystringTRUE币种
addressstring       TRUE地址
addressTagstring   FALSE地址标签
chain }      string TRUE   链名称

充提记录查询接口 

GET /v1/query/deposit-withdraw

新增支持子用户可用,接口字段无变化

 

查询子用户充值记录接口(母用户可用)

GET /v2/sub-user/query-deposit

API Key 权限:读取

此节点用于母用户查询子用户充值记录,限母用户可用

 

请求参数

参数名称数据类型是否必需描述
 subUidlongTRUE子用户UID,限填1个
currencystringFALSE币种 (缺省值所有币种)
startTimelongFALSE远点时间,以createTime进行检索(取值范围及缺省值见注1)                                   
endTimelongFALSE近点时间,以createTime进行检索(取值范围及缺省值见注2) 
sortstringFALSE检索方向(asc 由远及近, desc 由近及远,缺省值desc)
limitintFALSE单页最大返回条目数量 [1,500] (缺省值100)
fromIdlongFALSE起始编号(仅在下页查询时有效见注3))

注1:

startTime取值范围:[(endTime - 30天), endTime]

startTime缺省值:(endTime - 30天)

注2:

endTime取值范围:不限

endTime缺省值:当前时间

注3:

仅当用户请求查询的时间范围内的数据条目超出单页限制(由“limit“字段设定)时,服务器才返回”nextId“字段。用户收到服务器返回的”nextId“后 –

1) 须知晓后续仍有数据未能在本页返回;
2) 如需继续查询下页数据,应再次请求查询并将服务器返回的“nextId”作为“fromId“,其它请求参数不变。
3) “nextId”和”fromId“作为数据库记录ID,除了用来翻页查询外,无其它业务含义。

 

返回数据

字段名称数据类型是否必需描述
codeintegerTRUE状态码
messagestringFALSE错误描述(如有)
dataobjectTRUE按用户请求参数sort中定义的顺序排列
{ id      long    TRUE充币订单编号
currencystringTRUE币种
txHashstring TRUE交易哈希
chain  stringTRUE链名称
amountbigdecimalTRUE个数
addressstring       TRUE地址
addressTagstring   FALSE地址标签
state       string TRUE   状态,状态参加下表
createTime  long   TRUE   发起时间
updateTime }long         TRUE   最后更新时间
nextIdintegerFALSE下页起始编号(充值订单ID,仅在查询结果需要分页返回时,包含此字段)

 - 虚拟币充值状态定义:

状态描述
unknown状态未知
confirming确认中
confirmed已确认
safe已完成
orphan待确认

对用户的影响:

API用户需自行评估此新接口上线对用户自身业务的适配,并更新相关应用。

所有变更将自本通知生效之日起更新至 Huobi API Docs