更新日志

生效时间（北京时间 UTC+8)	接口	新增 / 修改	摘要
2019.11.08 19:45	"GET /v1/order/orders/{order-id}/matchresult" & "GET /v1/order/matchresults"	新增	新增返回字段trade-id
2019.10.18 19:00	GET /v1/account/history	新增	新增账户流水查询节点
2019.10.12 11:00	POST /v1/dw/withdraw/api/create	优化	设置ERC20为USDT的默认链
2019.10.11 10:00	支持全仓杠杆资金划转、借贷、还贷、查询借贷订单、查询账户余额等相关节点	新增	新增全仓杠杆相关节点
2019.10.09 20:00	“GET /market/trade”，“GET /market/history/trade”，“market.$symbol.trade.detail”	优化	新增返回字段trade id
2019.09.25 20:00	GET /v2/account/withdraw/quota	新增	新增提币额度查询节点
2019.09.23 15:00	POST /v1/order/orders/{order-id}/submitcancel & POST /v1/order/orders/batchcancel	优化	优化错误码返回
2019.09.20 10:00	GET /v2/reference/currencies	新增	新增币链参考信息节点
2019.09.19 16:00	websocket订阅主题“/market/trade.$symbol.bbo”	新增	新增买一卖一逐笔推送
2019.09.18 20:00	GET /v1/subuser/aggregate-balance, GET /v1/account/accounts/{sub-uid}, GET /v1/margin/loan-orders, GET /v1/margin/accounts/balance	新增	支持子用户逐仓杠杆交易
2019.09.16 15:00	GET /v2/account/deposit/address	新增	新增APIv2节点 - 充币地址查询
2019.09.11 17:00	GET v1/stable-coin/quote，POST v1/stable-coin/exchange	新增	新增稳定币兑换节点
2019.09.11 16:00	删除部分代码示例	删除	删除部分代码示例
2019.09.10 10:00	除节点"POST /v1/order/orders/submitCancelClientOrder" & "GET /v1/order/openOrders"以外，去除了其它节点中订单状态取值submitting以及cancelling	修改	除节点"POST /v1/order/orders/submitCancelClientOrder" & "GET /v1/order/openOrders"以外，去除了其它节点中订单状态取值submitting以及cancelling
2019.09.09 11:00	POST /v1/order/orders/submitCancelClientOrder	修改	修改返回数据描述
2019.09.09 10:00	GET /v1/order/orders; GET /v1/order/matchresults	修改	修改请求字段start-date与end-date的默认值及取值范围的描述
2019.09.02 18:00	POST /v1/order/orders/batchCancelOpenOrders	优化	更改请求字段"symbol"的描述
2019.09.02 16:00	删除稳定币兑换相关节点。
2019.08.29 21:00	下单、查询、订阅接口	新增	支持止盈止损订单类型。
2019.08.21 18:00	"GET /v1/order/openOrders"	优化	修改请求字段列表。
2019.08.05 18:00	"orders.$symbol.update"	新增	新增字段"client-order-id"和"order-type"。
2019.08.02 18:00	"orders.$symbol.update"	优化	修改对字段"unfilled-amount"的描述。
2019.07.23 21:00	"GET /v1/order/orders/{order-id}/matchresult" & "GET /v1/order/matchresults"	新增	新增手续费抵扣详情字段。
2019.07.23 20:00	GET /v1/fee/fee-rate/get	新增	新增费率查询接口。
2019.07.22 12:00	GET /v1/order/orders/{order-id}/matchresults; GET /v1/order/matchresults	新增	新增成交角色"role"字段以标识每笔成交角色是"taker"还是"maker"。
2019.07.11 20:00	POST /v1/order/orders/place; POST /v1/order/orders/submitCancelClientOrder; GET /v1/order/orders/getClientOrder	优化/新增	下单/撤单/查询可基于client order ID。
2019.07.08 12:00	Websocket 订单资产推送接口	优化	优化Websocket 订单资产推送接口心跳和限频。
2019.06.14 16:00	POST /v1/dw/withdraw/api/create	优化	支持快速提币
2019.06.17 16:00	GET /v1/stable_coin/exchange_rate; POST /v1/stable_coin/exchange	新增	新增接口支持用户随时获取最新的稳定币兑换汇率信息，并对稳定币执行兑入或兑出。
2019.06.12 16:00	GET /v1/common/symbols	优化	对交易对基础信息接口返回的内容进行优化，该优化向后兼容
2019.06.06 18:00	GET /v1/query/deposit-withdraw	优化	对充提记录查询接口的请求参数进行优化，该优化向后兼容
2019.06.05 20:00	所有需要验签的接口	优化	访问验签接口时，API Key需要有适当的权限，现有的API Key都默认有全部权限。权限分为3类：读取，交易和提币。每个接口相应的权限类别均已更新在各接口说明中
2019.06.10 00:00	- GET /v1/order/orders;- GET /v1/order/matchresults	修改	查询窗口调整为48小时，可查询整体时间范围不变
2019.05.15 10:00	- POST /v1/futures/transfer	新增	提供币币与合约账户间的资金划转
2019.04.29 19:00	- GET /v1/order/history	新增	新增最近48小时内历史订单查询节点。新节点的上线后，现有订单查询节点“GET /v1/order/orders”仍将被保留。然而，新节点“GET /v1/order/history”被赋予更高服务等级。极端情况下，当服务荷载超过系统既定阈值时，节点“GET /v1/order/orders”的服务可能会不可用，而新节点“GET /v1/order/history”仍将继续提供服务。另外，火币正在计划支持另一个新节点专门用于用户48小时外的历史订单查询。此新节点上线的同时，现有节点“GET /v1/order/orders”将被弃用。火币将及时告知用户这一变更，一旦变更时间确定。
2019.04.17 10:00	- GET /v1/order/orders	修改	文档优化，增加Start-date限制说明
2019.04.16 10:00	- GET /v1/order/openOrders	修改	文档错误，参数account-id和symbol都是必填参数
2019.01.17 07:00	- Websocket accounts	修改	- 增加订阅参数 model； - 订阅返回的内容中不再推送交易子账户冻结余额的变化。
2018.07.10 11:00	- GET `/market/history/kline`	修改	- `size` 取值范围由 [1-1000] 修改为 [1-2000]。
2018.07.06 16:00	- POST `/v1/order/orders/place`	修改	- 添加 `buy-limit-maker`，`sell-limit-maker` 两种下单类型支持； - 新增获取某个帐号下指定交易对或者所有交易对的所有尚未成交订单接口: `/v1/order/openOrders`。
2018.07.06 16:00	- GET `/v1/order/openOrders` - POST `/v1/order/orders/batchCancelOpenOrders`	新增	- 新增获取某个帐号下指定交易对或者所有交易对的所有尚未成交订单接口； - 新增批量取消某个帐号下指定的订单列表中所有订单接口。
2018.07.02 16:00	- ETF 相关接口	新增	- 本次接口变更主要是支持 HB10 ETF 的换入和换出。
2018.06.20 16:00	- GET `/market/tickers`	新增	- 新增 Tickers 接口，Tickers 为当前所有交易对行情数据。

简介

API 简介

欢迎使用火币 API！你可以使用此 API 获得火币平台的行情数据，进行交易，及管理你的账户。

在文档的右侧是代码，目前我们仅提供针对 shell 的代码示例。

你可以通过点击上方菜单来切换不同业务的API，还可通过点击右上方的语言按钮来切换文档语言。

做市商项目

做市商项目不支持点卡抵扣、VIP、交易量相关活动以及任何形式的返佣活动。

欢迎有优秀 maker 策略且交易量大的用户参与长期做市商项目。如果您的火币现货账户或者合约账户中有折合大于20BTC资产（币币和合约账户分开统计），请提供以下信息发送邮件至：

MM_service@huobi.com Huobi Global（现货 / 杠杆）做市商申请；
dm_mm@huobi.com HBDM（合约）做市商申请。

提供 UID （需不存在返佣关系的 UID）；
提供其他交易平台 maker 交易量截图证明（比如30天内成交量，或者 VIP 等级等）；
请简要阐述做市方法，不需要细节。

初次必看

接入准备

如需使用API ，请先登录网页端，完成API key的申请和权限配置，再据此文档详情进行开发和交易。

API key创建成功后，请您务必记住以下信息：

Access Key API 访问密钥
Secret Key 签名认证加密所使用的密钥（仅申请时可见）

您可以点击这里创建 API Key。

为保证API服务的稳定性，建议使用日本AWS云服务器进行访问。如使用中国大陆境内的客户端服务器，连接的稳定性将难以保证。

接口说明

火币为用户提供两种接口，您可根据自己的使用场景和偏好来选择适合的方式进行查询行情、交易或提现。

REST API

REST，即Representational State Transfer的缩写，是目前最流行的一种互联网软件架构。在RESTful架构中，每一个URL代表一种资源。

交易或资产提现等操作，建议开发者使用REST API进行操作。

WebSocket API

WebSocket是HTML5一种新的协议（Protocol）。它实现了客户端与服务器全双工通信，通过一次简单的握手就可以建立客户端和服务器连接，服务器可以根据业务规则主动推送信息给客户端。

市场行情和买卖深度等信息，建议开发者使用WebSocket API进行获取。

接口鉴权

以上两种接口均包含公共接口和私有接口两种类型。

公共接口可用于获取基础信息和行情数据。公共接口无需认证即可调用。

私有接口可用于交易管理和账户管理。每个私有请求必须使用您的API key进行签名验证。

SDK与代码示例

SDK（推荐）

Java

Python3

C++

其它代码示例

https://github.com/huobiapi?tab=repositories

公告订阅

关于API新增、更新、下线等信息火币会提前发布公告进行通知，建议您关注和订阅我们的公告，及时获取相关信息。

公告订阅流程：点击“API公告”右上角“关注”按钮，用账号登录成功后，再次点击“关注”按钮，并选择需要关注的内容类型，按钮变为“正在关注”，即表示订阅成功。若无账号，点击弹窗左下角“注册”按钮，进行注册。

您可以点击这里订阅公告。

联系我们

使用过程中如有问题或者建议，您可选择以下任一方式联系我们：

加入官方QQ群（火币网API交流群(8) 595882031），进群时请注明UID 和编程语言。
发送邮件至api_service@huobi.com。

接入说明

访问

您可以自行比较使用api.huobi.pro和api-aws.huobi.pro两个域名的延迟情况，选择延迟低的进行使用。

其中，api-aws.huobi.pro域名对使用aws云服务的用户做了一定的链路延迟优化。

REST API

https://api.huobi.pro

https://api-aws.huobi.pro

Websocket Feed（行情）

wss://api.huobi.pro/ws

wss://api-aws.huobi.pro/ws

Websocket Feed（资产和订单）

wss://api.huobi.pro/ws/v1

wss://api-aws.huobi.pro/ws/v1

请使用中国大陆以外的 IP 访问火币 API。鉴于延迟高和稳定性差等原因，不建议通过代理的方式访问火币API。

签名认证

签名说明

API 请求在通过 internet 传输的过程中极有可能被篡改，为了确保请求未被更改，除公共接口（基础信息，行情数据）外的私有接口均必须使用您的 API Key 做签名认证，以校验参数或参数值在传输途中是否发生了更改。
每一个API Key需要有适当的权限才能访问相应的接口，每个新创建的API Key都需要分配权限。在使用接口前，请查看每个接口的权限类型，并确认你的API Key有相应的权限。

一个合法的请求由以下几部分组成：

方法请求地址：即访问服务器地址 api.huobi.pro，比如 api.huobi.pro/v1/order/orders。
API 访问密钥（AccessKeyId）：您申请的 API Key 中的 Access Key。
签名方法（SignatureMethod）：用户计算签名的基于哈希的协议，此处使用 HmacSHA256。
签名版本（SignatureVersion）：签名协议的版本，此处使用2。
时间戳（Timestamp）：您发出请求的时间 (UTC 时间) 。如：2017-05-11T16:22:06。在查询请求中包含此值有助于防止第三方截取您的请求。
必选和可选参数：每个方法都有一组用于定义 API 调用的必需参数和可选参数。可以在每个方法的说明中查看这些参数及其含义。请一定注意：对于 GET 请求，每个方法自带的参数都需要进行签名运算；对于 POST 请求，每个方法自带的参数不进行签名认证，即 POST 请求中需要进行签名运算的只有 AccessKeyId、SignatureMethod、SignatureVersion、Timestamp 四个参数，其它参数放在 body 中。
签名：签名计算得出的值，用于确保签名有效和未被篡改。

创建 API Key

每个母账号可创建5组Api Key，每个Api Key可对应设置读取、交易、提币三种权限。
每个母账号还可创建200个子账号，每个子账号可创建5组Api Key，每个Api Key可对应设置读取、交易两种权限。

权限说明如下：

读取权限：读取权限用于对数据的查询接口，例如：订单查询、成交查询等。
交易权限：交易权限用于下单、撤单、划转类接口。
提币权限：提币权限用于数字货币创建提币定点、取消提币订单操作。

您可以点击这里创建 API Key，创建成功后请务必记住以下信息：

Access Key API 访问密钥
Secret Key 签名认证加密所使用的密钥（仅申请时可见）

创建 API Key 时可以绑定 IP 地址，未绑定 IP 地址的 API Key 有效期为90天。出于安全考虑，强烈建议您绑定 IP 地址. 这两个密钥与账号安全紧密相关，无论何时都请勿向其它人透露。

签名步骤

规范要计算签名的请求因为使用 HMAC 进行签名计算时，使用不同内容计算得到的结果会完全不同。所以在进行签名计算前，请先对请求进行规范化处理。下面以查询某订单详情请求为例进行说明：

查询某订单详情时完整的请求URL

https://api.huobi.pro/v1/order/orders?

AccessKeyId=e2xxxxxx-99xxxxxx-84xxxxxx-7xxxx

&SignatureMethod=HmacSHA256

&SignatureVersion=2

&Timestamp=2017-05-11T15:19:30

&order-id=1234567890

1. 请求方法（GET 或 POST），后面添加换行符 “\n”

GET\n

2. 添加小写的访问地址，后面添加换行符 “\n”

api.huobi.pro\n

3. 访问方法的路径，后面添加换行符 “\n”

/v1/order/orders\n

4. 按照ASCII码顺序对参数名进行排序，且进行URI编码，例如，下面是请求参数的原始顺序，且进行URI编码后

AccessKeyId=e2xxxxxx-99xxxxxx-84xxxxxx-7xxxx

order-id=1234567890

SignatureMethod=HmacSHA256

SignatureVersion=2

Timestamp=2017-05-11T15%3A19%3A30

使用 UTF-8 编码，且进行了 URI 编码，十六进制字符必须大写，如 “:” 会被编码为 “%3A” ，空格被编码为 “%20”。时间戳（Timestamp）需要以YYYY-MM-DDThh:mm:ss格式添加并且进行 URI 编码。

5. 经过排序之后

AccessKeyId=e2xxxxxx-99xxxxxx-84xxxxxx-7xxxx

SignatureMethod=HmacSHA256

SignatureVersion=2

Timestamp=2017-05-11T15%3A19%3A30

order-id=1234567890

6. 按照以上顺序，将各参数使用字符 “&” 连接

AccessKeyId=e2xxxxxx-99xxxxxx-84xxxxxx-7xxxx&SignatureMethod=HmacSHA256&SignatureVersion=2&Timestamp=2017-05-11T15%3A19%3A30&order-id=1234567890

7. 组成最终的要进行签名计算的字符串如下

GET\n

api.huobi.pro\n

/v1/order/orders\n

AccessKeyId=e2xxxxxx-99xxxxxx-84xxxxxx-7xxxx&SignatureMethod=HmacSHA256&SignatureVersion=2&Timestamp=2017-05-11T15%3A19%3A30&order-id=1234567890

8. 用上一步里生成的 “请求字符串” 和你的密钥 (Secret Key) 生成一个数字签名

4F65x5A2bLyMWVQj3Aqp+B4w+ivaA7n5Oi2SuYtCJ9o=

将上一步得到的请求字符串和 API 私钥作为两个参数，调用HmacSHA256哈希函数来获得哈希值。
将此哈希值用base-64编码，得到的值作为此次接口调用的数字签名。

