关于API将新增财务流水查询接口“GET /v2/account/ledger”的公告
- API 公告
尊敬的用户:
自本通知生效之日起,火币Global将新增财务流水查询接口“GET /v2/account/ledger”。
GET /v2/account/ledger
API Key 权限:读取
母、子用户均可调用此接口
一期上线后暂时仅支持划转流水的查询(“transactType” = “transfer”)
通过“startTime”/“endTime”框定的查询窗口最大为10天,意即,通过单次查询可检索的范围最大为10天。
该查询窗口可在最近180天范围内平移,意即,通过多次平移窗口查询,最多可检索到过往180天的记录。
生效日期:2020年3月31日(GMT+8)
具体变更细节及参数要求,请参考API文档:https://huobiapi.github.io/docs/spot/v1/cn/
火币全球站
2020年3月31日
以下为变更明细:
请求参数
参数名称 | 数据类型 | 是否必需 | 描述 |
accountId | string | TRUE | 账户编号 |
currency | string | FALSE | 币种(缺省值所有币种) |
transactType | string | FALSE | 变动类型,可多填(缺省值all)枚举值:transfer |
startTime | long | FALSE | 远点时间(取值范围及缺省值见注1) |
endTime | long | FALSE | 近点时间(取值范围及缺省值见注2) |
sort | string | FALSE | 检索方向(asc由远及近,desc由近及远,缺省值desc) |
limit | int | FALSE | 单页最大返回条目数量[1,500](缺省值100) |
fromId | long | FALSE | 起始编号(仅在下页查询时有效,见注3) |
注1:
startTime取值范围:[(endTime - 10天), endTime]
startTime缺省值:(endTime - 10天)
注2:
endTime取值范围:[(当前时间 - 180天), 当前时间]
endTime缺省值:当前时间
返回数据
字段名称 | 字段名称 | 是否必需 | 描述 |
code | code | TRUE | 状态码 |
message | message | FALSE | 错误描述(如有) |
data | data | TRUE | 按用户请求参数sort中定义的顺序排列 |
{accountId | {accountId | TRUE | 账户编号 |
currency | currency | TRUE | 币种 |
transactAmt | transactAmt | TRUE | 变动金额(入账为正or出账为负) |
transactType | transactType | TRUE | 变动类型 |
transactId | transactId | TRUE | 交易流水号 |
transactTime | transactTime | TRUE | 交易时间 |
transferer | transferer | FALSE | 付款方账户ID(仅对转账之入账类型有效) |
transferee} | transferee} | FALSE | 收款方账户ID(仅对转账之出账类型有效) |
nextId | nextId | FALSE | 下页起始编号(仅在查询结果需要分页返回时,包含此字段 |
注3:
仅当用户请求查询的时间范围内的数据条目超出单页限制(由“limit“字段设定)时,服务器才返回”nextId“字段。用户收到服务器返回的”nextId“后 –
1)须知晓后续仍有数据未能在本页返回;
2)如需继续查询下页数据,应再次请求查询并将服务器返回的“nextId”作为“fromId“,其它请求参数不变。
3)“nextId”和”fromId“作为数据库记录ID,除了用来翻页查询外,无其它业务含义。
对用户的影响:
API用户需自行评估此新接口上线对用户自身业务的适配,并更新相关应用。
所有变更将自本通知生效之日起更新至 HTX API Docs。