9. 将生成的数字签名加入到请求的路径参数里

最终，发送到服务器的 API 请求应该为

https://api.huobi.pro/v1/order/orders?AccessKeyId=e2xxxxxx-99xxxxxx-84xxxxxx-7xxxx&order-id=1234567890&SignatureMethod=HmacSHA256&SignatureVersion=2&Timestamp=2017-05-11T15%3A19%3A30&Signature=4F65x5A2bLyMWVQj3Aqp%2BB4w%2BivaA7n5Oi2SuYtCJ9o%3D

把所有必须的认证参数添加到接口调用的路径参数里
把数字签名在URL编码后加入到路径参数里，参数名为“Signature”。

限频规则

现货 / 杠杆（api.huobi.pro）：10秒100次

单个 API Key 维度限制。行情 API 访问无需签名。

请求格式

所有的API请求都以GET或者POST形式发出。对于GET请求，所有的参数都在路径参数里；对于POST请求，所有参数则以JSON格式发送在请求主体（body）里。

返回格式

所有的接口返回都是JSON格式。在JSON最上层有几个表示请求状态和属性的字段："status", "ch", 和 "ts". 实际的接口返回内容在"data"字段里.

返回内容格式

{
  "status": "ok",
  "ch": "market.btcusdt.kline.1day",
  "ts": 1499223904680,
  "data": // per API response data in nested JSON object
}

参数名称	数据类型	描述
status	string	API接口返回状态
ch	string	接口数据对应的数据流。部分接口没有对应数据流因此不返回此字段
ts	int	接口返回的调整为北京时间的时间戳，单位毫秒
data	object	接口返回数据主体

错误信息

行情 API 错误信息

错误码	描述
bad-request	错误请求
invalid-parameter	参数错误
invalid-command	指令错误
code 的具体解释, 参考对应的 `err-msg`.

交易 API 错误信息

错误码	描述
base-symbol-error	交易对不存在
base-currency-error	币种不存在
base-date-error	错误的日期格式
account for id `12,345` and user id `6,543,210` does not exist	�`account-id` 错误，请使用GET `/v1/account/accounts` 接口查询
account-frozen-balance-insufficient-error	余额不足
account-transfer-balance-insufficient-error	余额不足无法冻结
bad-argument	无效参数
api-signature-not-valid	API签名错误
gateway-internal-error	系统繁忙，请稍后再试
ad-ethereum-addresss	请输入有效的以太坊地址
order-accountbalance-error	账户余额不足
order-limitorder-price-error	限价单下单价格超出限制
order-limitorder-amount-error	限价单下单数量超出限制
order-orderprice-precision-error	下单价格超出精度限制
order-orderamount-precision-error	下单数量超过精度限制
order-marketorder-amount-error	下单数量超出限制
order-queryorder-invalid	查询不到此条订单
order-orderstate-error	订单状态错误
order-datelimit-error	查询超出时间限制
order-update-error	订单更新出错

子账号

子账号可以用来隔离资产与交易，资产可以在母子账号之间划转；子账号用户只能在子账号内进行交易，并且子账号之间资产不能直接划转，只有母账号有划转权限。

子账号拥有独立的登录账号密码和 API Key，均由母账号在网页端进行管理。

子账号的 API Key 也可设置权限，包含读取、交易两种权限。

子账号的 API Key 也可绑定 IP 地址, 有效期的限制与母账号的API Key一致。

您可以点击这里创建子账号并管理。

子账号可以访问所有公共接口，包括基本信息和市场行情，子账号可以访问的私有接口如下：

接口	说明
POST /v1/order/orders/place	创建并执行订单
POST /v1/order/orders/{order-id}/submitcancel	撤销一个订单
POST /v1/order/orders/batchcancel	批量撤销订单
POST /v1/order/orders/batchCancelOpenOrders	撤销当前委托订单
GET /v1/order/orders/{order-id}	查询一个订单详情
GET /v1/order/orders	查询当前委托、历史委托
GET /v1/order/openOrders	查询当前委托订单
GET /v1/order/matchresults	查询成交
GET /v1/order/orders/{order-id}/matchresults	查询某个订单的成交明细
GET /v1/account/accounts	查询当前用户的所有账户
GET /v1/account/accounts/{account-id}/balance	查询指定账户的余额
POST /v1/futures/transfer	币币与合约账户间的资金划转
POST /v1/dw/transfer-in/margin	从币币交易账户划转至杠杆账户
POST /v1/dw/transfer-out/margin	从杠杆账户划转至币币交易账户
POST /v1/margin/orders	申请借贷
POST /v1/margin/orders/{order-id}/repay	归还借贷
GET /v1/margin/loan-orders	查询借贷记录
GET /v1/margin/accounts/balance	查询杠杆账户余额

其他接口子账号不可访问，如果尝试访问，系统会返回 “error-code 403”。

业务说明

交易对

交易对由基础币种和报价币种组成。以交易对 BTC/USDT 为例，BTC 为基础币种，USDT 为报价币种。

基础币种对应字段为 base-currency 。

报价币种对应字段为 quote-currency 。

行情

火币K线周期以新加坡时间为基准开始计算，例如日K线的起始周期为新加坡时间0时-新加坡时间次日0时。

账户

不同业务对应需要不同的账户，account-id为不同业务账户的唯一标识ID。

account-id可通过/v1/account/accounts接口获取，并根据account-type区分具体账户。

账户类型包括：

spot 现货账户
otc OTC账户
margin 逐仓杠杆账户，该账户类型以subType区分具体币种对账户
super-margin（或cross-margin）全仓杠杆账户
point 点卡账户
minepool 矿池账户
etf ETF账户

订单类型

订单状态

订单进入撮合引擎后是"等待成交"状态；

如果一个订单被撮合而全部成交，那么它会变成"完全成交"状态；

一个订单被撮合可能出现部分成交，那么它的状态会变成"部分成交"状态，并且继续留在撮合队列中进行撮合；

一个未成交订单撤单成功，，那么它的状态会变成"已撤销"状态；

发起撤销到完成撤销的过程中有一个过程状态"撤单中"；

被撤销或者全部成交的订单将被从撮合队列中剔除。

更多信息，可以点击火币成长学院进行了解。

常见问题

经常断线或者丢数据

请确认是否使用 api.huobi.pro 域名访问火币 API
请使用日本云服务器

签名失败

检查 API Key 是否有效，是否复制正确，�是否有绑定 IP 白名单
检查时间戳是否是 UTC 时间
检查参数是否按字母排序
检查编码
检查签名是否有 base64 编码
检查 GET 是否以表单方式提交
检查 POST 的 url 是否带着签名字段，POST 的数据格式是否是 json 格式
检查签名结果是否有进行 URI 编码

返回 login-required

检查参数 account-id 是否是由 GET /v1/account/accounts 接口返回的，而不是填的 UID
检查是否 POST 请求是否把业务参数也计算进签名
检查 GET 请求是否将参数按照 ASCII 码表顺序排序

返回 gateway-internal-error

检查 POST 请求是否在 header 中声明 Content-Type:application/json

基础信息

获取所有交易对

此接口返回所有火币全球站支持的交易对。

curl "https://api.huobi.pro/v1/common/symbols"

HTTP 请求

GET /v1/common/symbols

请求参数

此接口不接受任何参数。

  "data": [
   {"base-currency":"etc",
    "quote-currency":"usdt",
    "price-precision":6,
    "amount-precision":4,
    "symbol-partition":"default",
    "symbol":"etcusdt",
    "state":"online",
    "value-precision":8,
    "min-order-amt":0.001,
    "max-order-amt":10000,
    "min-order-value":0.0001
    },
    {
    "base-currency":"ltc",
    "quote-currency":"usdt",
    "price-precision":6,
    "amount-precision":4,
    "symbol-partition":"main",
    "symbol":"ltcusdt",
    "state":"online",
    "value-precision":8,
    "min-order-amt":0.001,
    "max-order-amt":10000,
    "min-order-value":100,
    "leverage-ratio":4
    }
  ]

返回字段

字段名称	数据类型	描述
base-currency	string	交易对中的基础币种
quote-currency	string	交易对中的报价币种
price-precision	integer	交易对报价的精度（小数点后位数）
amount-precision	integer	交易对基础币种计数精度（小数点后位数）
symbol-partition	string	交易区，可能值: [main，innovation]
symbol	string	交易对
state	string	交易对状态；可能值: [online，offline,suspend] online - 已上线；offline - 交易对已下线，不可交易；suspend -- 交易暂停
value-precision	integer	交易对交易金额的精度（小数点后位数）
min-order-amt	long	交易对最小下单量 (下单量指当订单类型为限价单或sell-market时，下单接口传的'amount')
max-order-amt	long	交易对最大下单量
min-order-value	long	最小下单金额（下单金额指当订单类型为限价单时，下单接口传入的(amount * price)。当订单类型为buy-market时，下单接口传的'amount'）
leverage-ratio	int	交易对杠杆最大倍数

获取所有币种

此接口返回所有火币全球站支持的币种。

curl "https://api.huobi.pro/v1/common/currencys"

HTTP 请求

GET /v1/common/currencys

请求参数

此接口不接受任何参数。

  "data": [
    "usdt",
    "eth",
    "etc"
  ]

返回字段

返回的“data”对象是一个字符串数组，每一个字符串代表一个支持的币种。

APIv2 币链参考信息

此节点用于查询各币种及其所在区块链的静态参考信息（公共数据）

HTTP 请求

GET /v2/reference/currencies

curl "https://api.huobi.pro/v2/reference/currencies?currency=usdt"

请求参数

字段名称	是否必需	类型	字段描述	取值范围
currency	false	string	币种	btc, ltc, bch, eth, etc ...(火币全球站支持的币种)
authorizedUser	false	boolean	已认证用户	true or false (如不填，缺省为true)

{
    "code":200,
    "data":[
        {
            "chains":[
                {
                    "chain":"trc20usdt",
                    "depositStatus":"allowed",
                    "maxTransactFeeWithdraw":"1.00000000",
                    "maxWithdrawAmt":"280000.00000000",
                    "minDepositAmt":"100",
                    "minTransactFeeWithdraw":"0.10000000",
                    "minWithdrawAmt":"0.01",
                    "numOfConfirmations":999,
                    "numOfFastConfirmations":999,
                    "withdrawFeeType":"circulated",
                    "withdrawPrecision":5,
                    "withdrawQuotaPerDay":"280000.00000000",
                    "withdrawQuotaPerYear":"2800000.00000000",
                    "withdrawQuotaTotal":"2800000.00000000",
                    "withdrawStatus":"allowed"
                },
                {
                    "chain":"usdt",
                    "depositStatus":"allowed",
                    "maxWithdrawAmt":"19000.00000000",
                    "minDepositAmt":"0.0001",
                    "minWithdrawAmt":"2",
                    "numOfConfirmations":30,
                    "numOfFastConfirmations":15,
                    "transactFeeRateWithdraw":"0.00100000",
                    "withdrawFeeType":"ratio",
                    "withdrawPrecision":7,
                    "withdrawQuotaPerDay":"90000.00000000",
                    "withdrawQuotaPerYear":"111000.00000000",
                    "withdrawQuotaTotal":"1110000.00000000",
                    "withdrawStatus":"allowed"
                },
                {
                    "chain":"usdterc20",
                    "depositStatus":"allowed",
                    "maxWithdrawAmt":"18000.00000000",
                    "minDepositAmt":"100",
                    "minWithdrawAmt":"1",
                    "numOfConfirmations":999,
                    "numOfFastConfirmations":999,
                    "transactFeeWithdraw":"0.10000000",
                    "withdrawFeeType":"fixed",
                    "withdrawPrecision":6,
                    "withdrawQuotaPerDay":"180000.00000000",
                    "withdrawQuotaPerYear":"200000.00000000",
                    "withdrawQuotaTotal":"300000.00000000",
                    "withdrawStatus":"allowed"
                }
            ],
            "currency":"usdt",
            "instStatus":"normal"
        }
        ]
}

响应数据

字段名称	是否必需	数据类型	字段描述	取值范围
code	true	int	状态码
message	false	string	错误描述（如有）
data	true	object
{ currency	true	string	币种
{ chains	true	object
chain	true	string	链名称
numOfConfirmations	true	int	安全上账所需确认次数（达到确认次数后允许提币）
numOfFastConfirmations	true	int	快速上账所需确认次数（达到确认次数后允许交易但不允许提币）
minDepositAmt	true	string	单次最小充币金额
depositStatus	true	string	充币状态	allowed,prohibited
minWithdrawAmt	true	string	单次最小提币金额
maxWithdrawAmt	true	string	单次最大提币金额
withdrawQuotaPerDay	true	string	当日提币额度
withdrawQuotaPerYear	true	string	当年提币额度
withdrawQuotaTotal	true	string	总提币额度
withdrawPrecision	true	int	提币精度
withdrawFeeType	true	string	提币手续费类型（特定币种在特定链上的提币手续费类型唯一）	fixed,circulated,ratio
transactFeeWithdraw	false	string	单次提币手续费（仅对固定类型有效，withdrawFeeType=fixed）
minTransactFeeWithdraw	false	string	最小单次提币手续费（仅对区间类型有效，withdrawFeeType=circulated）
maxTransactFeeWithdraw	false	string	最大单次提币手续费（仅对区间类型和有上限的比例类型有效，withdrawFeeType=circulated or ratio）
transactFeeRateWithdraw	false	string	单次提币手续费率（仅对比例类型有效，withdrawFeeType=ratio）
withdrawStatus}	true	string	提币状态	allowed,prohibited
instStatus }	true	string	币种状态	normal,delisted

状态码

状态码	错误信息	错误场景描述
200	success	请求成功
500	error	系统错误
2002	invalid field value in "field name"	非法字段取值

获取当前系统时间

此接口返回当前的系统时间，时间是调整为北京时间的时间戳，单位毫秒。

curl "https://api.huobi.pro/v1/common/timestamp"

HTTP 请求

GET /v1/common/timestamp

请求参数

此接口不接受任何参数。

  "data": 1494900087029

行情数据

K 线数据（蜡烛图）

此接口返回历史K线数据。

HTTP 请求

GET /market/history/kline

curl "https://api.huobi.pro/market/history/kline?period=1day&size=200&symbol=btcusdt"

请求参数

参数	数据类型	是否必须	默认值	描述	取值范围
symbol	string	true	NA	交易对	btcusdt, �ethbtc...
period	string	true	NA	返回数据时间粒度，也就是每根蜡烛的时间区间	1min, 5min, 15min, 30min, 60min, 4hour, 1day, 1mon, 1week, 1year
size	integer	false	150	返回 K 线数据条数	[1, 2000]

当前 REST API 不支持自定义时间区间，如需要历史固定时间范围的数据，请参考 Websocket API 中的 K 线接口。获取 hb10 净值时， symbol 请填写 “hb10”。

[
  {
    "id": 1499184000,
    "amount": 37593.0266,
    "count": 0,
    "open": 1935.2000,
    "close": 1879.0000,
    "low": 1856.0000,
    "high": 1940.0000,
    "vol": 71031537.97866500
  }
]

响应数据

字段名称	数据类型	描述
id	integer	调整为北京时间的时间戳，单位秒，并以此作为此K线柱的id
amount	float	以基础币种计量的交易量
count	integer	交易次数
open	float	本阶段开盘价
close	float	本阶段收盘价
low	float	本阶段最低价
high	float	本阶段最高价
vol	float	以报价币种计量的交易量

聚合行情（Ticker）

此接口获取ticker信息同时提供最近24小时的交易聚合信息。

HTTP 请求

GET /market/detail/merged

curl "https://api.huobi.pro/market/detail/merged?symbol=ethusdt"

请求参数

参数	数据类型	是否必须	默认值	描述	取值范围
symbol	string	true	NA	交易对	btcusdt, �ethbtc

{
  "id":1499225271,
  "ts":1499225271000,
  "close":1885.0000,
  "open":1960.0000,
  "high":1985.0000,
  "low":1856.0000,
  "amount":81486.2926,
  "count":42122,
  "vol":157052744.85708200,
  "ask":[1885.0000,21.8804],
  "bid":[1884.0000,1.6702]
}

响应数据

字段名称	数据类型	描述
id	integer	NA
amount	float	以基础币种计量的交易量
count	integer	交易次数
open	float	本阶段开盘价
close	float	本阶段最新价
low	float	本阶段最低价
high	float	本阶段最高价
vol	float	以报价币种计量的交易量
bid	object	当前的最高买价 [price, quote volume]
ask	object	当前的最低卖价 [price, quote volume]

所有交易对的最新 Tickers

获得所有交易对的 tickers，数据取值时间区间为24小时滚动。

此接口返回所有交易对的 ticker，因此数据量较大。

HTTP 请求

GET /market/tickers

curl "https://api.huobi.pro/market/tickers"

请求参数

此接口不接受任何参数。

[  
    {  
        "open":0.044297,      // 开盘价
        "close":0.042178,     // 收盘价
        "low":0.040110,       // 最高价
        "high":0.045255,      // �最低价
        "amount":12880.8510,  
        "count":12838,
        "vol":563.0388715740,
        "symbol":"ethbtc"
    },
    {  
        "open":0.008545,
        "close":0.008656,
        "low":0.008088,
        "high":0.009388,
        "amount":88056.1860,
        "count":16077,
        "vol":771.7975953754,
        "symbol":"ltcbtc"
    }
]

响应数据

核心响应数据为一个对象列，每个对象包含下面的字段

字段名称	数据类型	描述
amount	float	以基础币种计量的交易量
count	integer	交易笔数
open	float	开盘价
close	float	最新价
low	float	最低价
high	float	最高价
vol	float	以报价币种计量的交易量
symbol	string	交易对，例如btcusdt, �ethbtc

市场深度数据

此接口返回指定交易对的当前市场深度数据。

HTTP 请求

GET /market/depth

curl "https://api.huobi.pro/market/depth?symbol=btcusdt&type=step2"

请求参数

参数	数据类型	必须	默认值	描述	取值范围
symbol	string	true	NA	交易对	btcusdt, ethbtc...
depth	integer	false	20	返回深度的数量	5，10，20
type	string	true	step0	深度的价格聚合度，具体说明见下方	step0，step1，step2，step3，step4，step5

当type值为‘step0’时，‘depth’的默认值为150而非20。

参数type的各值说明

取值	说明
step0	无聚合
step1	聚合度为报价精度*10
step2	聚合度为报价精度*100
step3	聚合度为报价精度*1000
step4	聚合度为报价精度*10000
step5	聚合度为报价精度*100000

{
    "version": 31615842081,
    "ts": 1489464585407,
    "bids": [
      [7964, 0.0678], // [price, amount]
      [7963, 0.9162],
      [7961, 0.1],
      [7960, 12.8898],
      [7958, 1.2],
      ...
    ],
    "asks": [
      [7979, 0.0736],
      [7980, 1.0292],
      [7981, 5.5652],
      [7986, 0.2416],
      [7990, 1.9970],
      ...
    ]
  }

响应数据

返回的JSON顶级数据对象名为'tick'而不是通常的'data'。

字段名称	数据类型	描述
ts	integer	调整为北京时间的时间戳，单位毫秒
version	integer	内部字段
bids	object	当前的所有买单 [price, quote volume]
asks	object	当前的所有卖单 [price, quote volume]

获得近期交易记录

此接口返回指定交易对近期的所有交易记录。

HTTP 请求

GET /market/history/trade

curl "https://api.huobi.pro/market/history/trade?symbol=ethusdt&size=2"

请求参数

参数	数据类型	是否必须	默认值	描述
symbol	string	true	NA	交易对，例如 btcusdt, �ethbtc
size	integer	false	1	返回的交易记录数量，最大值2000

[  
   {  
      "id":31618787514,
      "ts":1544390317905,
      "data":[  
         {  
            "amount":9.000000000000000000,
            "ts":1544390317905,
            "trade-id": 102043483472,
            "id":3161878751418918529341,
            "price":94.690000000000000000,
            "direction":"sell"
         },
         {  
            "amount":73.771000000000000000,
            "ts":1544390317905,
            "trade-id": 102043483473
            "id":3161878751418918532514,
            "price":94.660000000000000000,
            "direction":"sell"
         }
      ]
   },
   {  
      "id":31618776989,
      "ts":1544390311353,
      "data":[  
         {  
            "amount":1.000000000000000000,
            "ts":1544390311353,
            "trade-id": 102043494568,
            "id":3161877698918918522622,
            "price":94.710000000000000000,
            "direction":"buy"
         }
      ]
   }
]

响应数据

返回的数据对象是一个对象数组，每个数组元素为一个调整为北京时间的时间戳（单位毫秒）下的所有交易记录，这些交易记录以数组形式呈现。

参数	数据类型	描述
id	integer	唯一交易id（将被废弃）
trade-id	integer	唯一成交ID（NEW）
amount	float	以基础币种为单位的交易量
price	float	以报价币种为单位的成交价格
ts	integer	调整为北京时间的时间戳，单位毫秒
direction	string	交易方向：“buy” 或 “sell”, “buy” 即买，“sell” 即卖

最近24小时行情数据

此接口返回最近24小时的行情数据汇总。

HTTP 请求

GET /market/detail

curl "https://api.huobi.pro/market/detail?symbol=ethusdt"

请求参数

参数	数据类型	是否必须	默认值	描述
symbol	string	true	NA	交易对，例如btcusdt, �ethbtc

{  
   "amount":613071.438479561,
   "open":86.21,
   "close":94.35,
   "high":98.7,
   "id":31619471534,
   "count":138909,
   "low":84.63,
   "version":31619471534,
   "vol":5.6617373443873316E7
}

响应数据

返回的JSON顶级数据对象名为'tick'而不是通常的'data'。

字段名称	数据类型	描述
id	integer	响应id
amount	float	以基础币种计量的交易量
count	integer	交易次数
open	float	本阶段开盘价
close	float	本阶段收盘价
low	float	本阶段最低价
high	float	本阶段最高价
vol	float	以报价币种计量的交易量
version	integer	内部数据

账户相关

访问账户相关的接口需要进行签名认证。

账户信息

API Key 权限：读取

查询当前用户的所有账户 ID account-id 及其相关信息

HTTP 请求

GET /v1/account/accounts

请求参数

无

{
  "data": [
    {
      "id": 100001,
      "type": "spot",
      "subtype": "",
      "state": "working"
    }
    {
      "id": 100002,
      "type": "margin",
      "subtype": "btcusdt",
      "state": "working"
    },
    {
      "id": 100003,
      "type": "otc",
      "subtype": "",
      "state": "working"
    }
  ]
}

响应数据

参数名称	是否必须	数据类型	描述	取值范围
id	true	long	account-id
state	true	string	账户状态	working：正常, lock：账户被锁定
type	true	string	账户类型	spot：现货账户， margin：逐仓杠杆账户，otc：OTC 账户，point：点卡账户，super-margin：全仓杠杆账户
subtype	false	string	子账户类型（仅对逐仓杠杆账户有效）	逐仓杠杆交易标的，例如btcusdt

逐仓/全仓杠杆账户（margin/super-margin）会在第一次划转资产时创建，如果未划转过资产则不会有杠杆账户。

账户余额

API Key 权限：读取

查询指定账户的余额，支持以下账户：

spot：现货账户， margin：逐仓杠杆账户，otc：OTC 账户，point：点卡账户，super-margin：全仓杠杆账户

HTTP 请求

GET /v1/account/accounts/{account-id}/balance

请求参数

参数名称	是否必须	类型	描述	默认值	取值范围
account-id	true	string	account-id，填在 path 中，可用 GET /v1/account/accounts 获取

{
  "data": {
    "id": 100009,
    "type": "spot",
    "state": "working",
    "list": [
      {
        "currency": "usdt",
        "type": "trade",
        "balance": "5007.4362872650"
      },
      {
        "currency": "usdt",
        "type": "frozen",
        "balance": "348.1199920000"
      }
    ]
  }
}

响应数据

参数名称	是否必须	数据类型	描述	取值范围
id	true	long	账户 ID
state	true	string	账户状态	working：正常 lock：账户被锁定
type	true	string	账户类型	spot：现货账户， margin：逐仓杠杆账户，otc：OTC 账户，point：点卡账户，super-margin：全仓杠杆账户
list	false	Array

list字段说明

参数名称	是否必须	数据类型	描述	取值范围
balance	true	string	余额
currency	true	string	币种
type	true	string	类型	trade: 交易余额，frozen: 冻结余额

账户流水

API Key 权限：读取

该节点基于用户账户ID返回账户流水。

HTTP Request

GET /v1/account/history

请求参数

参数名称	是否必需	数据类型	描述	缺省值	取值范围
account-id	true	string	账户编号
currency	false	string	币种
transact-types	false	string	变动类型，可多选	all	trade,etf, transact-fee, deduction, transfer, credit, liquidation, interest, deposit-withdraw, withdraw-fee, exchange, other-types
start-time	false	long	远点时间 unix time in millisecond. 以transact-time为key进行检索. 查询窗口最大为1小时. 窗口平移范围为最近30天.	((end-time) – 1hour)	[((end-time) – 1hour), (end-time)]
end-time	false	long	近点时间unix time in millisecond. 以transact-time为key进行检索. 查询窗口最大为1小时. 窗口平移范围为最近30天.	current-time	[(current-time) – 29days,(current-time)]
sort	false	string	检索方向	asc	asc or desc
size	false	int	最大条目数量	100	[1,500]

{
    "status": "ok",
    "data": [
        {
            "account-id": 5260185,
            "currency": "btc",
            "transact-amt": "0.002393000000000000",
            "transact-type": "transfer",
            "record-id": 89373333576,
            "avail-balance": "0.002393000000000000",
            "acct-balance": "0.002393000000000000",
            "transact-time": 1571393524526
        },
        {
            "account-id": 5260185,
            "currency": "btc",
            "transact-amt": "-0.002393000000000000",
            "transact-type": "transfer",
            "record-id": 89373382631,
            "avail-balance": "0E-18",
            "acct-balance": "0E-18",
            "transact-time": 1571393578496
        }
    ]
}

响应数据

字段名称	数据类型	描述
status	string	状态码
data	object
{ account-id	long	账户编号
currency	string	币种
transact-amt	string	变动金额（入账为正 or 出账为负）
transact-type	string	变动类型
avail-balance	string	可用余额
acct-balance	string	账户余额
transact-time	long	交易时间（数据库记录时间）
record-id }	string	数据库记录编号（全局唯一）

币币现货账户与合约账户划转

API Key 权限：交易

此接口用户币币现货账户与合约账户之间的资金划转。

从现货现货账户转至合约账户，类型为pro-to-futures; 从合约账户转至现货账户，类型为futures-to-pro

该接口的访问频次的限制为1分钟10次。

HTTP 请求

POST /v1/futures/transfer

{
  "currency": "btc",
  "amount": "0.001",
  "type": "pro-to-futures"
}

请求参数

参数名称	数据类型	是否必需	默认值	描述	取值范围
currency	string	true	NA	币种, e.g. btc
amount	decimal	true	NA	划转数量
type	string	true	NA	划转类型	从合约账户到现货账户：“futures-to-pro”，从现货账户到合约账户： “pro-to-futures”

{  
  "data": 12345
  "status": "ok"
}

响应数据

参数名称	数据�类型	描述
data	Long	Transfer id
status	string	"ok" or "error"
err-code	string	错误码，具体错误码请见列表
err-msg	string	错误消息，具体消息内容请列表

err-code列表

err-code	err-msg(中文）	err-msg(Englis)	补充说明
base-msg			其他错误，具体的err-msg, 请参照对应的错误消息列表。
base-currency-error	币种无效	The currency is invalid
frequent-invoke	操作过于频繁，请稍后重试。（如果超过1分钟10次，系统返回该error-code）	the operation is too frequent. Please try again later	如果请求次数超过1分钟10次，系统返回该error-code
banned-by-blacklist	黑名单限制	Blacklist restriction
dw-insufficient-balance	可划转余额不足，最大可划转 {0}。（币币账户的余额不足。）	Insufficient balance. You can only transfer {0} at most.	币币账户的余额不足。
dw-account-transfer-unavailable	转账暂时不可用	account transfer unavailable	该接口暂时不可用
dw-account-transfer-error	由于其他服务不可用导致的划转失败	account transfer error
dw-account-transfer-failed	划转失败。请稍后重试或联系客服	Failed to transfer. Please try again later.	由于系统异常导致的划转失败
dw-account-transfer-failed-account-abnormality	账户异常，划转失败。请稍后重试或联系客服	Account abnormality, failed to transfer。Please try again later.

base-msg对应的err-msg列表

err-code	err-msg(中文）	err-msg(Englis)	补充说明
base-msg	用户没有入金权限	Unable to transfer in currently. Please contact customer service.
base-msg	用户没有出金权限	Unable to transfer out currently. Please contact customer service.
base-msg	合约状态异常，无法出入金	Abnormal contracts status. Can’t transfer.
base-msg	子账号没有入金权限，请联系客服	Sub-account doesn't own the permissions to transfer in. Please contact customer service.
base-msg	子账号没有出金权限，请联系客服	Sub-account doesn't own the permissions to transfer out. Please contact customer service.
base-msg	子账号没有划转权限，请登录主账号授权	The sub-account does not have transfer permissions. Please login main account to authorize.
base-msg	可划转余额不足	Insufficient amount available.	合约账户的余额不足
base-msg	单笔转出的数量不能低于{0}{1}	The single transfer-out amount must be no less than {0}{1}.
base-msg	单笔转出的数量不能高于{0}{1}	The single transfer-out amount must be no more than {0}{1}.
base-msg	单笔转入的数量不能低于{0}{1}	The single transfer-in amount must be no less than {0}{1}.
base-msg	单笔转入的数量不能高于{0}{1}	The single transfer-in amount must be no more than {0}{1}.
base-msg	您当日累计转出量超过{0}{1}，暂无法转出	Your accumulative transfer-out amount is over the daily maximum, {0}{1}. You can't transfer out for the time being.
base-msg	您当日累计转入量超过{0}{1}，暂无法转入	Your accumulative transfer-in amount is over the daily maximum, {0}{1}. You can't transfer in for the time being.
base-msg	您当日累计净转出量超过{0}{1}，暂无法转出	Your accumulative net transfer-out amount is over the daily maximum, {0}{1}. You can't transfer out for the time being.
base-msg	您当日累计净转入量超过{0}{1}，暂无法转入	Your accumulative net transfer-in amount is over the daily maximum, {0}{1}. You can't transfer in for the time being.
base-msg	超过平台当日累计最大转出量限制，暂无法转出	The platform's accumulative transfer-out amount is over the daily maximum. You can't transfer out for the time being.
base-msg	超过平台当日累计最大转入量限制，暂无法转入	The platform's accumulative transfer-in amount is over the daily maximum. You can't transfer in for the time being.
base-msg	超过平台当日累计最大净转出量限制，暂无法转出	The platform's accumulative net transfer-out amount is over the daily maximum. You can't transfer out for the time being.
base-msg	超过平台当日累计最大净转入量限制，暂无法转入	The platform's accumulative net transfer-in amount is over the daily maximum. You can't transfer in for the time being.
base-msg	划转失败，请稍后重试或联系客服	Transfer failed. Please try again later or contact customer service.
base-msg	服务异常，划转失败，请稍后再试	Abnormal service, transfer failed. Please try again later.
base-msg	您尚未开通合约交易，无访问权限	You don’t have access permission as you have not opened contracts trading.
base-msg	合约品种不存在	This contract type doesn't exist.	没有相应币种的合约

资产划转（母子账号之间）

API Key 权限：交易

母账户执行母子账号之间的划转

HTTP 请求

POST /v1/subuser/transfer

请求参数

参数|是否必填 | 数据类型 | 说明 | 取值范围 | -----------|------------|-----------|------------|----------|-- sub-uid |true| long|子账号uid |-| currency|true| string|币种 |-| amount|true| decimal|划转金额|-| type|true|string|划转类型| master-transfer-in（子账号划转给母账户虚拟币）/ master-transfer-out （母账户划转给子账号虚拟币）/master-point-transfer-in （子账号划转给母账户点卡）/master-point-transfer-out（母账户划转给子账号点卡） |

{
  "data":123456,
  "status":"ok"
}

响应数据

参数	是否必填	数据类型	长度	说明	取值范围
data	true	int	-	划转订单id	-
status	true		-	状态	"OK" or "Error"

错误码

error_code	说明	类型
account-transfer-balance-insufficient-error	账户余额不足	string
base-operation-forbidden	禁止操作（母子账号关系错误时报）	string

子账号余额（汇总）

API Key 权限：读取

母账户查询其下所有子账号的各币种汇总余额

HTTP 请求

GET /v1/subuser/aggregate-balance

请求参数

无

{
  "status": "ok",
  "data": [
      {
        "currency": "eos",
        "type": "spot",
        "balance": "1954559.809500000000000000"
      },
      {
        "currency": "btc",
        "type": "spot",
        "balance": "0.000000000000000000"
      },
      {
        "currency": "usdt",
        "type": "spot",
        "balance": "2925209.411300000000000000"
      },
      ...
   ]
}

响应数据

参数	是否必填	数据类型	长度	说明	取值范围
status	true		-	状态	"OK" or "Error"
data	true	list	-		-

data

参数	是否必填	数据类型	长度	说明	取值范围
currency	是	string	-	子账号币名	-
type	是	string	-	账户类型	spot：现货账户，point：点卡账户, margin:逐仓杠杆账户
balance	是	string	-	子账号下该币种所有余额（可用余额和冻结余额的总和）	-

子账号余额

API Key 权限：读取

母账户查询子账号各币种账户余额

HTTP 请求

GET /v1/account/accounts/{sub-uid}

请求参数

参数	是否必填	数据类型	长度	说明	取值范围
sub-uid	true	long	-	子账号的 UID	-

{
  "status": "ok",
	"data": [
    {
      "id": 9910049,
      "type": "spot",
      "list": 
      [
        {
          "currency": "btc",
          "type": "trade",
          "balance": "1.00"
        },
        {
          "currency": "eth",
          "type": "trade",
          "balance": "1934.00"
        }
      ]
    },
    {
      "id": 9910050,
      "type": "point",
      "list": []
    }
	]
}

响应数据

参数	是否必填	数据类型	长度	说明	取值范围
id	-	long	-	子账号 UID	-
type	-	string	-	账户类型	spot：现货账户，point：点卡账户, margin:逐仓杠杆账户
list	-	object	-	-	-

list

参数	是否必填	数据类型	长度	说明	取值范围
currency	-	string	-	币种	-
type	-	string	-	账户类型	trade：交易账户，frozen：冻结账户
balance	-	decimal	-	账户余额	-

钱包（充值与提现）

访问钱包相关的接口需要进行签名认证。

APIv2 充币地址查询

此节点用于查询特定币种（IOTA除外）在其所在区块链中的充币地址

API Key 权限：读取

充币地址查询暂不支持IOTA币

HTTP 请求

GET /v2/account/deposit/address

curl "https://api.huobi.pro/v2/account/deposit/address?currency=btc"

请求参数

字段名称	是否必需	类型	字段描述	取值范围
currency	true	string	币种	btc, ltc, bch, eth, etc ...(火币全球站支持的币种)

{
    "code": 200,
    "data": [
        {
            "currency": "btc",
            "address": "1PSRjPg53cX7hMRYAXGJnL8mqHtzmQgPUs",
            "addressTag": "",
            "chain": "btc"
        }
    ]
}

响应数据

字段名称	是否必需	数据类型	字段描述
code	true	int	状态码
message	false	string	错误描述（如有）
data	true	object
{currency	true	string	币种
address	true	string	充币地址
addressTag	true	string	充币地址标签
chain }	true	string	链名称

状态码

状态码	错误信息	错误场景描述
200	success	请求成功
500	error	系统错误
1002	unauthorized	未授权
1003	invalid signature	验签失败
2002	invalid field value in "field name"	非法字段取值
2003	missing mandatory field "field name"	强制字段缺失

APIv2 提币额度查询

此节点用于查询各币种提币额度

API Key 权限：读取

HTTP 请求

GET /v2/account/withdraw/quota

curl "https://api.huobi.pro/v2/account/withdraw/quota?currency=btc"

请求参数

字段名称	是否必需	类型	字段描述	取值范围
currency	true	string	币种	btc, ltc, bch, eth, etc ...(火币全球站支持的币种)

{
    "code": 200,
    "data": [
        {
            "currency": "btc",
            "chains": 
                {
                    "chain": "btc",
                    "maxWithdrawAmt": "200.00000000",
                    "withdrawQuotaPerDay": "200.00000000",
                    "remainWithdrawQuotaPerDay": "200.000000000000000000",
                    "withdrawQuotaPerYear": "700000.00000000",
                    "remainWithdrawQuotaPerYear": "700000.000000000000000000",
                    "withdrawQuotaTotal": "7000000.00000000",
                    "remainWithdrawQuotaTotal": "7000000.000000000000000000"
                }         
        }
    ]
}

响应数据

字段名称	是否必需	数据类型	字段描述
code	true	int	状态码
message	false	string	错误描述（如有）
data	true	object
currency	true	string	币种
chains	true	object
{ chain	true	string	链名称
maxWithdrawAmt	true	string	单次最大提币金额
withdrawQuotaPerDay	true	string	当日提币额度
remainWithdrawQuotaPerDay	true	string	当日提币剩余额度
withdrawQuotaPerYear	true	string	当年提币额度
remainWithdrawQuotaPerYear	true	string	当年提币剩余额度
withdrawQuotaTotal	true	string	总提币额度
remainWithdrawQuotaTotal }	true	string	总提币剩余额度

状态码

状态码	错误信息	错误场景描述
200	success	请求成功
500	error	系统错误
1002	unauthorized	未授权
1003	invalid signature	验签失败
2002	invalid field value in "field name"	非法字段取值

虚拟币提现

API Key 权限：提币

如果用户在个人设置里设置了优先使用快速提币，通过API发起的提币也会优先选择快速提币通道。快速提币是指当提币目标地址是火币用户地址时，提币将通过火币平台内部快速通道，不通过区块链。 API提币仅支持用户的相应币种常用地址列表中的地址。

HTTP 请求

POST /v1/dw/withdraw/api/create

{
  "address": "0xde709f2102306220921060314715629080e2fb77",
  "amount": "0.05",
  "currency": "eth",
  "fee": "0.01"
}

请求参数

参数名称	是否必须	类型	描述	取值范围
address	true	string	提现地址	仅支持在官网上相应币种地址列表中的地址
amount	true	string	提币数量
currency	true	string	资产类型	btc, ltc, bch, eth, etc ...(火币全球站支持的币种)
fee	true	string	转账手续费
chain	false	string	提USDT至OMNI时须设置此参数为"usdt"，提USDT至TRX时须设置此参数为"trc20usdt"，其他币种提现无须设置此参数
addr-tag	false	string	虚拟币共享地址tag，适用于xrp，xem，bts，steem，eos，xmr	格式, "123"类的整数字符串

{
  "data": 700
}

响应数据

参数名称	是否必须	数据类型	描述	取值范围
data	false	long	提现 ID

取消提现

API Key 权限：提币

HTTP 请求

POST /v1/dw/withdraw-virtual/{withdraw-id}/cancel

请求参数

参数名称	是否必须	类型	描述	默认值	取值范围
withdraw-id	true	long	提现 ID，填在 path 中

{
  "data": 700
}

响应数据

参数名称	是否必须	数据类型	描述	取值范围
data	false	long	提现 ID

充提记录

API Key 权限：读取

查询充提记录

HTTP 请求

GET /v1/query/deposit-withdraw

请求参数

参数名称	是否必须	类型	描述	默认值	取值范围
currency	false	string	币种		缺省时，返回所有币种
type	true	string	充值或提现		deposit 或 withdraw
from	false	string	查询起始 ID	缺省时，默认值direct相关。当direct为‘prev’时，from 为1 ，从旧到新升序返回；当direct为’next‘时，from为最新的一条记录的ID，从新到旧降序返回
size	false	string	查询记录大小	100	1-500
direct	false	string	返回记录排序方向	缺省时，默认为“prev” （升序）	“prev” （升序）or “next” （降序）

{
  "data":
    [
      {
        "id": 1171,
        "type": "deposit",
        "currency": "xrp",
        "tx-hash": "ed03094b84eafbe4bc16e7ef766ee959885ee5bcb265872baaa9c64e1cf86c2b",
        "amount": 7.457467,
        "address": "rae93V8d2mdoUQHwBDBdM4NHCMehRJAsbm",
        "address-tag": "100040",
        "fee": 0,
        "state": "safe",
        "created-at": 1510912472199,
        "updated-at": 1511145876575
      },
      ...
    ]
}

响应数据

参数名称	是否必须	数据类型	描述	取值范围
id	true	long
type	true	string	类型	'deposit', 'withdraw'
currency	true	string	币种
tx-hash	true	string	交易哈希
chain	true	string	链名称
amount	true	float	个数
address	true	string	地址
address-tag	true	string	地址标签
fee	true	float	手续费
state	true	string	状态	状态参见下表
created-at	true	long	发起时间
updated-at	true	long	最后更新时间

虚拟币充值状态定义：

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

虚拟币提现状态定义：

状态	描述
submitted	已提交
reexamine	审核中
canceled	已撤销
pass	审批通过
reject	审批拒绝
pre-transfer	处理中
wallet-transfer	已汇出
wallet-reject	钱包拒绝
confirmed	区块已确认
confirm-error	区块确认错误
repealed	已撤销

现货 / 杠杆交易

访问交易相关的接口需要进行签名认证。逐仓杠杆交易时，“account-id” 参数需设置为 “margin” 的 account-id， “source”参数需设置为 “margin-api”；全仓杠杆交易时，“account-id” 参数需设置为 “super-margin” 的 account-id， “source”参数需设置为 “super-margin-api”。

下单

API Key 权限：交易

发送一个新订单到火币以进行撮合。

HTTP 请求

POST /v1/order/orders/place

{
  "account-id": "100009",
  "amount": "10.1",
  "price": "100.1",
  "source": "api",
  "symbol": "ethusdt",
  "type": "buy-limit",
  "client-order-id": "a0001"
}

请求参数

参数名称	数据类型	是否必需	默认值	描述
account-id	string	true	NA	账户 ID，使用 GET /v1/account/accounts 接口查询。现货交易使用 ‘spot’ 账户的 account-id；逐仓杠杆交易，请使用 ‘margin’ 账户的 account-id；全仓杠杆交易，请使用 ‘super-margin’ 账户的 account-id
symbol	string	true	NA	交易对, 例如btcusdt, �ethbtc
type	string	true	NA	订单类型，包括buy-market, sell-market, buy-limit, sell-limit, buy-ioc, sell-ioc, buy-limit-maker, sell-limit-maker（说明见下文）, buy-stop-limit, sell-stop-limit
amount	string	true	NA	订单交易量（市价买单此字段为订单交易额）
price	string	false	NA	limit order的交易价格
source	string	false	api	现货交易填写“api”，逐仓杠杆交易填写“margin-api”，全仓杠杆交易填写“super-margin-api”
client-order-id	string	false	NA	用户自编订单号（最大长度64个字符，须在24小时内保持唯一性）
stop-price	string	false	NA	止盈止损订单触发价格
operator	string	false	NA	止盈止损订单触发价运算符 gte – greater than and equal (>=), lte – less than and equal (<=)

buy-limit-maker

当“下单价格”>=“市场最低卖出价”，订单提交后，系统将拒绝接受此订单；

当“下单价格”<“市场最低卖出价”，提交成功后，此订单将被系统接受。

sell-limit-maker

当“下单价格”<=“市场最高买入价”，订单提交后，系统将拒绝接受此订单；

当“下单价格”>“市场最高买入价”，提交成功后，此订单将被系统接受。

{  
  "data": "59378"
}

响应数据

返回的主数据对象是一个对应下单单号的字符串。

如client order ID（在24小时内）被复用，节点返回先前订单的client order ID。

撤销订单

API Key 权限：交易

此接口发送一个撤销订单的请求。

此接口只提交取消请求，实际取消结果需要通过订单状态，撮合状态等接口来确认。

HTTP 请求

POST /v1/order/orders/{order-id}/submitcancel

请求参数

参数名称	是否必须	类型	描述	默认值	取值范围
order-id	true	string	订单ID，填在path中

{  
  "data": "59378"
}

响应数据

返回的主数据对象是一个对应下单单号的字符串。

错误码

{
  "status": "error",
  "err-code": "order-orderstate-error",
  "err-msg": "订单状态错误",
  "order-state":-1 // 当前订单状态
}

返回字段列表中，order-state的可能取值包括 -

order-state	Description
-1	order was already closed in the long past (order state = canceled, partial-canceled, filled, partial-filled)
5	partial-canceled
6	filled
7	canceled
10	cancelling

撤销订单（基于client order ID）

API Key 权限：交易

此接口发送一个撤销订单的请求。

此接口只提交取消请求，实际取消结果需要通过订单状态，撮合状态等接口来确认。

HTTP 请求

POST /v1/order/orders/submitCancelClientOrder

{
  "client-order-id": "a0001"
}

请求参数

参数名称	是否必须	类型	描述	默认值	取值范围
client-order-id	true	string	用户自编订单号

{  
  "data": "10"
}

响应数据

字段名称	数据类型	描述
data	integer	撤单状态码

Status Code	Description
-1	order was already closed in the long past (order state = canceled, partial-canceled, filled, partial-filled)
0	client-order-id not found
5	partial-canceled
6	filled
7	canceled
10	cancelling

查询当前未成交订单

API Key 权限：读取

查询已提交但是仍未完全成交或未被撤销的订单。

{
   "account-id": "100009",
   "symbol": "ethusdt",
   "side": "buy"
}

HTTP 请求

GET /v1/order/openOrders

请求参数

参数名称	数据类型	是否必需	默认值	描述
account-id	string	true	NA	账户 ID，使用 GET /v1/account/accounts 接口获得。现货交易使用‘spot’账户的 account-id；逐仓杠杆交易，请使用 ‘margin’ 账户的 account-id；全仓杠杆交易，请使用 ‘super-margin’ 账户的 account-id
symbol	string	ture	NA	交易对, 例如btcusdt, ethbtc
side	string	false	both	指定只返回某一个方向的订单，可能的值有: buy, sell. 默认两个方向都返回。
from	string	false		查询起始 ID
direct	string	false (如字段'from'已设定，此字段'direct'为必填)		查询方向 (prev - 以起始ID升序检索；next - 以起始ID降序检索)
size	int	false	100	返回订单的数量，最大值500。

{  
  "data": [
    {
      "id": 5454937,
      "symbol": "ethusdt",
      "account-id": 30925,
      "amount": "1.000000000000000000",
      "price": "0.453000000000000000",
      "created-at": 1530604762277,
      "type": "sell-limit",
      "filled-amount": "0.0",
      "filled-cash-amount": "0.0",
      "filled-fees": "0.0",
      "source": "web",
      "state": "submitted"
    }
  ]
}

响应数据

字段名称	数据类型	描述
id	integer	订单id
symbol	string	交易对, 例如btcusdt, �ethbtc
price	string	limit order的交易价格
created-at	int	订单创建的调整为北京时间的时间戳，单位毫秒
type	string	订单类型
filled-amount	string	订单中已成交部分的数量
filled-cash-amount	string	订单中已成交部分的总价格
filled-fees	string	已交交易手续费总额
source	string	现货交易填写“api”
state	string	订单状态，包括submitted, partial-filled, cancelling, created
stop-price	string	止盈止损订单触发价格
operator	string	止盈止损订单触发价运算符

批量撤销订单（open orders）

API Key 权限：交易

此接口发送批量撤销订单的请求。

此接口只提交取消请求，实际取消结果需要通过订单状态，撮合状态等接口来确认。

HTTP 请求

POST /v1/order/orders/batchCancelOpenOrders

请求参数

参数名称	是否必须	类型	描述	默认值	取值范围
account-id	true	string	账户ID
symbol	false	string	交易代码列表（最多10 个symbols，多个交易代码间以逗号分隔）	all
side	false	string	主动交易方向		“buy”或“sell”，缺省将返回所有符合条件尚未成交订单
size	false	int	所需返回记录数	100	[0,100]

{
  "status": "ok",
  "data": {
    "success-count": 2,
    "failed-count": 0,
    "next-id": 5454600
  }
}

响应数据

参数名称	是否必须	数据类型	描述
success-count	true	int	成功取消的订单数
failed-count	true	int	取消失败的订单数
next-id	true	long	下一个符合取消条件的订单号

批量撤销订单

API Key 权限：交易

此接口同时为多个订单（基于id）发送取消请求。

HTTP 请求

POST /v1/order/orders/batchcancel

{
  "order-ids": [
    "1", "2", "3"
  ]
}

请求参数

参数名称	是否必须	类型	描述	默认值	取值范围
order-ids	true	list	撤销订单ID列表		单次不超过50个订单id

{  
  "data": {
    "success": [
      "1",
      "3"
    ],
    "failed": [
      {
        "err-msg": "记录无效",
        "order-id": "2",
        "err-code": "base-record-invalid"
        "order-state":-1 // 当前订单状态
      }
    ]
  }
}

响应数据

字段名称	数据类型	描述
data	map	撤单结果

错误码

{
  "status": "ok",
  "data": {
    "success": ["123","456"],
    "failed": [
      {
        "err-msg": "订单状态错误",
        "order-id": "12345678",
        "err-code": "order-orderstate-error",
        "order-state":-1 // 当前订单状态
      }
    ]
  }
}

返回字段列表中，order-state的可能取值包括 -

order-state	Description
-1	order was already closed in the long past (order state = canceled, partial-canceled, filled, partial-filled)
5	partial-canceled
6	filled
7	canceled
10	cancelling

查询订单详情

API Key 权限：读取

此接口返回指定订单的最新状态和详情。

HTTP 请求

GET /v1/order/orders/{order-id}

请求参数

参数名称	是否必须	类型	描述	默认值	取值范围
order-id	true	string	订单ID，填在path中

{  
  "data": 
  {
    "id": 59378,
    "symbol": "ethusdt",
    "account-id": 100009,
    "amount": "10.1000000000",
    "price": "100.1000000000",
    "created-at": 1494901162595,
    "type": "buy-limit",
    "field-amount": "10.1000000000",
    "field-cash-amount": "1011.0100000000",
    "field-fees": "0.0202000000",
    "finished-at": 1494901400468,
    "user-id": 1000,
    "source": "api",
    "state": "filled",
    "canceled-at": 0
  }
}

响应数据

字段名称	是否必须	数据类型	描述	取值范围
account-id	true	long	账户 ID
amount	true	string	订单数量
canceled-at	false	long	订单撤销时间
created-at	true	long	订单创建时间
field-amount	true	string	已成交数量
field-cash-amount	true	string	已成交总金额
field-fees	true	string	已成交手续费（买入为币，卖出为钱）
finished-at	false	long	订单变为终结态的时间，不是成交时间，包含“已撤单”状态
id	true	long	订单ID
price	true	string	订单价格
source	true	string	订单来源	api
state	true	string	订单状态	submitted 已提交, partial-filled 部分成交, partial-canceled 部分成交撤销, filled 完全成交, canceled 已撤销， created
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
stop-price	false	string	止盈止损订单触发价格
operator	false	string	止盈止损订单触发价运算符	gte,lte

查询订单详情（基于client order ID）

API Key 权限：读取

此接口返回指定订单的最新状态和详情。

HTTP 请求

GET /v1/order/orders/getClientOrder

{
  "clientOrderId": "a0001"
}

请求参数

参数名称	是否必须	类型	描述	默认值	取值范围
clientOrderId	true	string	用户自编订单号

{  
  "data": 
  {
    "id": 59378,
    "symbol": "ethusdt",
    "account-id": 100009,
    "amount": "10.1000000000",
    "price": "100.1000000000",
    "created-at": 1494901162595,
    "type": "buy-limit",
    "field-amount": "10.1000000000",
    "field-cash-amount": "1011.0100000000",
    "field-fees": "0.0202000000",
    "finished-at": 1494901400468,
    "user-id": 1000,
    "source": "api",
    "state": "filled",
    "canceled-at": 0
  }
}

响应数据

字段名称	是否必须	数据类型	描述	取值范围
account-id	true	long	账户 ID
amount	true	string	订单数量
canceled-at	false	long	订单撤销时间
created-at	true	long	订单创建时间
field-amount	true	string	已成交数量
field-cash-amount	true	string	已成交总金额
field-fees	true	string	已成交手续费（买入为币，卖出为钱）
finished-at	false	long	订单变为终结态的时间，不是成交时间，包含“已撤单”状态
id	true	long	订单ID
price	true	string	订单价格
source	true	string	订单来源	api
state	true	string	订单状态	submitted 已提交, partial-filled 部分成交, partial-canceled 部分成交撤销, filled 完全成交, canceled 已撤销，created
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
stop-price	false	string	止盈止损订单触发价格
operator	false	string	止盈止损订单触发价运算符	gte,lte

如client order ID不存在，返回如下错误信息 { "status": "error", "err-code": "base-record-invalid", "err-msg": "record invalid", "data": null }

成交明细

API Key 权限：读取

此接口返回指定订单的成交明细。

HTTP 请求

GET /v1/order/orders/{order-id}/matchresults�

请求参数

参数名称	是否必须	类型	描述	默认值	取值范围
order-id	true	string	订单ID，填在path中

{  
  "data": [
    {
      "id": 29553,
      "order-id": 59378,
      "match-id": 59335,
      "trade-id": 100282808529,
      "symbol": "ethusdt",
      "type": "buy-limit",
      "source": "api",
      "price": "100.1000000000",
      "filled-amount": "9.1155000000",
      "filled-fees": "0.0182310000",
      "created-at": 1494901400435,
      "role": "maker",
      "filled-points": "0.0",
      "fee-deduct-currency": ""
    }
    ...
  ]
}

响应数据

返回的主数据对象为一个对象数组，其中每一个元件代表一个交易结果。

字段名称	是否必须	数据类型	描述	取值范围
created-at	true	long	成交时间
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
role	true	string	成交角色	maker,taker
filled-points	true	string	抵扣数量（可为ht或hbpoint）
fee-deduct-currency	true	string	抵扣类型	如果为空，代表扣除的手续费是原币；如果为"ht"，代表抵扣手续费的是HT；如果为"hbpoint"，代表抵扣手续费的是点卡

搜索历史订单

API Key 权限：读取

此接口基于搜索条件查询历史订单。

HTTP 请求

GET /v1/order/orders

{
   "account-id": "100009",
   "amount": "10.1",
   "price": "100.1",
   "source": "api",
   "symbol": "ethusdt",
   "type": "buy-limit"
}

请求参数

参数名称	是否必须	类型	描述	默认值	取值范围
symbol	true	string	交易对		btcusdt, �ethbtc, rcneth ...
types	false	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
start-date	false	string	查询开始日期, 日期格式yyyy-mm-dd。以订单生成时间进行查询	-1d 查询结束日期的前1天	取值范围 [((end-date) – 1), (end-date)] ，查询窗口最大为2天，窗口平移范围为最近180天，已完全撤销的历史订单的查询窗口平移范围只有最近7天(state="canceled")
end-date	false	string	查询结束日期, 日期格式yyyy-mm-dd。以订单生成时间进行查询	today	取值范围 [(today-179), today] ，查询窗口最大为2天，窗口平移范围为最近180天，已完全撤销的历史订单的查询窗口平移范围只有最近7天(state="canceled")
states	true	string	查询的订单状态组合，使用','分割		submitted 已提交, partial-filled 部分成交, partial-canceled 部分成交撤销, filled 完全成交, canceled 已撤销，created
from	false	string	查询起始 ID
direct	false	string	查询方向		prev 向前，时间（或 ID）正序；next 向后，时间（或 ID）倒序）
size	false	string	查询记录大小	100	[1, 100]

{  
  "data": [
    {
      "id": 59378,
      "symbol": "ethusdt",
      "account-id": 100009,
      "amount": "10.1000000000",
      "price": "100.1000000000",
      "created-at": 1494901162595,
      "type": "buy-limit",
      "field-amount": "10.1000000000",
      "field-cash-amount": "1011.0100000000",
      "field-fees": "0.0202000000",
      "finished-at": 1494901400468,
      "user-id": 1000,
      "source": "api",
      "state": "filled",
      "canceled-at": 0
    }
    ...
  ]
}

响应数据

参数名称	是否必须	数据类型	描述	取值范围
account-id	true	long	账户 ID
amount	true	string	订单数量
canceled-at	false	long	接到撤单申请的时间
created-at	true	long	订单创建时间
field-amount	true	string	已成交数量
field-cash-amount	true	string	已成交总金额
field-fees	true	string	已成交手续费（买入为基础币，卖出为计价币）
finished-at	false	long	最后成交时间
id	true	long	订单ID
price	true	string	订单价格
source	true	string	订单来源	api
state	true	string	订单状态	submitted 已提交, partial-filled 部分成交, partial-canceled 部分成交撤销, filled 完全成交, canceled 已撤销，created
symbol	true	string	交易对	btcusdt, �ethbtc, rcneth ...
type	true	string	订单类型	submit-cancel：已提交撤单申请 ,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
stop-price	false	string	止盈止损订单触发价格
operator	false	string	止盈止损订单触发价运算符	gte,lte

start-date, end-date相关错误码

错误码	对应错误场景
invalid_interval	start date小于end date; 或者 start date 与end date之间的时间间隔大于2天
invalid_start_date	start date是一个180天之前的日期；或者start date是一个未来的日期
invalid_end_date	end date 是一个180天之前的日期；或者end date是一个未来的日期

搜索最近48小时内历史订单

API Key 权限：读取

此接口基于搜索条件查询最近48小时内历史订单。

HTTP 请求

GET /v1/order/history

{
   "symbol": "btcusdt",
   "start-time": "1556417645419",
   "end-time": "1556533539282",
   "direct": "prev",
   "size": "10"
}

请求参数

参数名称	是否必须	类型	描述	默认值	取值范围
symbol	false	string	交易对	all	btcusdt, �ethbtc, rcneth ...
start-time	false	long	查询起始时间（含）	48小时前的时刻	UTC time in millisecond
end-time	false	long	查询结束时间（含）	查询时刻	UTC time in millisecond
direct	false	string	订单查询方向（注：仅在检索出的总条目数量超出size字段限定时起作用；如果检索出的总条目数量在size 字段限定内，direct 字段不起作用。）	next	prev, next
size	false	int	每次返回条目数量	100	[10,1000]

{
    "status": "ok",
    "data": [
        {
            "id": 31215214553,
            "symbol": "btcusdt",
            "account-id": 4717043,
            "amount": "1.000000000000000000",
            "price": "1.000000000000000000",
            "created-at": 1556533539282,
            "type": "buy-limit",
            "field-amount": "0.0",
            "field-cash-amount": "0.0",
            "field-fees": "0.0",
            "finished-at": 1556533568953,
            "source": "web",
            "state": "canceled",
            "canceled-at": 1556533568911
        }
    ]
}

响应数据

参数名称	是否必须	数据类型	描述	取值范围
{account-id	true	long	账户 ID
amount	true	string	订单数量
canceled-at	false	long	接到撤单申请的时间
created-at	true	long	订单创建时间
field-amount	true	string	已成交数量
field-cash-amount	true	string	已成交总金额
field-fees	true	string	已成交手续费（买入为基础币，卖出为计价币）
finished-at	false	long	最后成交时间
id	true	long	订单ID
price	true	string	订单价格
source	true	string	订单来源	api
state	true	string	订单状态	partial-canceled 部分成交撤销, filled 完全成交, canceled 已撤销
symbol	true	string	交易对	btcusdt, �ethbtc, rcneth ...
stop-price	false	string	止盈止损订单触发价格
operator	false	string	止盈止损订单触发价运算符	gte,lte
type}	true	string	订单类型	buy-market：市价买, sell-market：市价卖, buy-limit：限价买, sell-limit：限价卖, buy-ioc：IOC买单, sell-ioc：IOC卖单, buy-limit-maker, sell-limit-maker, buy-limit-maker, sell-limit-maker
next-time	false	long	下一查询起始时间（当请求字段”direct”为”prev”时有效）, 下一查询结束时间（当请求字段”direct”为”next”时有效）。注：仅在检索出的总条目数量超出size字段限定时，此返回字段存在。	UTC time in millisecond

当前和历史成交

API Key 权限：读取

此接口基于搜索条件查询当前和历史成交记录。

HTTP 请求

GET /v1/order/matchresults

请求参数

参数名称	是否必须	类型	描述	默认值	取值范围
symbol	true	string	交易对	NA	btcusdt, �ethbtc, rcneth ...
types	false	string	查询的订单类型组合，使用','分割	all	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
start-date	false	string	查询开始日期, 日期格式yyyy-mm-dd	-1d 查询结束日期的前1天	取值范围 [((end-date) – 1), (end-date)] ，查询窗口最大为2天，窗口平移范围为最近61天
end-date	false	string	查询结束日期, 日期格式yyyy-mm-dd	today	取值范围 [(today-60), today] ，查询窗口最大为2天，窗口平移范围为最近61天
from	false	string	查询起始 ID	订单成交记录ID（最大值）
direct	false	string	查询方向	默认 next，成交记录 ID 由大到小排序	prev 向前，时间（或 ID）正序；next 向后，时间（或 ID）倒序）
size	false	string	查询记录大小	100	[1，100]

{  
  "data": [
    {
      "id": 29553,
      "order-id": 59378,
      "match-id": 59335,
      "symbol": "ethusdt",
      "type": "buy-limit",
      "source": "api",
      "price": "100.1000000000",
      "filled-amount": "9.1155000000",
      "filled-fees": "0.0182310000",
      "created-at": 1494901400435,
      "trade-id": 100282808529,
      "role": taker,
      "filled-points": "0.0",
      "fee-deduct-currency": ""
    }
    ...
  ]
}

响应数据

返回的主数据对象为一个对象数组，其中每一个元件代表一个交易结果。

参数名称	是否必须	数据类型	描述	取值范围
created-at	true	long	成交时间
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
role	true	string	成交角色	maker,taker
filled-points	true	string	抵扣数量（可为ht或hbpoint）
fee-deduct-currency	true	string	抵扣类型	ht,hbpoint

start-date, end-date相关错误码

错误码	对应错误场景
invalid_interval	start date小于end date; 或者 start date 与end date之间的时间间隔大于2天
invalid_start_date	start date是一个61天之前的日期；或者start date是一个未来的日期
invalid_end_date	end date 是一个61天之前的日期；或者end date是一个未来的日期

获取用户当前手续费率

Api用户查询交易对费率，一次限制最多查10个交易对，子用户的费率和母用户保持一致

API Key 权限：读取

curl "https://api.huobi.pro/v1/fee/fee-rate/get?symbols=btcusdt,ethusdt,ltcusdt"

HTTP 请求

GET /v1/fee/fee-rate/get

请求参数

参数	数据类型	是否必须	默认值	描述	取值范围
symbols	string	true	NA	交易对，可多填，逗号分隔	如"btcusdt,ethusdt"

{
  "status": "ok",
  "data": [
     {
        "symbol": "btcusdt",
        "maker-fee":"0.0001",
        "taker-fee":"0.0002"
     },
     {
        "symbol": "ethusdt",
        "maker-fee":"0.002",
        "taker-fee":"0.002"
    },
     {
        "symbol": "ltcusdt",
        "maker-fee":"0.0015",
        "taker-fee":"0.0018"
    }
  ]
}

响应数据

字段名称	数据类型	是否强制	描述
status	string	Y	响应状态
err-code	string	N	响应码
err-msg	string	N	响应信息
data	list	Y	交易对费率列表

List

属性	数据类型	说明
symbol	string	交易对
maker-fee	string	挂单手续费率
taker-fee	string	吃单手续费率

响应码

响应码	说明	类型	备注
base-symbol-error	无效的交易对	string	-
base-too-many-symbol	最大支持 10 个交易对	string	-

借贷（逐仓杠杆）

访问借贷相关的接口需要进行签名认证。目前逐仓杠杆交易仅支持部分以 USDT，HSUD，和 BTC 为报价币种的交易对。

资产划转

API Key 权限：交易

此接口用于现货账户与逐仓杠杆账户的资产互转。

从现货账户划转至逐仓杠杆账户 transfer-in，从逐仓杠杆账户划转至现货账户 transfer-out

HTTP 请求

POST /v1/dw/transfer-in/margin
POST /v1/dw/transfer-out/margin

{
  "symbol": "ethusdt",
  "currency": "eth",
  "amount": "1.0"
}

请求参数

参数名称	数据类型	是否必需	默认值	描述
symbol	string	true	NA	交易对, e.g. btcusdt, ethbtc
currency	string	true	NA	币种
amount	string	true	NA	划转数量

{  
  "data": 1000
}

响应数据

参数名称	数据类型	描述
data	integer	Transfer id

申请借贷

API Key 权限：交易

此接口用于申请借贷.

HTTP 请求

POST /v1/margin/orders

{
  "symbol": "ethusdt",
  "currency": "eth",
  "amount": "1.0"
}

请求参数

参数名称	数据类型	是否必需	默认值	描述
symbol	string	true	NA	交易对, e.g. btcusdt, �ethbtc
currency	string	true	NA	币种
amount	string	true	NA	借贷数量

{  
  "data": 1000
}

响应数据

字段名称	数据类型	描述
data	integer	Margin order id

归还借贷

API Key 权限：交易

此接口用于归还借贷.

HTTP 请求

POST /v1/margin/orders/{order-id}/repay

{
  "amount": "1.0"
}

请求参数

参数名称	数据类型	是否必需	描述
order-id	string	true	借贷订单 ID，写在 url path 中
amount	string	true	归还币种数量

{  
  "data": 1000
}

响应数据

参数名称	数据类型	描述
data	integer	Margin order id

查询借贷订单

API Key 权限：读取

此接口基于指定搜索条件返回借贷订单。

HTTP 请求

GET /v1/margin/loan-orders

请求参数

参数名称	是否必须	类型	描述	默认值	取值范围
symbol	true	string	交易对
start-date	false	string	查询开始日期, 日期格式yyyy-mm-dd
end-date	false	string	查询结束日期, 日期格式yyyy-mm-dd
states	false	string	状态
from	false	string	查询起始 ID
direct	false	string	查询方向		prev 向前，时间（或 ID）正序；next 向后，时间（或 ID）倒序）
size	false	string	查询记录大小
sub-uid	false	int	子用户编号（母用户查询子用户借贷订单时，此字段必填）	如不填，缺省查询当前用户借贷订单

{  
  "data": [
    {
      "loan-balance": "0.100000000000000000",
      "interest-balance": "0.000200000000000000",
      "interest-rate": "0.002000000000000000",
      "loan-amount": "0.100000000000000000",
      "accrued-at": 1511169724531,
      "interest-amount": "0.000200000000000000",
      "symbol": "ethbtc",
      "currency": "btc",
      "id": 394,
      "state": "accrual",
      "account-id": 17747,
      "user-id": 119913,
      "created-at": 1511169724531
    }
  ]
}

响应数据

字段名称	是否必须	数据类型	描述	取值范围
id	true	long	订单号
user-id	true	long	用户ID
account-id	true	long	账户ID
symbol	true	string	交易对
currency	true	string	币种
loan-amount	true	string	借贷本金总额
loan-balance	true	string	未还本金
interest-rate	true	string	利率
interest-amount	true	string	利息总额
interest-balance	true	string	未还利息
created-at	true	long	借贷发起时间
accrued-at	true	long	最近一次计息时间
state	true	string	订单状态	created 未放款，accrual 已放款，cleared 已还清，invalid 异常

借贷账户详情

API Key 权限：读取

此接口返回借贷账户详情。

HTTP 请求

GET /v1/margin/accounts/balance

{
   "symbol": "ethusdt"
}

请求参数

参数名称	是否必须	类型	描述	默认值	取值范围
symbol	false	string	交易对，作为get参数
sub-uid	false	int	子用户编号（母用户查询子用户借贷详情时，此字段必填）	如不填，缺省查询当前用户借贷详情

{  
  "data": [
    {
      "id": 18264,
      "type": "margin",
      "state": "working",
      "symbol": "btcusdt",
      "fl-price": "0",
      "fl-type": "safe",
      "risk-rate": "475.952571086994250554",
      "list": [
          {
              "currency": "btc",
              "type": "trade",
              "balance": "1168.533000000000000000"
          },
          {
              "currency": "btc",
              "type": "frozen",
              "balance": "0.000000000000000000"
          },
          {
              "currency": "btc",
              "type": "loan",
              "balance": "-2.433000000000000000"
          },
          {
              "currency": "btc",
              "type": "interest",
              "balance": "-0.000533000000000000"
          },
          {
              "currency": "btc",
              "type": "transfer-out-available",//可转btc
              "balance": "1163.872174670000000000"
          },
          {
              "currency": "btc",
              "type": "loan-available",//可借btc
              "balance": "8161.876538350676000000"
          }
      ]
    }
  ]
}

响应数据

字段名称	是否必须	数据类型	描述	取值范围
symbol	true	string	交易对
state	true	string	账户状态	working,fl-sys,fl-mgt,fl-end
risk-rate	true	string	风险率
fl-price	true	string	爆仓价
list	true	array	借贷账户详情列表

借贷（全仓杠杆）

访问借贷相关的接口需要进行签名认证。目前全仓杠杆交易仅支持部分以 USDT 和 BTC 为报价币种的交易对。

资产划转

API Key 权限：交易

此接口用于现货账户与全仓杠杆账户的资产互转。

从现货账户划转至全仓杠杆账户 transfer-in，从全仓杠杆账户划转至现货账户 transfer-out

HTTP 请求

POST /v1/cross-margin/transfer-in
POST /v1/cross-margin/transfer-out

{
  "currency": "eth",
  "amount": "1.0"
}

请求参数

参数名称	数据类型	是否必需	默认值	描述
currency	string	true	NA	币种
amount	string	true	NA	划转数量

{  
  "status": "ok",
  "data": 1000
}

响应数据

参数名称	数据类型	描述
data	integer	Transfer id

查询借贷利率

API Key 权限：读取

此接口返回用户级别的借贷利率。

HTTP 请求

GET /v1/cross-margin/interest-rate

请求参数

Null

{
    "status": "ok",
    "data": [
        {
            "currency": "bch",
            "interest-rate": "0.001"
        },
        {
            "currency": "btc",
            "interest-rate": "0.001"
        },
        {
            "currency": "eos",
            "interest-rate": "0.001"
        },
        {
            "currency": "eth",
            "interest-rate": "0.001"
        },
        {
            "currency": "ltc",
            "interest-rate": "0.001"
        },
        {
            "currency": "usdt",
            "interest-rate": "0.001"
        },
        {
            "currency": "xrp",
            "interest-rate": "0.001"
        }
    ]
}

响应数据

参数名称	数据类型	描述
currency	string	币种
interest-rate	string	借贷利率

申请借贷

API Key 权限：交易

此接口用于申请借贷.

HTTP 请求

POST /v1/cross-margin/orders

{
  "currency": "eth",
  "amount": "1.0"
}

请求参数

参数名称	数据类型	是否必需	默认值	描述
currency	string	true	NA	币种
amount	string	true	NA	借贷数量

{  
  "status": "ok",
  "data": 1000
}

响应数据

字段名称	数据类型	描述
data	integer	Margin order id

归还借贷

API Key 权限：交易

此接口用于归还借贷.

HTTP 请求

POST /v1/cross-margin/orders/{order-id}/repay

{
  "amount": "1.0"
}

请求参数

参数名称	数据类型	是否必需	描述
order-id	string	true	借贷订单 ID，写在 url path 中
amount	string	true	归还币种数量

{  
  "status": "ok",
  "data": null
}

响应数据

参数名称	数据类型	描述
data	null	-

查询借贷订单

API Key 权限：读取

此接口基于指定搜索条件返回借贷订单。

HTTP 请求

GET /v1/cross-margin/loan-orders

请求参数

参数名称	是否必须	类型	描述	默认值	取值范围
start-date	false	string	查询开始日期, 日期格式yyyy-mm-dd
end-date	false	string	查询结束日期, 日期格式yyyy-mm-dd
currency	false	string	币种
state	false	string	状态	all	created 未放款，accrual 已放款，cleared 已还清，invalid 异常
from	false	string	查询起始 ID	0
direct	false	string	查询方向		prev 向前，时间（或 ID）正序；next 向后，时间（或 ID）倒序）
size	false	string	查询记录大小	10	[10,100]

{  
  "status": "ok",
  "data": [
    {
      "loan-balance": "0.100000000000000000",
      "interest-balance": "0.000200000000000000",
      "loan-amount": "0.100000000000000000",
      "accrued-at": 1511169724531,
      "interest-amount": "0.000200000000000000",
      "filled-points" : "0.2",
      "filled-ht" : "0.2",
      "currency": "btc",
      "id": 394,
      "state": "accrual",
      "account-id": 17747,
      "user-id": 119913,
      "created-at": 1511169724531
    }
  ]
}

响应数据

字段名称	是否必须	数据类型	描述	取值范围
id	true	long	订单号
user-id	true	long	用户ID
account-id	true	long	账户ID
currency	true	string	币种
loan-amount	true	string	借贷本金总额
loan-balance	true	string	未还本金
interest-amount	true	string	利息总额
interest-balance	true	string	未还利息
filled-points	true	string	点卡抵扣数量
filled-ht	true	string	HT抵扣数量
created-at	true	long	借贷发起时间
accrued-at	true	long	最近一次计息时间
state	true	string	订单状态	created 未放款，accrual 已放款，cleared 已还清，invalid 异常

借贷账户详情

API Key 权限：读取

此接口返回借贷账户详情。

HTTP 请求

GET /v1/cross-margin/accounts/balance

请求参数

无

{  
  "status": "ok",
  "data": [
    {
      "id": 18264,
      "type": "cross-margin",
      "state": "working",
      "risk-rate": "1000",
      "acct-balance-sum": "12312.123123",
      "debt-balance-sum": "1231.2123123",
      "list": [
          {
              "currency": "btc",
              "type": "trade",
              "balance": "1168.533000000000000000"
          },
          {
              "currency": "btc",
              "type": "frozen",
              "balance": "0.000000000000000000"
          },
          {
              "currency": "btc",
              "type": "loan",
              "balance": "-2.433000000000000000"
          },
          {
              "currency": "btc",
              "type": "interest",
              "balance": "-0.000533000000000000"
          },
          {
              "currency": "btc",
              "type": "transfer-out-available",//可转btc
              "balance": "1163.872174670000000000"
          },
          {
              "currency": "btc",
              "type": "loan-available",//可借btc
              "balance": "8161.876538350676000000"
          }
      ]
    }
  ]
}

响应数据

字段名称	是否必须	数据类型	描述	取值范围
id	true	integer	Account ID 账户编号
type	true	integer	账户类型 (margin or cross-margin)	cross-margin
state	true	string	账户状态	working,fl-sys,fl-end,fl-negative
risk-rate	true	string	风险率
acct-balance-sum	true	string	总持有usdt折合
debt-balance-sum	true	string	总负债usdt折合
list	true	array	借贷账户详情列表
{ currency	true	string	币种
type	true	string	账户类型	trade,frozen,loan,interest,transfer-out-available,loan-available
balance }	true	string	余额（注：当type= transfer-out-available时，如果balance=-1，意味着该币种余额可全部转出）

Websocket行情数据

简介

接入URL

Global站行情请求地址

wss://api.huobi.pro/ws

wss://api-aws.huobi.pro/ws

注：api-aws.huobi.pro域名对使用aws云服务的用户做了一定的链路延迟优化。

请使用中国大陆以外的服务器访问火币 API

数据压缩

WebSocket API 返回的所有数据都进行了 GZIP 压缩，需要 client 在收到数据之后解压。

心跳消息

当用户的Websocket客户端连接到火币Websocket服务器后，服务器会定期（当前设为5秒）向其发送ping消息并包含一整数值如下：

当用户的Websocket客户端接收到此心跳消息后，应返回pong消息并包含同一整数值：

当Websocket服务器连续两次发送了`ping`消息却没有收到任何一次`pong`消息返回后，服务器将主动断开与此客户端的连接。

订阅主题

成功建立与Websocket服务器的连接后，Websocket客户端发送如下请求以订阅特定主题：

{
  "sub": "market.btccny.kline.1min",
  "id": "id1"
}

{ "sub": "topic to sub", "id": "id generate by client" }

成功订阅后，Websocket客户端将收到确认：

{
  "id": "id1",
  "status": "ok",
  "subbed": "market.btccny.kline.1min",
  "ts": 1489474081631
}

之后, 一旦所订阅的主题有更新，Websocket客户端将收到服务器推送的更新消息（push）：

{
  "ch": "market.btccny.kline.1min",
  "ts": 1489474082831,
  "tick": {
    "id": 1489464480,
    "amount": 0.0,
    "count": 0,
    "open": 7962.62,
    "close": 7962.62,
    "low": 7962.62,
    "high": 7962.62,
    "vol": 0.0
  }
}

取消订阅

取消订阅的格式如下：

{
  "unsub": "market.btccny.trade.detail",
  "id": "id4"
}

{ "unsub": "topic to unsub", "id": "id generate by client" }

取消订阅成功确认：

{
  "id": "id4",
  "status": "ok",
  "unsubbed": "market.btccny.trade.detail",
  "ts": 1494326028889
}

请求数据

Websocket服务器同时支持一次性请求数据（pull）。

请求数据的格式如下：

{
  "req": "market.ethbtc.kline.1min",
  "id": "id10"
}

{ "req": "topic to req", "id": "id generate by client" }

一次性返回的数据：

{
  "status": "ok",
  "rep": "market.btccny.kline.1min",
  "data": [
    {
      "amount": 1.6206,
      "count":  3,
      "id":     1494465840,
      "open":   9887.00,
      "close":  9885.00,
      "low":    9885.00,
      "high":   9887.00,
      "vol":    16021.632026
    },
    {
      "amount": 2.2124,
      "count":  6,
      "id":     1494465900,
      "open":   9885.00,
      "close":  9880.00,
      "low":    9880.00,
      "high":   9885.00,
      "vol":    21859.023500
    }
  ]
}

K线数据

主题订阅

一旦K线数据产生，Websocket服务器将通过此订阅主题接口推送至客户端：

market.$symbol$.kline.$period$

{
  "sub": "market.ethbtc.kline.1min",
  "id": "id1"
}

参数

参数	数据类型	是否必需	描述	取值范围
symbol	string	true	交易代码	All supported trading symbols, e.g. btcusdt, bccbtc
period	string	true	K线周期	1min, 5min, 15min, 30min, 60min, 4hour, 1day, 1mon, 1week, 1year

{
  "id": "id1",
  "status": "ok",
  "subbed": "market.ethbtc.kline.1min",
  "ts": 1489474081631
}

{
  "ch": "market.ethbtc.kline.1min",
  "ts": 1489474082831,
  "tick": {
    "id": 1489464480,
    "amount": 0.0,
    "count": 0,
    "open": 7962.62,
    "close": 7962.62,
    "low": 7962.62,
    "high": 7962.62,
    "vol": 0.0
  }
}

数据更新字段列表

字段	数据类型	描述
id	integer	unix时间，同时作为K线ID
amount	float	成交量
count	integer	成交笔数
open	float	开盘价
close	float	收盘价（当K线为最晚的一根时，是最新成交价）
low	float	最低价
high	float	最高价
vol	float	成交额, 即 sum(每一笔成交价 * 该笔的成交量)

当symbol被设为“hb10”或“huobi10”时，amount，count，vol均为零值。

数据请求

用请求方式一次性获取K线数据需要额外提供以下参数：（每次最多返回300条）

{
  "req": "market.$symbol.kline.$period",
  "id": "id generated by client",
  "from": "from time in epoch seconds",
  "to": "to time in epoch seconds"
}

参数	数据类型	是否必需	缺省值	描述	取值范围
from	integer	false	1501174800(2017-07-28T00:00:00+08:00)	起始时间 (epoch time in second)	[1501174800, 2556115200]
to	integer	false	2556115200(2050-01-01T00:00:00+08:00)	结束时间 (epoch time in second)	[1501174800, 2556115200] or ($from, 2556115200] if "from" is set

市场深度行情数据

此主题发送最新市场深度快照。快照频率为每秒1次。

主题订阅

market.$symbol.depth.$type

{
  "sub": "market.btcusdt.depth.step0",
  "id": "id1"
}

参数

参数	数据类型	是否必需	缺省值	描述	取值范围
symbol	string	true	NA	交易代码	All supported trading symbols, e.g. btcusdt, bccbtc
type	string	true	step0	合并深度类型	step0, step1, step2, step3, step4, step5

"type" 合并深度类型

Value	Description
step0	不合并深度
step1	Aggregation level = precision*10
step2	Aggregation level = precision*100
step3	Aggregation level = precision*1000
step4	Aggregation level = precision*10000
step5	Aggregation level = precision*100000

当type值为‘step0’时，默认深度为150档; 当type值为‘step1’,‘step2’,‘step3’,‘step4’,‘step5’时，默认深度为20档。

{
  "id": "id1",
  "status": "ok",
  "subbed": "market.btcusdt.depth.step0",
  "ts": 1489474081631
}

{
  "ch": "market.htusdt.depth.step0",
  "ts": 1572362902027,
  "tick": {
    "bids": [
      [3.7721, 344.86],// [price, quote volume]
      [3.7709, 46.66] 
    ],
    "asks": [
      [3.7745, 15.44],
      [3.7746, 70.52]
    ],
    "version": 100434317651,
    "ts": 1572362902012
  }
}

数据更新字段列表

在'tick'object下方呈现买盘卖盘深度列表

字段	数据类型	描述
bids	object	当前的所有买单 [price, quote volume]
asks	object	当前的所有卖单 [price, quote volume]
version	integer	内部字段
ts	integer	北京时间的时间戳，单位毫秒

当symbol被设为"hb10"时，amount, count, vol均为零值

数据请求

支持数据请求方式一次性获取市场深度数据：

{
  "req": "market.btcusdt.depth.step0",
  "id": "id10"
}

买一卖一逐笔行情

当买一价、买一量、卖一价、卖一量，其中任一数据发生变化时，此主题推送逐笔更新。

主题订阅

market.$symbol.bbo

{
  "sub": "market.btcusdt.bbo",
  "id": "id1"
}

参数

参数	数据类型	是否必需	缺省值	描述	取值范围
symbol	string	true	NA	交易代码	All supported trading symbols, e.g. btcusdt, bccbtc

{
  "id": "id1",
  "status": "ok",
  "subbed": "market.btcusdt.bbo",
  "ts": 1489474081631
}

{
  "ch": "market.btcusdt.bbo",
  "ts": 1489474082831,
  "tick": {
    "symbol": "btcusdt",
    "quoteTime": "1489474082811",
    "bid": "10008.31",
    "bidSize": "0.01",
    "ask": "10009.54",
    "askSize": "0.3"
  }
}

数据更新字段列表

字段	数据类型	描述
symbol	string	交易代码
quoteTime	long	盘口更新时间
bid	float	买一价
bidSize	float	买一量
ask	float	卖一价
askSize	float	卖一量

成交明细

主题订阅

此主题提供市场最新成交逐笔明细。

market.$symbol.trade.detail

{
  "sub": "market.btcusdt.trade.detail",
  "id": "id1"
}

参数

参数	数据类型	是否必需	缺省值	描述	取值范围
symbol	string	true	NA	交易代码	All supported trading symbols, e.g. btcusdt, bccbtc

{
  "id": "id1",
  "status": "ok",
  "subbed": "market.btcusdt.trade.detail",
  "ts": 1489474081631
}

{
  "ch": "market.btcusdt.trade.detail",
  "ts": 1489474082831,
  "tick": {
        "id": 14650745135,
        "ts": 1533265950234,
        "data": [
            {
                "amount": 0.0099,
                "ts": 1533265950234,
                "id": 146507451359183894799,
                "tradeId": 102043494568,
                "price": 401.74,
                "direction": "buy"
            }
            // more Trade Detail data here
        ]
  }
}

数据更新字段列表

字段	数据类型	描述
id	integer	唯一成交ID（将被废弃）
tradeId	integer	唯一成交ID（NEW）
amount	float	成交量
price	float	成交价
ts	integer	成交时间 (UNIX epoch time in millisecond)
direction	string	成交主动方 (taker的订单方向) : 'buy' or 'sell'

数据请求

支持数据请求方式一次性获取成交明细数据（仅能获取最多最近300个成交记录）：

{
  "req": "market.btcusdt.trade.detail",
  "id": "id11"
}

市场概要

主题订阅

此主题提供24小时内最新市场概要快照。快照频率不超过每秒10次。

market.$symbol.detail

{
  "sub": "market.btcusdt.detail",
  "id": "id1"
}

参数

参数	数据类型	是否必需	缺省值	描述	取值范围
symbol	string	true	NA	交易代码	All supported trading symbols, e.g. btcusdt, bccbtc

{
  "id": "id1",
  "status": "ok",
  "subbed": "market.btcusdt.detail",
  "ts": 1489474081631
}

  "tick": {
    "amount": 12224.2922,
    "open":   9790.52,
    "close":  10195.00,
    "high":   10300.00,
    "ts":     1494496390000,
    "id":     1494496390,
    "count":  15195,
    "low":    9657.00,
    "vol":    121906001.754751
  }

数据更新字段列表

字段	数据类型	描述
id	integer	unix时间，同时作为消息ID
ts	integer	unix系统时间
amount	float	24小时成交量
count	integer	24小时成交笔数
open	float	24小时开盘价
close	float	最新价
low	float	24小时最低价
high	float	24小时最高价
vol	float	24小时成交额

数据请求

支持数据请求方式一次性获取市场概要数据：

{
  "req": "market.btcusdt.detail",
  "id": "id11"
}

Websocket资产及订单

简介

接入URL

Websocket资产及订单

wss://api.huobi.pro/ws/v1

wss://api-aws.huobi.pro/ws/v1

注：api-aws.huobi.pro域名对使用aws云服务的用户做了一定的链路延迟优化。

请使用中国大陆以外的服务器访问火币 API。

数据压缩

WebSocket API 返回的所有数据都进行了 GZIP 压缩，需要 client 在收到数据之后解压。

心跳消息

2019/07/08之后

当用户的Websocket客户端连接到火币Websocket服务器后，服务器会定期（当前设为20秒）向其发送ping消息并包含一整数值如下：

当用户的Websocket客户端接收到此心跳消息后，应返回pong消息并包含同一整数值：

当Websocket服务器连续三次发送了`ping`消息却没有收到任何一次`pong`消息返回后，服务器将主动断开与此客户端的连接。

2019/07/08之前

当用户的Websocket客户端连接到火币Websocket服务器后，服务器会定期（设为30秒）向其发送ping消息并包含一整数值如下：

当用户的Websocket客户端接收到此心跳消息后，应返回pong消息并包含同一整数值：

当Websocket服务器连续两次发送了`ping`消息却没有收到任何一次`pong`消息返回后，服务器将主动断开与此客户端的连接。

订阅主题

成功建立与Websocket服务器的连接后，Websocket客户端发送如下请求以订阅特定主题：

{
  "op": "operation type, 'sub' for subscription, 'unsub' for unsubscription",
  "topic": "topic to sub",
  "cid": "id generate by client"
}

成功订阅后，Websocket客户端将收到确认：

{
  "op": "operation type, refer to the operation which triggers this response",
  "cid": "id1",
  "error-code": 0, // 0 for no error
  "topic": "topic to sub if the op is sub",
  "ts": 1489474081631
}

之后, 一旦所订阅的主题有更新，Websocket客户端将收到服务器推送的更新消息（push）：

{
  "op": "notify",
  "topic": "topic of this notify",
  "ts": 1489474082831,
  "data": {
    // data of specific topic update
  }
}

取消订阅

取消订阅的格式如下：

{
  "op": "unsub",
  "topic": "accounts",
  "cid": "client generated id"
}

取消订阅成功确认：

{
  "op": "unsub",
  "topic": "accounts",
  "cid": "id generated by client",
  "err-code": 0,
  "ts": 1489474081631
}

请求数据

Websocket服务器同时支持一次性请求数据（pull）。

当与Websocket服务器成功建立连接后，以下三个主题可供用户请求：

accounts.list
orders.list
orders.detail

具体请求方式请见后文。

限频

数据请求（sub）限频规则

限频规则基于API key而不是连接。当sub数量超出限值时，Websocket客户端将收到"too many request"错误码。具体规则如下：

单个连接每秒最多50次sub和50次unsub。单个连接sub总量限制100个，sub总量达到限额后不允许再sub，但每次unsub可以减少sub总量的计数。比如：30个sub后unsub 1个，此时sub总量count为29，还有71个sub总量可用。

数据请求（req）限频规则

限频规则基于API key而不是连接。当请求频率超出限值时，Websocket客户端将收到"too many request"错误码。以下为各主题当前限频设定：

accounts.list: once every 2 seconds
orders.list AND orders.detail: once every 5 seconds

鉴权

资产及订单主题鉴权请求数据格式如下：

{
  "op": "auth",
  "AccessKeyId": "e2xxxxxx-99xxxxxx-84xxxxxx-7xxxx",
  "SignatureMethod": "HmacSHA256",
  "SignatureVersion": "2",
  "Timestamp": "2017-05-11T15:19:30",
  "Signature": "4F65x5A2bLyMWVQj3Aqp+B4w+ivaA7n5Oi2SuYtCJ9o=",
}

鉴权请求数据格式说明

filed	type	instruction
op	string	必填；操作名称，鉴权固定值为 auth；
cid	string	选填；Client 请求唯一 ID
AccessKeyId	string	必填；API 访问密钥, 您申请的 APIKEY 中的 AccessKey
SignatureMethod	string	必填；签名方法, 用户计算签名的基于哈希的协议，此处使用 HmacSHA256
SignatureVersion	string	必填；签名协议的版本，此处使用 2
Timestamp	string	必填；时间戳, 您发出请求的时间 (UTC 时区) (UTC 时区) (UTC 时区) 。在查询请求中包含此值有助于防止第三方截取您的请求。如：2017-05-11T16:22:06。再次强调是 (UTC 时区)
Signature	string	必填；签名, 计算得出的值，用于确保签名有效和未被篡改

订阅账户更新

API Key 权限：读取

订阅账户资产变动更新。

主题订阅

accounts

{
  "op": "sub",
  "cid": "40sG903yz80oDFWr",
  "topic": "accounts",
  "model": "0"
}

参数

参数	数据类型	是否必需	缺省值	描述	取值范围
model	string	false	0	是否包含已冻结余额	1 to include frozen balance, 0 to not

如果同时订阅可用和总余额，需要为 0 和 1 各开启一条websocket连接

{
  "op": "sub",
  "cid": "40sG903yz80oDFWr",
  "err-code": 0,
  "ts": 1489474081631,
  "topic": "accounts"
}

{
  "op": "notify",
  "ts": 1522856623232,
  "topic": "accounts",
  "data": {
    "event": "order.place",
    "list": [
      {
        "account-id": 419013,
        "currency": "usdt",
        "type": "trade",
        "balance": "500009195917.4362872650"
      }
    ]
  }
}

数据更新字段列表

字段	数据类型	描述
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时，该余额为总余额）

订阅订单更新

API Key 权限：读取

订阅账户下的订单更新。

主题订阅

orders.$symbol

{
  "op": "sub",
  "cid": "40sG903yz80oDFWr",
  "topic": "orders.htusdt",
}

参数

参数	数据类型	是否必需	缺省值	描述	取值范围
symbol	string	true	NA	交易代码	All supported trading symbols, e.g. btcusdt, bccbtc. 支持通配符"*".

{
  "op": "sub",
  "cid": "40sG903yz80oDFWr",
  "err-code": 0,
  "ts": 1489474081631,
  "topic": "orders.htusdt"
}

{
  "op": "notify",
  "topic": "orders.htusdt",
  "ts": 1522856623232,
  "data": {
    "seq-id": 94984,
    "order-id": 2039498445,
    "symbol": "htusdt",
    "account-id": 100077,
    "order-amount": "5000.000000000000000000",
    "order-price": "1.662100000000000000",
    "created-at": 1522858623622,
    "order-type": "buy-limit",
    "order-source": "api",
    "order-state": "filled",
    "role": "taker|maker",
    "price": "1.662100000000000000",
    "filled-amount": "5000.000000000000000000",
    "unfilled-amount": "0.000000000000000000",
    "filled-cash-amount": "8301.357280000000000000",
    "filled-fees": "8.000000000000000000"
  }
}

数据更新字段列表

字段	数据类型	描述
seq-id	integer	流水号(不连续)
order-id	integer	订单 id
symbol	string	交易对
account-id	string	账户 id
order-amount	string	订单数量
order-price	string	订单价格
created-at	int	订单创建时间 (UNIX epoch time in millisecond)
order-type	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
order-source	string	订单来源, 有效取值: sys, web, api, app
order-state	string	订单状态, 有效取值: submitted, partial-filled, filled, canceled, partial-canceled
role	string	成交角色: taker or maker
price	string	成交价格
filled-amount	string	单次成交数量
unfilled-amount	string	单次未成交数量
filled-cash-amount	string	单次成交金额
filled-fees	string	单次成交手续费（买入为币，卖出为钱）

订阅订单更新 (NEW)

API Key 权限：读取

相比现有用户订单更新推送主题“orders.$symbol”，新增主题“orders.$symbol.update”拥有更低的数据延迟以及更准确的消息顺序。建议API用户订阅此新主题接收订单更新推送，以替代现有订阅主题 “orders.$symbol”。（现有订阅主题 “orders.$symbol”仍将在Websocket API服务中被保留直至另行通知。）

主题订阅

orders.$symbol.update

{
  "op": "sub",
  "cid": "40sG903yz80oDFWr",
  "topic": "orders.htusdt.update"
}

参数

参数	数据类型	是否必需	缺省值	描述	取值范围
symbol	string	true	NA	交易代码	All supported trading symbols, e.g. btcusdt, bccbtc. 支持通配符"*".

{
  "op": "sub",
  "ts": 1489474081631,
  "topic": "orders.htusdt.update",
  "err-code": 0,
  "cid": "40sG903yz80oDFWr"  
}

{
  "op": "notify",
  "ts": 1522856623232,
  "topic": "orders.htusdt.update",  
  "data": {
    "unfilled-amount": "0.000000000000000000",
    "filled-amount": "5000.000000000000000000",
    "price": "1.662100000000000000",
    "order-id": 2039498445,
    "symbol": "htusdt",
    "match-id": 94984,
    "filled-cash-amount": "8301.357280000000000000",
    "role": "taker|maker",
    "order-state": "filled",
    "client-order-id": "a0001",
    "order-type": "buy-limit"
  }
}

数据更新字段列表

Field	Data Type	Description
match-id	integer	最近撮合编号（当order-state = submitted, canceled, partial-canceled时，match-id 为消息序列号；当order-state = filled, partial-filled 时，match-id 为最近撮合编号。）
order-id	integer	订单编号
symbol	string	交易代码
order-state	string	订单状态, 有效取值: submitted, partial-filled, filled, canceled, partial-canceled
role	string	最近成交角色（当order-state = submitted, canceled, partial-canceled时，role 为缺省值taker；当order-state = filled, partial-filled 时，role 取值为taker 或maker。）
price	string	最新价（当order-state = submitted 时，price 为订单价格；当order-state = canceled, partial-canceled 时，price 为零；当order-state = filled, partial-filled 时，price 为最近成交价。）
filled-amount	string	最近成交数量
filled-cash-amount	string	最近成交数额
unfilled-amount	string	最近未成交数量（当order-state = submitted 时，unfilled-amount 为原始订单量；当order-state = canceled OR partial-canceled 时，unfilled-amount 为未成交数量；当order-state = filled 时，如果 order-type = buy-market，unfilled-amount 可能为一极小值；如果order-type <> buy-market 时，unfilled-amount 为零；当order-state = partial-filled AND role = taker 时，unfilled-amount 为未成交数量；当order-state = partial-filled AND role = maker 时，unfilled-amount 为未成交数量。）
client-order-id	string	用户自编订单号
order-type	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

请求用户资产数据

API Key 权限：读取

查询当前用户的所有账户余额数据。

数据请求

accounts.list

{
  "op": "req",
  "cid": "40sG903yz80oDFWr",
  "topic": "accounts.list",
}

成功建立和 WebSocket API 的连接之后，向 Server发送如下格式的数据来查询账户数据：

参数	数据类型	描述
op	string	必填；操作名称，固定值为 req
cid	string	选填；Client 请求唯一 ID
topic	string	必填；固定值为accounts.list

返回

    {
      "op": "req",
      "topic": "accounts.list",
      "cid": "40sG903yz80oDFWr",
      "err-code": 0,
      "ts": 1489474082831,
      "data": [
        {
          "id": 419013,
          "type": "spot",
          "state": "working",
          "list": [
            {
              "currency": "usdt",
              "type": "trade",
              "balance": "500009195917.4362872650"
            },
            {
              "currency": "usdt",
              "type": "frozen",
              "balance": "9786.6783000000"
            }
          ]
        },
        {
          "id": 35535,
          "type": "point",
          "state": "working",
          "list": [
            {
              "currency": "eth",
              "type": "trade",
              "balance": "499999894616.1302471000"
            },
            {
              "currency": "eth",
              "type": "frozen",
              "balance": "9786.6783000000"
            }
          ]
        }
      ]
    }

    {
      "op": "req",
      "topic": "foo.bar",
      "cid": "40sG903yz80oDFWr",
      "err-code": 12001, //Response codes,0  represent success;others value  is error,the list of Response codes is in appendix
      "err-msg": "detail of error message",
      "ts": 1489474081631
    }

字段	数据类型	描述
{ id	long	账户ID
type	string	账户类型
state	string	账户状态
list	string	账户列表
{currency	string	子账户币种
type	string	子账户类型
balance }}	string	子账户余额

请求当前及历史订单

API Key 权限：读取

根据设定条件查询当前委托、历史委托。

数据请求

order.list

{
  "op": "req",
  "topic": "orders.list",
  "cid": "40sG903yz80oDFWr",
  "symbol": "htusdt",
  "states": "submitted,partial-filled"
}

参数

参数	数据类型	是否必需	缺省值	描述	取值范围
account-id	int	true	NA	账户 id	NA
symbol	string	true	NA	交易对	All supported trading symbols, e.g. btcusdt, bccbtc
types	string	false	NA	查询的订单类型组合，使用','分割	buy-market, sell-market, buy-limit, sell-limit, buy-ioc, sell-ioc， buy-limit-maker, sell-limit-maker, buy-stop-limit，sell-stop-limit
states	string	true	NA	查询的订单状态组合，使用','分割	submitted, partial-filled, partial-canceled, filled, canceled，created
start-date	string	false	-61d	查询开始日期, 日期格式yyyy-mm-dd	NA
end-date	string	false	today	查询结束日期, 日期格式yyyy-mm-dd	NA
from	string	false	NA	查询起始 ID	NA
direct	string	false	next	查询方向	next, prev
size	string	false	100	查询记录大小	[1, 100]

数据更新字段列表

{
  "op": "req",
  "topic": "orders.list",
  "cid": "40sG903yz80oDFWr",
  "err-code": 0,
  "ts": 1522856623232,
  "data": [
    {
      "id": 2039498445,
      "symbol": "htusdt",
      "account-id": 100077,
      "amount": "5000.000000000000000000",
      "price": "1.662100000000000000",
      "created-at": 1522858623622,
      "type": "buy-limit",
      "filled-amount": "5000.000000000000000000",
      "filled-cash-amount": "8301.357280000000000000",
      "filled-fees": "8.000000000000000000",
      "finished-at": 1522858624796,
      "source": "api",
      "state": "filled",
      "canceled-at": 0
    }
  ]
}

字段	数据类型	描述
id	long	订单ID
symbol	string	交易对
account-id	long	账户ID
amount	string	订单数量
price	string	订单价格
created-at	long	订单创建时间
type	string	订单类型，请参考订单类型说明
filled-amount	string	已成交数量
filled-cash-amount	string	已成交总金额
filled-fees	string	已成交手续费
finished-at	string	最后成交时间
source	string	订单来源，请参考订单来源说明
state	string	订单状态，请参考订单状态说明
cancel-at	long	撤单时间
stop-price	string	止盈止损订单触发价格
operator	string	止盈止损订单触发价运算符

以订单编号请求订单

API Key 权限：读取

以订单编号请求订单数据

数据请求

orders.detail

{
  "op": "req",
  "topic": "orders.detail",
  "order-id": "2039498445",
  "cid": "40sG903yz80oDFWr"
}

参数

参数	是否必需	数据类型	描述
op	true	string	操作名称，固定值为 req
cid	true	string	Client 请求唯一 ID
topic	false	string	固定值为 orders.detail
order-id	true	string	订单ID

返回

{
  "op": "req",
  "topic": "orders.detail",
  "cid": "40sG903yz80oDFWr",
  "err-code": 0,
  "ts": 1522856623232,
  "data": {
    "id": 2039498445,
    "symbol": "htusdt",
    "account-id": 100077,
    "amount": "5000.000000000000000000",
    "price": "1.662100000000000000",
    "created-at": 1522858623622,
    "type": "buy-limit",
    "filled-amount": "5000.000000000000000000",
    "filled-cash-amount": "8301.357280000000000000",
    "filled-fees": "8.000000000000000000",
    "finished-at": 1522858624796,
    "source": "api",
    "state": "filled",
    "canceled-at": 0
  }
}

字段	数据类型	描述
id	long	订单ID
symbol	string	交易对
account-id	long	账户ID
amount	string	订单数量
price	string	订单价格
created-at	long	订单创建时间
type	string	订单类型，请参考订单类型说明
filled-amount	string	已成交数量
filled-cash-amount	string	已成交总金额
filled-fees	string	已成交手续费
finished-at	string	最后成交时间
source	string	订单来源，请参考订单来源说明
state	string	订单状态，请参考订单状态说明
cancel-at	long	撤单时间
stop-price	string	止盈止损订单触发价格
operator	string	止盈止损订单触发价运算符

稳定币兑换

稳定币兑换价格查询

GET v1/stable-coin/quote API Key 权限：读取

请求参数

参数名称	是否必须	类型	描述	取值范围
currency	true	string	与HUSD兑换的稳定币币种	USDT/PAX/USDC/TUSD
amount	true	string	与HUSD兑换的稳定币币种数量	amount必须为整数
type	true	string	兑换方向	buy兑入/sell兑出

响应数据

参数名称	是否必须	数据类型	描述	取值范围
currency	true	string	与HUSD兑换的稳定币币种	USDT/PAX/USDC/TUSD
amount	true	string	与HUSD兑换的稳定币币种数量	因兑换账户额度等因素影响，返回的amount可能会比请求的amount小
type	true	string	兑换方向	buy兑入/sell兑出
exchange-amount	true	string	匹配的HUSD数量	type=buy时，exchange-amount为用户所需支付的husd数量；type=sell时，exchange-amount为用户可获得的husd数量
quote-id	true	string	该次稳定币报价唯一ID
expiration	true	string	确认兑换有效期	时间（一般为接口请求时间向后延伸10秒）

错误码

响应码	说明
invalid-currency	币种无效
invalid-amount	币种数量小于最低值（10万）或大于当前可兑换额度
invalid-type	type不为sell或buy
quote-failure	后端其他错误引起的后端其他错误引起的价格查询失败

兑换稳定币

POST v1/stable-coin/exchange API Key 权限：交易

请求参数

参数名称	是否必须	类型	描述	取值范围
quote-id	true	string	该次稳定币报价唯一ID

响应数据

参数名称	是否必须	数据类型	描述	取值范围
transact-id	true	long	兑换记录ID
currency	true	string	与HUSD兑换的稳定币币种	USDT/PAX/USDC/TUSD
amount	true	string	与HUSD兑换的稳定币币种数量
type	true	string	兑换方向	buy兑入/sell兑出
exchange-amount	true	string	匹配的HUSD数量	type=buy时，exchange-amount为用户所需支付的husd数量；type=sell时，exchange-amount为用户可获得的husd数量
time	true	long	时间戳

错误码

响应码	说明
invalid-quote-id	无效的quote-id
insufficient-balance	可用余额不足
insufficient-quota	稳定币限额不足/超出稳定币限额
exchange-failure	后端其他错误引起的兑换失败
Base-user-request-exceed-limit	您的操作太频繁，请稍后再试

ETF（HB10）

基本信息

用户可以通过该接口取得关于 ETF 换入换出的基本信息，包括一次换入最小量，一次换入最大量，一次换出最小量，一次换出最大量，换入费率，换出费率，最新 ETF 换入换出状态，以及 ETF 的成分结构。

HTTP 请求

GET /etf/swap/config

请求参数

参数	是否必填	数据类型	长度	说明	取值范围
etf_name	true	string	-	etf基金名称	hb10

{
  "code": 200,
  "data": {
    "purchase_min_amount": 10000,
    "purchase_max_amount": 100000,
    "redemption_min_amount": 10000,
    "redemption_max_amount": 10000,
    "purchase_fee_rate": 0.001,
    "redemption_fee_rate": 0.002,
    "etf_status":1,
    "unit_price":
    [
      {
        "currency": "eth",
        "amount": 19.9
      },
      {
        "currency": "btc",
        "amount": 9.9
      }
    ]
  },
  "message": null,
  "success": true
}

响应数据

参数	是否必填	数据类型	长度	说明	取值范围
purchase_min_amount	true	int	-	最小单次换入数量
purchase_max_amount	False	int	-	最大单次换入数量
redemption_min_amount	true	int	-	最小单次换出数量
redemption_max_amount	False	int	-	最大单次换出数量
purchase_fee_rate	true	double	(5,4)	换入费率
redemption_fee_rate	true	double	(5,4)	换出费率
etf_status	true	int	-	换入换出状态	状态：正常 – 1; 由调仓引起的换入换出暂停 - 2; 其他原因引起的换入换出暂停 - 3; 换入暂停 - 4; 换出暂停 – 5
unit_price	true	Array	-	ETF成分信息，包含成分币代码和对应的数量	调仓会引起成分信息发生变化

unit_price

参数	是否必填	数据类型	长度	说明
currency	true	string	-	成分币币种
amount	true	double	-	成分币数量

换入�换出

API Key 权限：交易

用户可以通过该接口取得关于 ETF 换入（swap/in）换出（swap/out）的基本信息，包括一次换入最小量，一次换入最大量，一次换出最小量，一次换出最大量，换入费率，换出费率，最新 ETF 换入换出状态，以及 ETF 的成分结构。

HTTP 请求

POST /etf/swap/in
POST /etf/swap/out

请求参数

参数	是否必填	数据类型	长度	说明	取值范围
etf_name	true	string	-	etf基金名称	hb10
amount	true	int	-	换入数量 (POST /etf/swap/in) 或换出数量 (POST /etf/swap/out)	换入换出数量的范围请参照接口GET /etf/swap/config 提供的相应范围

{
    "code": 200,
    "data": null,
    "message": null,
    "success": true
}

响应数据

参数	是否必填	数据类型	长度	说明	取值范围
code	true	int	-	结果返回码	请参照返回码解释表
data	true		-
message	true		-
success	true	Boolean	-	请求是否成功	true or false

返回码解释表

返回码	说明
200	正常
10404	基金代码不正确或不存在
13403	账户余额不足
13404	基金调整中，不能换入换出
13405	因配置项问题基金不可换入换出
13406	非API调用，请求被拒绝
13410	API签名错误
13500	系统错误
13601	调仓期：暂停换入换出
13603	其他原因，暂停换入和换出
13604	暂停换入
13605	暂停换出
13606	换入或换出的基金份额超过规定范围

操作记录

API Key 权限：读取

用户可以通过该接口取得关于 ETF 换入换出操作的明细记录。最多返回 100 条记录。

HTTP 请求

GET /etf/swap/list

请求参数

参数	是否必填	数据类型	长度	说明	取值范围
etf_name	true	string	-	etf基金名称	hb10
offset	true	int	-	开始位置	>=0. 比如，当offset=0, 开始位置就是最新的这一条记录。
limit	true	int	-	最大返回记录条数	[1, 100]

{
  "code": 200,
  "data": [
    {
      "id": 112222,
      "gmt_created": 1528855872323,
      "currency": "hb10",
      "amount": 11.5,
      "type": 1,
      "status": 2,
      "detail": 
      {
        "used_ currency_list": 
        [
          {
            "currency": "btc",
            "amount": 0.666
          },
          {
            "currency": "eth",
            "amount": 0.666
          }
        ],
        "rate": 0.002,
        "fee": 100.11,
        "point_card_amount":1.0,
        "obtain_ currency_list": 
        [
          {
            "currency": "hb10",
            "amount": 1000
          }
        ]
      }
    },
    {
      "id": 112223,
      "gmt_created": 1528855872323,
      "currency": "hb10",
      "amount": 11.5,
      "type": 2,
      "status": 1,
      "detail": 
      {
        "used_ currency_list": 
        [
          {
            "currency": "btc",
            "amount": 0.666
          },
          {
            "currency": "eth",
            "amount": 0.666
          }
        ],
        "rate": 0.002,
        "fee": 100.11,
        "point_card_amount":1.0,
        "obtain_ currency_list":
        [
          {
            "currency": "hb10",
            "amount": 1000
          }
        ]
      }
    }
  ],
  "message": null,
  "success": true
}

响应数据

参数	是否必填	数据类型	长度	说明	取值范围
id	true	long	-	操作ID
gmt_created	true	long	-	操作时间（毫秒）
currency	true	string	-	基金名称
amount	true	double	-	基金数量
type	true	int	-	操作类型	换入-1；换出-2
status	true	int	-	操作结果状态	成功-2
detail	true	Detail[]	-	详情

Detail

参数	是否必填	数据类型	长度	说明
used_ currency_list	ture	Currency[]	-	换出的资产列表。如果是换入，该参数包括的是用于换入的成分币详情。如果是换出，该参数则是用于换出的基金详情。
rate	ture	double	-	费率
fee	ture	double	-	实际收取的手续费
point_card_amount	ture	double	-	用点卡折扣的手续费
obtain_ currency_list	ture	Currency[]	-	换回的资产列表。如果是换入，该参数包括的是用于换出的基金详情。如果是换出，该参数则是用于换入的成分币详情。

Currency

参数	是否必填	数据类型	长度	说明
currency	true	string	-	成分币名称或基金名称
amount	true	double	-	数量

Name		Name	Last commit message	Last commit date
Latest commit History 24 Commits
README.md		README.md

duqingxiang/My-API-project

Folders and files

Latest commit

History

Repository files navigation

更新日志

简介

API 简介

做市商项目

初次必看

接入准备

接口说明

REST API

WebSocket API

SDK与代码示例

公告订阅

联系我们

接入说明

访问

签名认证

签名说明

创建 API Key

签名步骤

1. 请求方法（GET 或 POST），后面添加换行符 “\n”

2. 添加小写的访问地址，后面添加换行符 “\n”

3. 访问方法的路径，后面添加换行符 “\n”

4. 按照ASCII码顺序对参数名进行排序，且进行URI编码，例如，下面是请求参数的原始顺序，且进行URI编码后

5. 经过排序之后

6. 按照以上顺序，将各参数使用字符 “&” 连接

7. 组成最终的要进行签名计算的字符串如下

8. 用上一步里生成的 “请求字符串” 和你的密钥 (Secret Key) 生成一个数字签名

9. 将生成的数字签名加入到请求的路径参数里

限频规则

请求格式

返回格式

返回内容格式

错误信息

行情 API 错误信息

交易 API 错误信息

子账号

业务说明

交易对

行情

账户

订单类型

订单状态

常见问题

经常断线或者丢数据

签名失败

返回 login-required

返回 gateway-internal-error

基础信息

获取所有交易对

HTTP 请求

请求参数

返回字段

获取所有币种

HTTP 请求

请求参数

返回字段

APIv2 币链参考信息

HTTP 请求

请求参数

响应数据

状态码

获取当前系统时间

HTTP 请求

请求参数

行情数据

K 线数据（蜡烛图）

HTTP 请求

请求参数

响应数据

聚合行情（Ticker）

HTTP 请求

请求参数

响应数据

所有交易对的最新 Tickers

HTTP 请求

请求参数