1111区块链
ont ... txhash True String 交易哈希 amount True Number($double) 量 factamount True Number($double) 成功到账量 address True String 地址 addresstag True String 地址标签 comfirmnode True Integer($int32) 确认节点数 fee T。
一、 REST API简介
HEX交易平台API目的为平台用户提供一套独立的API，可以帮助用户快速接入HEX交易系统，实现程序化交易。
swagger地址：https://open.hex.com/swagger/index.html
API正式地址：https://open.hex.com
测试账户与密钥：请至主站 hex.com 注册为平台用户，然后在用户中心API栏目中自行申请，审核通过后，即可获得API AccessKey、SecretKey。
这两个密钥与账号安全紧密相关，无论何时都请勿向其它人透露。
通过OPEN API可以实现以下功能：
1、市场行情信息查询(K线、深度、实时成交、24小时行情等)；
2、账户资产信息查询；
3、下单、撤单操作；
4、订单信息、充提记录查询；
二、 签名认证&请求说明
通过用户中心获取到API AccessKey以及SecretKey，接口的安全性验证基于这两个字段进行签名与验签。目前服务端接口只校验请求参数的合法性，以防止数据被篡改，应答数据暂未加密返回。
目前服务器端只接收HttpGet、HttpPost的请求，其中HttpPost采用json数据格式提交至服务器端，并且POST接口方法本身参数不参与签名计算，只需将通用参数做参数签名即可。HttpGet采用请求地址传递参数，必填参数与通用参数必须参与签名，另外有默认值的参数可以不传递，不传递系统将采用默认参数赋值并不参与签名，如有传递，系统将会把此参数加入到签名参数中参与签名，另外系统统一采用https请求，服务器应答统一json格式输出。
| HttpGet & HttpPost调用对比 |
||
| Method |
HttpGet |
HttpPost |
| Content-Type |
application/x-www-form-urlencoded |
application/json |
| 参数传递方式 |
地址栏传值 |
Body |
| 签名字段 |
必填 有参数值的参数 |
通用参数 |
| 通用参数 |
|||
| 参数 |
是否必填 |
类型/默认值 |
说明 |
| AccessKey |
True |
String |
API 访问密钥您申请的 API 中的AccessKey。 |
| SignatureMethod |
True |
String/MD5 |
签名方法，此处使用 MD5 |
| SignatureVersion |
True |
String/1 |
签名版本，签名协议的版本，此处使用1 |
| RandStr |
True |
String |
随机字符串，建议使用GUID，保证唯一性 |
| Timestamp |
True |
Integer($int64) |
发出请求的时间戳 (UTC 时区) |
签名计算：
Signature=MD5(urlencode(sortedlist(p1=xxx&p2=xxx&...&secretkey=您的密钥).lower(),'utf-8'))
Signature：签名计算后的结果(32位长度的字符串，此参数必须传递到请求中，服务器端通过此参数验证请求的合法性)
MD5()：加密方法，请勿遗漏；
urlencode()：参数字符串编码方式，采用utf-8编码；
sortedlist()：以参数的字母升序排序(a-z);
lower()：字符串转小写；
以上计算公式为伪代码，具体签名方式请看代码实例。
示例：请求接口 GET /v1/order/detail
AccessKey = 2cc8fdcd-462d-40cf-bde0-a240f0b02508
SecretKey = 2d8f4982-3b15-43d3-aaec-99444e8cc7ce
RandStr = 89320394
Timestamp = 1534409404916
OrderID = 1000300224
Signature 计算过程：
1：参数拼接 sortedlist().tolower() 之后的结果为：
accesskey=2cc8fdcd-462d-40cf-bde0-a240f0b02508&orderid=1000300224&randstr=89320394×tamp=1534409404916&secretkey=2d8f4982-3b15-43d3-aaec-99444e8cc7ce
2：编码字符
urlencode('accesskey=2cc8fdcd-462d-40cf-bde0-a240f0b02508&orderid=1000300224&randstr=89320394×tamp=1534409404916&secretkey=2d8f4982-3b15-43d3-aaec-99444e8cc7ce','utf-8')
之后的结果为：
accesskey=2cc8fdcd-462d-40cf-bde0-a240f0b02508&orderid=1000300224&randstr=89320394×tamp=1534409404916&secretkey=2d8f4982-3b15-43d3-aaec-99444e8cc7ce
3：Signature=
md5('accesskey=2cc8fdcd-462d-40cf-bde0-a240f0b02508&orderid=1000300224&randstr=89320394×tamp=1534409404916&secretkey=2d8f4982-3b15-43d3-aaec-99444e8cc7ce')
之后的结果为：
23da2f23886db136ab280e9cb28aa5f5
4：最终请求地址为：
GET /v1/order/detail?OrderID=1000300224&AccessKey=2cc8fdcd-462d-40cf-bde0-a240f0b02508&RandStr=89320394&Timestamp=1534409404916&Signature=23da2f23886db136ab280e9cb28aa5f5
三、 API Reference
接口列表
| 接口数据类型 |
请求方法 |
类型 |
描述 |
需要验签 |
| 市场行情 |
GET /market/history.kline |
GET |
K线 |
Yes |
| 市场行情 |
GET /market/detail.merged |
GET |
单个symbol滚动24小时交易和最优报价聚合行情 |
Yes |
| 市场行情 |
GET /market/detail |
GET |
Yes |
|
| 市场行情 |
GET /market/tickers |
GET |
全部symbol的交易行情 |
Yes |
| 市场行情 |
GET /market/depth |
GET |
Yes |
|
| 市场行情 |
GET /market/trade |
GET |
Yes |
|
| 市场行情 |
GET /market/history.trade |
GET |
单个symbol批量成交记录 |
Yes |
| 通用 |
GET /v1/common/symbols |
GET |
Yes |
|
| 通用 |
GET /v1/common/currencies |
GET |
交易币种列表 |
Yes |
| 通用 |
GET /v1/common/rate |
GET |
汇率 |
Yes |
| 通用 |
GET /v1/common/timestamp |
GET |
查询当前系统时间(UTC时间戳) |
Yes |
| 账户 |
GET /v1/account/accounts |
GET |
查询用户的所有账户状态 |
Yes |
| 账户 |
GET /v1/account/balance |
GET |
查询指定账户余额 |
Yes |
| 交易 |
POST /v1/order/create | POST |
下单 |
Yes |
| 交易 |
POST /v1/order/cancel | POST |
撤销一个订单 |
Yes |
| 交易 |
POST /v1/order/batch.cancel | POST |
按orderid批量撤销订单(max:30) |
Yes |
| 用户订单 |
GET /v1/order/detail | GET |
根据orderid查询订单详情 |
Yes |
| 用户订单 |
GET /v1/order/orders | GET |
查询用户当前委托、或历史委托订单 |
Yes |
| 申请提币 |
POST /v1/user/withdraw/create | POST |
申请提币 |
Yes |
| 撤销提币 |
POST /v1/user/withdraw/revoke | POST |
撤销提币申请 |
Yes |
| 查询充提 |
GET /v1/user/query/deposit-withdraw | GET |
查询充提记录 |
Yes |
-
GET /market/history.kline K线
请求参数：
参数名称
是否必须
类型
描述
默认值
取值范围
Symbol
True
String
交易对
btcusdt, bchbtc, rcneth …
Period
True
String
K线类型
1min, 5min, 15min, 30min, 60min, 1day,1week, 1mon
Size
False
Integer($int32)
获取数量
500
[1~1000]
AccessKey
True
String
API访问KEY
SignatureMethod
True
String
签名方法
HmacSHA256
此处使用：HmacSHA256
SignatureVersion
True
String
签名版本
1
此处使用：1
RandStr
True
String
随机字符串
Timestamp
True
Integer($int64)
时间戳（UTC时区）
Signature
True
String
签名结果（非签名字段）
请求实例：
GET /market/history.kline?Symbol=btcusdt&Period=1min&Size=200&AccessKey=e12b3b62-8a2a-4bb0-a526-a63695485113&SignatureMethod=HmacSHA256& SignatureVersion=1&RandStr=89320394&Timestamp=1534409404916&Signature=xxxxxxxxxxxxxxxxxxxxx
响应数据：
参数名称
是否必须
类型
描述
取值范围
code
True
String
请求处理响应码
msg
True
String
请求处理响应消息
ts
True
Integer($int64)
服务器响应时间戳(UTC,毫秒)
data
True
Object
响应数据
data数据结构说明
symbol
True
String
交易对
btcusdt, bchbtc, rcneth …
amount
True
Number($double)
成交量
open
True
Number($double)
开盘价
close
True
Number($double)
收盘价（当K线为最晚的一根时，是最新成交价）
low
True
Number($double)
最低价
high
True
Number($double)
最高价
ts
True
Integer($int64)
时间戳
Response JSON：
{
"code": "string",
"msg": "string",
"ts": 0,
"data": [
{
"symbol": "string",
"amount": 0,
"open": 0,
"close": 0,
"low": 0,
"high": 0,
"ts": 0
}
]
}
-
GET /market/detail.merged 单个symbol滚动24小时交易和最优报价聚合行情
请求参数：
参数名称
是否必须
类型
描述
默认值
取值范围
Symbol
True
String
交易对
btcusdt, bchbtc, rcneth …
AccessKey
True
String
API访问KEY
SignatureMethod
True
String
签名方法
HmacSHA256
此处使用：HmacSHA256
SignatureVersion
True
String
签名版本
1
此处使用：1
RandStr
True
String
随机字符串
Timestamp
True
Integer($int64)
时间戳（UTC时区）
Signature
True
String
签名结果（非签名字段）
请求实例：
GET /market/detail.merged?Symbol=btcusdt&AccessKey=e12b3b62-8a2a-4bb0-a526-a63695485113&SignatureMethod=HmacSHA256&SignatureVersion=1&RandStr=89320394&Timestamp=1534409404916&Signature=xxxxxxxxxxxxxxxxxxxxx
响应参数：
参数名称
是否必须
类型
描述
取值范围
code
True
String
请求处理响应码
msg
True
String
请求处理响应消息
ts
True
Integer($int64)
服务器响应时间戳(UTC,毫秒)
data
True
Object
响应数据
data数据结构说明
symbol
True
String
交易对
btcusdt, bchbtc, rcneth …
amount
True
Number($double)
成交量
open
True
Number($double)
开盘价
close
True
Number($double)
收盘价（当K线为最晚的一根时，是最新成交价）
low
True
Number($double)
最低价
high
True
Number($double)
最高价
ts
True
Integer($int64)
时间戳
bid
True
Object
买卖信息{price:价格,amount:量}
ask
True
Object
买卖信息{price:价格,amount:量}
Response JSON：
{
"code": "string",
"msg": "string",
"ts": 0,
"data": {
"bid": {
"price": 0,
"amount": 0
},
"ask": {
"price": 0,
"amount": 0
},
"symbol": "string",
"amount": 0,
"open": 0,
"close": 0,
"low": 0,
"high": 0,
"ts": 0
}
}
-
GET /market/detail 单个symbol滚动24小时交易聚合行情
请求参数：
参数名称
是否必须
类型
描述
默认值
取值范围
Symbol
True
String
交易对
btcusdt, bchbtc, rcneth …
AccessKey
True
String
API访问KEY
SignatureMethod
True
String
签名方法
HmacSHA256
此处使用：HmacSHA256
SignatureVersion
True
String
签名版本
1
此处使用：1
RandStr
True
String
随机字符串
Timestamp
True
Integer($int64)
时间戳（UTC时区）
Signature
True
String
签名结果（非签名字段）
请求实例：
GET /market/detail?Symbol=btcusdt&AccessKey=e12b3b62-8a2a-4bb0-a526-a63695485113&SignatureMethod=HmacSHA256&SignatureVersion=1&RandStr=89320394&Timestamp=1534409404916&Signature=xxxxxxxxxxxxxxxxxxxxx
响应参数：
参数名称
是否必须
类型
描述
取值范围
code
True
String
请求处理响应码
msg
True
String
请求处理响应消息
ts
True
Integer($int64)
服务器响应时间戳(UTC,毫秒)
data
True
Object
响应数据
data数据结构说明
symbol
True
String
交易对
btcusdt, bchbtc, rcneth …
amount
True
Number($double)
成交量
open
True
Number($double)
开盘价
close
True
Number($double)
收盘价（当K线为最晚的一根时，是最新成交价）
low
True
Number($double)
最低价
high
True
Number($double)
最高价
ts
True
Integer($int64)
时间戳
Response JSON：
{
"code": "string",
"msg": "string",
"ts": 0,
"data": {
"symbol": "string",
"amount": 0,
"open": 0,
"close": 0,
"low": 0,
"high": 0,
"ts": 0
}
}
-
GET /market/tickers 全部symbol的交易行情
请求参数：
参数名称
是否必须
类型
描述
默认值
取值范围
AccessKey
True
String
API访问KEY
SignatureMethod
True
String
签名方法
HmacSHA256
此处使用：HmacSHA256
SignatureVersion
True
String
签名版本
1
此处使用：1
RandStr
True
String
随机字符串
Timestamp
True
Integer($int64)
时间戳（UTC时区）
Signature
True
String
签名结果（非签名字段）
请求实例：
GET /market/tickers?AccessKey=e12b3b62-8a2a-4bb0-a526-a63695485113&SignatureMethod=HmacSHA256&SignatureVersion=1&RandStr=89320394&Timestamp=1534409404916&Signature=xxxxxxxxxxxxxxxxxxxxx
响应数据：
参数名称
是否必须
类型
描述
取值范围
code
True
String
请求处理响应码
msg
True
String
请求处理响应消息
ts
True
Integer($int64)
服务器响应时间戳(UTC,毫秒)
data
True
List[Object]
响应数据
data数据结构说明
symbol
True
String
交易对
btcusdt, bchbtc, rcneth …
amount
True
Number($double)
成交量
open
True
Number($double)
开盘价
close
True
Number($double)
收盘价（当K线为最晚的一根时，是最新成交价）
low
True
Number($double)
最低价
high
True
Number($double)
最高价
ts
True
Integer($int64)
时间戳
Response JSON：
{
"code": "string",
"msg": "string",
"ts": 0,
"data": [
{
"symbol": "string",
"amount": 0,
"open": 0,
"close": 0,
"low": 0,
"high": 0,
"ts": 0
}
]
}
-
GET /market/depth 单个symbol市场深度行情
请求参数：
参数名称
是否必须
类型
描述
默认值
取值范围
Symbol
True
String
交易对
btcusdt, bchbtc, rcneth …
Type
True
String
Depth类型
step0,step1,step2,step3,step4,step5(合并深度0-5); step0时,不合并深度;
AccessKey
True
String
API访问KEY
SignatureMethod
True
String
签名方法
HmacSHA256
此处使用：HmacSHA256
SignatureVersion
True
String
签名版本
1
此处使用：1
RandStr
True
String
随机字符串
Timestamp
True
Integer($int64)
时间戳（UTC时区）
Signature
True
String
签名结果（非签名字段）
请求实例：
GET /market/depth?Symbol=btcusdt&Type=step1&AccessKey=e12b3b62-8a2a-4bb0-a526-a63695485113&SignatureMethod=HmacSHA256&SignatureVersion=1&RandStr=89320394&Timestamp=1534409404916&Signature=xxxxxxxxxxxxxxxxxxxxx
响应数据：
参数名称
是否必须
类型
描述
取值范围
code
True
String
请求处理响应码
msg
True
String
请求处理响应消息
ts
True
Integer($int64)
服务器响应时间戳(UTC,毫秒)
data
True
Object
响应数据
data数据结构说明
bids
True
List[Object]
买盘信息[{price:成交价,amount:成交量}] 按price降序
asks
True
List[Object]
卖盘信息[{price:成交价,amount:成交量}] 按price升序
ts
True
Integer($int64)
时间戳
Response JSON：
{
"code": "string",
"msg": "string",
"ts": 0,
"data": {
"ts": 0,
"bids": [
{
"price": 0,
"amount": 0
}
],
"asks": [
{
"price": 0,
"amount": 0
}
]
}
}
-
GET /market/trade 单个symbol最新成交记录
请求参数：
参数名称
是否必须
类型
描述
默认值
取值范围
Symbol
True
String
交易对
btcusdt, bchbtc, rcneth …
AccessKey
True
String
API访问KEY
SignatureMethod
True
String
签名方法
HmacSHA256
此处使用：HmacSHA256
SignatureVersion
True
String
签名版本
1
此处使用：1
RandStr
True
String
随机字符串
Timestamp
True
Integer($int64)
时间戳（UTC时区）
Signature
True
String
签名结果（非签名字段）
请求参数：
GET /market/trade?Symbol=btcusdt&AccessKey=e12b3b62-8a2a-4bb0-a526-a63695485113&SignatureMethod=HmacSHA256&SignatureVersion=1&RandStr=89320394&Timestamp=1534409404916&Signature=xxxxxxxxxxxxxxxxxxxxx
响应参数：
参数名称
是否必须
类型
描述
取值范围
code
True
String
请求处理响应码
msg
True
String
请求处理响应消息
ts
True
Integer($int64)
服务器响应时间戳(UTC,毫秒)
data
True
Object
响应数据
data数据结构说明
price
True
Number($double)
成交价
amount
True
Number($double)
成交量
direction
True
Integer($int32)
主动成交方向(1:买入,-1:卖出)
[1,-1]
ts
True
Integer($int64)
时间戳
Response JSON：
{
"code": "string",
"msg": "string",
"ts": 0,
"data": {
"price": 0,
"amount": 0,
"direction": 0,
"ts": 0
}
}
-
GET /market/history.trade 单个symbol批量成交记录
请求参数：
参数名称
是否必须
类型
描述
默认值
取值范围
Symbol
True
String
交易对
btcusdt, bchbtc, rcneth …
Size
False
Integer($int32)
获取交易记录的数量
1
[1~1000]
AccessKey
True
String
API访问KEY
SignatureMethod
True
String
签名方法
HmacSHA256
此处使用：HmacSHA256
SignatureVersion
True
String
签名版本
1
此处使用：1
RandStr
True
String
随机字符串
Timestamp
True
Integer($int64)
时间戳（UTC时区）
Signature
True
String
签名结果（非签名字段）
请求实例：
GET /market/history.trade?Symbol=btcusdt&Size=200&AccessKey=e12b3b62-8a2a-4bb0-a526-a63695485113&SignatureMethod=HmacSHA256&SignatureVersion=1&RandStr=89320394&Timestamp=1534409404916&Signature=xxxxxxxxxxxxxxxxxxxxx
响应参数：
参数名称
是否必须
类型
描述
取值范围
code
True
String
请求处理响应码
msg
True
String
请求处理响应消息
ts
True
Integer($int64)
服务器响应时间戳(UTC,毫秒)
data
True
List[Object]
响应数据
data数据结构说明
price
True
Number($double)
成交价
amount
True
Number($double)
成交量
direction
True
Integer($int32)
主动成交方向(1:买入,-1:卖出)
[1,-1]
ts
True
Integer($int64)
时间戳
Response JSON：
{
"code": "string",
"msg": "string",
"ts": 0,
"data": [
{
"price": 0,
"amount": 0,
"direction": 0,
"ts": 0
}
]
}
-
GET /v1/common/symbols 交易品种的计价货币和报价精度
请求数据：
参数名称
是否必须
类型
描述
默认值
取值范围
AccessKey
True
String
API访问KEY
SignatureMethod
True
String
签名方法
HmacSHA256
此处使用：HmacSHA256
SignatureVersion
True
String
签名版本
1
此处使用：1
RandStr
True
String
随机字符串
Timestamp
True
Integer($int64)
时间戳（UTC时区）
Signature
True
String
签名结果（非签名字段）
请求实例：
GET /v1/common/symbols?AccessKey=e12b3b62-8a2a-4bb0-a526-a63695485113&SignatureMethod=HmacSHA256&SignatureVersion=1&RandStr=89320394&Timestamp=1534409404916&Signature=xxxxxxxxxxxxxxxxxxxxx
响应参数：
参数名称
是否必须
类型
描述
取值范围
code
True
String
请求处理响应码
msg
True
String
请求处理响应消息
ts
True
Integer($int64)
服务器响应时间戳(UTC,毫秒)
data
True
List[Object]
响应数据
data数据结构说明
id
True
Integer($int64)
交易ID
basecurrency
True
String
基础币种
quotecurrency
True
String
计价币种
symbol
True
String
交易对
priceprecision
True
String
价格精度位数（0为个位）
amountprecision
True
String
数量精度位数（0为各位）
Response JSON：
{
"code": "string",
"msg": "string",
"ts": 0,
"data": [
{
"id": 0,
"basecurrency": "string",
"quotecurrency": "string",
"symbol": "string",
"priceprecision": "string",
"amountprecision": "string"
}
]
}
-
GET /v1/common/currencies 交易币种列表
请求参数：
参数名称
是否必须
类型
描述
默认值
取值范围
AccessKey
True
String
API访问KEY
SignatureMethod
True
String
签名方法
HmacSHA256
此处使用：HmacSHA256
SignatureVersion
True
String
签名版本
1
此处使用：1
RandStr
True
String
随机字符串
Timestamp
True
Integer($int64)
时间戳（UTC时区）
Signature
True
String
签名结果（非签名字段）
请求实例：
GET /v1/common/currencies?AccessKey=e12b3b62-8a2a-4bb0-a526-a63695485113&SignatureMethod=HmacSHA256&SignatureVersion=1&RandStr=89320394&Timestamp=1534409404916&Signature=xxxxxxxxxxxxxxxxxxxxx
响应参数：
参数名称
是否必须
类型
描述
取值范围
code
True
String
请求处理响应码
msg
True
String
请求处理响应消息
ts
True
Integer($int64)
服务器响应时间戳(UTC,毫秒)
data
True
List[Object]
响应数据
data数据结构说明
id
True
Integer($int64)
币种ID
currencyname
True
String
币种名称
Response JSON：
{
"code": "string",
"msg": "string",
"ts": 0,
"data": [
{
"id": 0,
"currencyname": "string"
}
]
}
-
GET /v1/common/rate 汇率
请求参数：
参数名称
是否必须
类型
描述
默认值
取值范围
AccessKey
True
String
API访问KEY
SignatureMethod
True
String
签名方法
HmacSHA256
此处使用：HmacSHA256
SignatureVersion
True
String
签名版本
1
此处使用：1
RandStr
True
String
随机字符串
Timestamp
True
Integer($int64)
时间戳（UTC时区）
Signature
True
String
签名结果（非签名字段）
请求实例：
GET /v1/common/rate?AccessKey=e12b3b62-8a2a-4bb0-a526-a63695485113&SignatureMethod=HmacSHA256&SignatureVersion=1&RandStr=89320394&Timestamp=1534409404916&Signature=xxxxxxxxxxxxxxxxxxxxx
响应参数：
参数名称
是否必须
类型
描述
取值范围
code
True
String
请求处理响应码
msg
True
String
请求处理响应消息
ts
True
Integer($int64)
服务器响应时间戳(UTC,毫秒)
data
True
List[Object]
响应数据
data数据结构说明
currencyname
True
String
币种名称
rate
True
Number($double)
汇率
ts
True
Integer($int64)
更新时间戳
Response JSON：
{
"code": "string",
"msg": "string",
"ts": 0,
"data": [
{
"currencyname": "string",
"rate": 0,
"ts": 0
}
]
}
-
GET /v1/common/timestamp 查询当前系统时间(UTC时间戳)
请求参数：
参数名称
是否必须
类型
描述
默认值
取值范围
AccessKey
True
String
API访问KEY
SignatureMethod
True
String
签名方法
HmacSHA256
此处使用：HmacSHA256
SignatureVersion
True
String
签名版本
1
此处使用：1
RandStr
True
String
随机字符串
Timestamp
True
Integer($int64)
时间戳（UTC时区）
Signature
True
String
签名结果（非签名字段）
请求参数：
GET /v1/common/rate?AccessKey=e12b3b62-8a2a-4bb0-a526-a63695485113&SignatureMethod=HmacSHA256&SignatureVersion=1&RandStr=89320394&Timestamp=1534409404916&Signature=xxxxxxxxxxxxxxxxxxxxx
响应参数：
参数名称
是否必须
类型
描述
取值范围
code
True
String
请求处理响应码
msg
True
String
请求处理响应消息
ts
True
Integer($int64)
服务器响应时间戳(UTC,毫秒)
data
True
Object
响应数据(当前系统时间戳UTC)
Response JSON：
{
"code": "string",
"msg": "string",
"ts": 0,
"data": {}
}
-
GET /v1/account/accounts 查询用户的所有账户状态
请求参数：
参数名称
是否必须
类型
描述
默认值
取值范围
AccessKey
True
String
API访问KEY
SignatureMethod
True
String
签名方法
HmacSHA256
此处使用：HmacSHA256
SignatureVersion
True
String
签名版本
1
此处使用：1
RandStr
True
String
随机字符串
Timestamp
True
Integer($int64)
时间戳（UTC时区）
Signature
True
String
签名结果（非签名字段）
请求实例：
GET /v1/account/accounts?AccessKey=e12b3b62-8a2a-4bb0-a526-a63695485113&SignatureMethod=HmacSHA256&SignatureVersion=1&RandStr=89320394&Timestamp=1534409404916&Signature=xxxxxxxxxxxxxxxxxxxxx
响应参数：
参数名称
是否必须
类型
描述
取值范围
code
True
String
请求处理响应码
msg
True
String
请求处理响应消息
ts
True
Integer($int64)
服务器响应时间戳(UTC,毫秒)
data
True
List[Object]
响应数据
data数据结构说明
userid
True
Integer($int64)
用户id
type
True
String
账户类型
status
True
String
账户状态(pending:审核中,notpass:审核不通过,working:正常,frozen:已冻结)
Response JSON：
{
"code": "string",
"msg": "string",
"ts": 0,
"data": [
{
"userid": 0,
"type": "string",
"status": "string"
}
]
}
-
GET /v1/account/balance 查询指定账户余额
请求参数：
参数名称
是否必须
类型
描述
默认值
取值范围
AccessKey
True
String
API访问KEY
SignatureMethod
True
String
签名方法
HmacSHA256
此处使用：HmacSHA256
SignatureVersion
True
String
签名版本
1
此处使用：1
RandStr
True
String
随机字符串
Timestamp
True
Integer($int64)
时间戳（UTC时区）
Signature
True
String
签名结果（非签名字段）
请求实例：
GET /v1/account/balance?AccessKey=e12b3b62-8a2a-4bb0-a526-a63695485113&SignatureMethod=HmacSHA256&SignatureVersion=1&RandStr=89320394&Timestamp=1534409404916&Signature=xxxxxxxxxxxxxxxxxxxxx
响应参数：
参数名称
是否必须
类型
描述
取值范围
code
True
String
请求处理响应码
msg
True
String
请求处理响应消息
ts
True
Integer($int64)
服务器响应时间戳(UTC,毫秒)
data
True
List[Object]
响应数据
data数据结构说明
currency
True
String
币种名称
balance
True
Number($double)
余额
frozen
True
Number($double)
冻结
Response JSON：
{
"code": "string",
"msg": "string",
"ts": 0,
"data": [
{
"currency": "string",
"balance": 0,
"frozen": 0
}
]
}
-
POST /v1/order/create 下单
请求参数：
参数名称
是否必须
类型
描述
默认值
取值范围
Symbol
True
String
交易对
btcusdt, bchbtc, rcneth …
Amount
True
Number($double)
限价单表示下单数量，市价买单时表示买多少钱，市价卖单时表示卖多少币
OrderType
True
String
订单类型(limit限价单,market 市价单)
[Limit,Market]
Direction
True
String
交易方向(buy:买,sell:卖)
[Buy,Sell]
Price
False
Number($double)
下单价格，市价单不传该参数
Source
False
String
订单来源
AccessKey
True
String
API访问KEY
SignatureMethod
True
String
签名方法
HmacSHA256
此处使用：HmacSHA256
SignatureVersion
True
String
签名版本
1
此处使用：1
RandStr
True
String
随机字符串
Timestamp
True
Integer($int64)
时间戳（UTC时区）
Signature
True
String
签名结果（非签名字段）
请求实例：
POST /v1/order/create {
"symbol": "btcusdt",
"amount": 10,
"ordertype": "Limit",
"direction": "Buy",
"price":2020,
"source": "",
"accesskey": "e12b3b62-8a2a-4bb0-a526-a63695485113",
"signaturemethod": "HmacSHA256",
"signatureversion": "1",
"randstr": "89320394",
"timestamp": 1534409404916,
"signature": "xxxxxxxxxxxxxxxxxxxxx"
}
响应参数：
参数名称
是否必须
类型
描述
取值范围
code
True
String
请求处理响应码
msg
True
String
请求处理响应消息
ts
True
Integer($int64)
服务器响应时间戳(UTC,毫秒)
data
True
Integer($int64)
成功返回订单ID
Response JSON：
{
"code": "string",
"msg": "string",
"ts": 0,
"data": {}
}
-
POST /v1/order/cancel 撤销一个订单
请求参数：
参数名称
是否必须
类型
描述
默认值
取值范围
OrderID
True
Integer($int64)
订单ID
AccessKey
True
String
API访问KEY
SignatureMethod
True
String
签名方法
HmacSHA256
此处使用：HmacSHA256
SignatureVersion
True
String
签名版本
1
此处使用：1
RandStr
True
String
随机字符串
Timestamp
True
Integer($int64)
时间戳（UTC时区）
Signature
True
String
签名结果（非签名字段）
请求实例：
POST /v1/order/cancel {
"orderid": 129332000293,
"accesskey": "e12b3b62-8a2a-4bb0-a526-a63695485113",
"signaturemethod": "HmacSHA256",
"signatureversion": "1",
"randstr": "89320394",
"timestamp": 1534409404916,
"signature": "xxxxxxxxxxxxxxxxxxxxx "
}
响应参数：
参数名称
是否必须
类型
描述
取值范围
code
True
String
请求处理响应码
msg
True
String
请求处理响应消息
ts
True
Integer($int64)
服务器响应时间戳(UTC,毫秒)
data
True
Integer($int64)
成功返回订单ID
Response JSON：
{
"code": "string",
"msg": "string",
"ts": 0,
"data": {}
}
-
POST /v1/order/batch.cancel 按orderid批量撤销订单(max:30)
请求参数：
参数名称
是否必须
类型
描述
默认值
取值范围
OrderID
True
List[Integer($int64)]
订单ID集合
AccessKey
True
String
API访问KEY
SignatureMethod
True
String
签名方法
HmacSHA256
此处使用：HmacSHA256
SignatureVersion
True
String
签名版本
1
此处使用：1
RandStr
True
String
随机字符串
Timestamp
True
Integer($int64)
时间戳（UTC时区）
Signature
True
String
签名结果（非签名字段）
请求实例：
POST /v1/order/batch.cancel {
"orderid": [
1000300224,
1000300225
],
"accesskey": "e12b3b62-8a2a-4bb0-a526-a63695485113",
"signaturemethod": "HmacSHA256",
"signatureversion": "1",
"randstr": "89320394",
"timestamp": 1534409404916,
"signature": "xxxxxxxxxxxxxxxxxxxxx"
}
响应参数：
参数名称
是否必须
类型
描述
取值范围
code
True
String
请求处理响应码
msg
True
String
请求处理响应消息
ts
True
Integer($int64)
服务器响应时间戳(UTC,毫秒)
data
True
List[Object]
成功返回订单ID集合
data数据结构说明
orderid
True
Integer($int64)
订单ID
succeed
True
Bool
是否成功(true:成功,false:失败)
msg
True
String
返回消息
Response JSON：
{
"code": "string",
"msg": "string",
"ts": 0,
"data": [{
"orderid":"1000300224",succeed:true,msg: ""
},{
"orderid":"1000300225",succeed:false,msg: ""
}]
}
-
GET /v1/order/detail 根据orderid查询订单详情
请求参数：
参数名称
是否必须
类型
描述
默认值
取值范围
OrderID
True
Integer($int64)
订单ID
AccessKey
True
String
API访问KEY
SignatureMethod
True
String
签名方法
HmacSHA256
此处使用：HmacSHA256
SignatureVersion
True
String
签名版本
1
此处使用：1
RandStr
True
String
随机字符串
Timestamp
True
Integer($int64)
时间戳（UTC时区）
Signature
True
String
签名结果（非签名字段）
请求实例：
GET /v1/order/detail?OrderID=1000300224&AccessKey=e12b3b62-8a2a-4bb0-a526-a63695485113&SignatureMethod=HmacSHA256&SignatureVersion=1&RandStr=89320394&Timestamp=1534409404916&Signature=xxxxxxxxxxxxxxxxxxxxx
响应参数：
参数名称
是否必须
类型
描述
取值范围
code
True
String
请求处理响应码
msg
True
String
请求处理响应消息
ts
True
Integer($int64)
服务器响应时间戳(UTC,毫秒)
data
True
Object
成功返回订单信息
data数据结构说明
orderid
True
Integer($int64)
订单ID
ordertype
True
Integer($int32)
订单类型(1:限价单,2:市价单,3:止盈止损单)
direction
True
Integer($int32)
交易方向(1:买入,-1:卖出)
price
True
Number($double)
委托价
amount
True
Number($double)
委托量
transactionamount
True
Number($double)
成交量
fee
True
Number($double)
手续费率
symbol
True
String
交易对
btcusdt, bchbtc, rcneth …
orderstatus
True
Integer($int32)
订单状态
订单状态(0:已提交，1:部分成交，2:已撤单，3:全部成交，4:部分成交已撤单，5：系统自动撤单)
updatetime
True
String($date-time)
最后成交时间（UTC时区）
createtime
True
String($date-time)
委托时间（UTC时区）
basecurrency
True
String
基础货币
quotecurrency
True
String
计价货币
Response JSON：
{
"code": "string",
"msg": "string",
"ts": 0,
"data": {
"orderid": 0,
"ordertype": 0,
"direction": 0,
"price": 0,
"amount": 0,
"transactionamount": 0,
"fee": 0,
"symbol": "string",
"orderstatus": 0,
"updatetime": "2018-08-27T08:27:00.005Z",
"createtime": "2018-08-27T08:27:00.005Z",
"basecurrency": "string",
"quotecurrency": "string"
}
}
-
GET /v1/order/orders 查询用户当前委托、或历史委托订单
请求参数：
参数名称
是否必须
类型
描述
默认值
取值范围
OrderID
False
Integer($int64)
订单ID
OrderType
False
String
订单类型
Limit：限价单，Market：市价单
OrderStatus
False
String
订单状态
(0:已提交，1:部分成交，2:已撤单，3:全部成交，4:部分成交已撤单，5：系统自动撤单)
例如：查询进行中的订单传0,1
Symbol
False
String
交易对
btcusdt, bchbtc, rcneth …
Direction
False
String
交易方向
Buy：买入, Sell：卖出
StartTime
False
String
委托开始时间（UTC）
EndTime
False
String
委托结束时间（UTC）
PageIndex
False
Integer($int32)
当前页
1
PageSize
False
Integer($int32)
页大小
30
[30~500]
AccessKey
True
String
API访问KEY
SignatureMethod
True
String
签名方法
HmacSHA256
此处使用：HmacSHA256
SignatureVersion
True
String
签名版本
1
此处使用：1
RandStr
True
String
随机字符串
Timestamp
True
Integer($int64)
时间戳（UTC时区）
Signature
True
String
签名结果（非签名字段）
请求实例：
GET /v1/order/orders?OrderID=1000300224&OrderType=Limit&OrderStatus=0,1&Symbol=btcusdt&Direction=Buy&StartTime=2018-08-27T08:38:56.003Z& EndTime=2018-08-28T08:38:56.003Z&PageIndex=1&PageSize=30&AccessKey=e12b3b62-8a2a-4bb0-a526-a63695485113&SignatureMethod=HmacSHA256&SignatureVersion=1&RandStr=89320394&Timestamp=1534409404916&Signature=xxxxxxxxxxxxxxxxxxxxx
响应参数：
参数名称
是否必须
类型
描述
取值范围
code
True
String
请求处理响应码
msg
True
String
请求处理响应消息
ts
True
Integer($int64)
服务器响应时间戳(UTC,毫秒)
data
True
Object
成功返回订单信息
data数据结构说明
currentpageindex
True
Integer($int32)
当前页
pagesize
True
Integer($int32)
页大小
totalitemcount
True
Integer($int32)
总记录数
totalpagecount
True
Integer($int32)
总页数
haspreviouspage
True
Bool
是否有上一页
hasnextpage
True
Bool
是否有下一页
pagedata
True
Object
分页数据
pagedata数据结构说明
orderid
True
Integer($int64)
订单ID
ordertype
True
Integer($int32)
订单类型(1:限价单,2:市价单,3:止盈止损单)
direction
True
Integer($int32)
交易方向(1:买入,-1:卖出)
price
True
Number($double)
委托价
amount
True
Number($double)
委托量
transactionamount
True
Number($double)
成交量
fee
True
Number($double)
手续费率
symbol
True
String
交易对
btcusdt, bchbtc, rcneth …
orderstatus
True
Integer($int32)
订单状态
订单状态(0:已提交，1:部分成交，2:已撤单，3:全部成交，4:部分成交已撤单，5：系统自动撤单)
updatetime
True
String($date-time)
最后成交时间（UTC时区）
createtime
True
String($date-time)
委托时间 （UTC时区）
basecurrency
True
String
基础货币
quotecurrency
True
String
计价货币
Response JSON：
{
"code": "string",
"msg": "string",
"ts": 0,
"data": {
"currentpageindex": 0,
"pagesize": 0,
"totalitemcount": 0,
"totalpagecount": 0,
"haspreviouspage": true,
"hasnextpage": true,
"pagedata": [
{
"orderid": 0,
"ordertype": 0,
"direction": 0,
"price": 0,
"amount": 0,
"transactionamount": 0,
"fee": 0,
"symbol": "string",
"orderstatus": 0,
"updatetime": "2018-08-27T08:38:56.003Z",
"createtime": "2018-08-27T08:38:56.003Z",
"basecurrency": "string",
"quotecurrency": "string"
}
]
}
}
-
POST /v1/user/withdraw/create 申请提币
请求参数：
参数名称
是否必须
类型
描述
默认值
取值范围
Currency
True
String
币种
btc, eth, ont ...
Address
True
String
提币地址
Amount
True
Number($double)
提币数量
Fee
False
Number($double)
手续费
AddressTag
False
String
地址标签
AccessKey
True
String
API访问KEY
SignatureMethod
True
String
签名方法
HmacSHA256
此处使用：HmacSHA256
SignatureVersion
True
String
签名版本
1
此处使用：1
RandStr
True
String
随机字符串
Timestamp
True
Integer($int64)
时间戳（UTC时区）
Signature
True
String
签名结果（非签名字段）
请求实例：
POST /v1/user/withdraw/create {
"currency": "btc",
"address": "13QtP7x9kbhyJCrf3UeHNgUEMoHbXhEvSt",
"amount": 10,
"fee": 0,
"addresstag": "",
"accesskey": "e12b3b62-8a2a-4bb0-a526-a63695485113",
"signaturemethod": "HmacSHA256",
"signatureversion": "1",
"randstr": "89320394",
"timestamp": 1534409404916,
"signature": "xxxxxxxxxxxxxxxxxxxxx"
}
响应参数：
参数名称
是否必须
类型
描述
取值范围
code
True
String
请求处理响应码
msg
True
String
请求处理响应消息
ts
True
Integer($int64)
服务器响应时间戳(UTC,毫秒)
data
True
Object
成功返回订单信息
data数据结构说明
succeed
True
Bool
true:操作成功,false:操作失败
withdrawid
True
Integer($int64)
提币ID
Response JSON：
{
"code": "string",
"msg": "string",
"ts": 0,
"data": {"succeed":true, "withdrawid":15320993902}
}
-
POST /v1/user/withdraw/revoke 撤销提币申请
请求参数：
参数名称
是否必须
类型
描述
默认值
取值范围
WithdrawID
True
Integer($int64)
提币ID
AccessKey
True
String
API访问KEY
SignatureMethod
True
String
签名方法
HmacSHA256
此处使用：HmacSHA256
SignatureVersion
True
String
签名版本
1
此处使用：1
RandStr
True
String
随机字符串
Timestamp
True
Integer($int64)
时间戳（UTC时区）
Signature
True
String
签名结果（非签名字段）
请求实例：
POST /v1/user/withdraw/revoke {
"withdrawid": 245038294992,
"accesskey": "e12b3b62-8a2a-4bb0-a526-a63695485113",
"signaturemethod": "HmacSHA256",
"signatureversion": "1",
"randstr": "89320394",
"timestamp": 1534409404916,
"signature": "xxxxxxxxxxxxxxxxxxxxx"
}
响应参数：
参数名称
是否必须
类型
描述
取值范围
code
True
String
请求处理响应码
msg
True
String
请求处理响应消息
ts
True
Integer($int64)
服务器响应时间戳(UTC,毫秒)
data
True
Object
成功返回订单信息
data数据结构说明
succeed
True
Bool
true:操作成功,false:操作失败
Response JSON：
{
"code": "string",
"msg": "string",
"ts": 0,
"data": {}
}
-
GET /v1/user/query/deposit-withdraw 查询充提记录
请求参数：
参数名称
是否必须
类型
描述
默认值
取值范围
Currency
True
String
币种
Type
True
String
类型
deposit：充值 、withdraw：提币
PageIndex
False
Integer($int32)
当前页
1
PageSize
False
Integer($int32)
页大小
30
[30~500]
AccessKey
True
String
API访问KEY
SignatureMethod
True
String
签名方法
HmacSHA256
此处使用：HmacSHA256
SignatureVersion
True
String
签名版本
1
此处使用：1
RandStr
True
String
随机字符串
Timestamp
True
Integer($int64)
时间戳（UTC时区）
Signature
True
String
签名结果（非签名字段）
请求实例：
GET /v1/user/query/deposit-withdraw?Currency=btc&Type=deposit&PageIndex=1&PageSize=30&AccessKey=e12b3b62-8a2a-4bb0-a526-a63695485113&SignatureMethod=HmacSHA256&SignatureVersion=1&RandStr=89320394&Timestamp=1534409404916&Signature=xxxxxxxxxxxxxxxxxxxxx
响应参数：
参数名称
是否必须
类型
描述
取值范围
code
True
String
请求处理响应码
msg
True
String
请求处理响应消息
ts
True
Integer($int64)
服务器响应时间戳(UTC,毫秒)
data
True
Object
成功返回订单信息
data数据结构说明
currentpageindex
True
Integer($int32)
当前页
pagesize
True
Integer($int32)
页大小
totalitemcount
True
Integer($int32)
总记录数
totalpagecount
True
Integer($int32)
总页数
haspreviouspage
True
Bool
是否有上一页
hasnextpage
True
Bool
是否有下一页
pagedata
True
Object
分页数据
pagedata数据结构说明
id
True
Integer($int64)
提币ID/充值ID
type
True
String
类型
deposit：充值 、withdraw：提币
currency
True
String
币种
btc, eth, ont ...
txhash
True
String
交易哈希
amount
True
Number($double)
量
factamount
True
Number($double)
成功到账量
address
True
String
地址
addresstag
True
String
地址标签
comfirmnode
True
Integer($int32)
确认节点数
fee
True
Number($double)
手续费
status
True
Integer($int32)
充值/提币状态
充币状态（0:待处理,1:充币成功,2:充币失败）
提币状态（0:待处理,1:提币成功,2:提币失败,3:提币审核中,4:审核不通过,5:已撤销）
updatetime
True
String($date-time)
最后成交时间（UTC时区）
createtime
True
String($date-time)
委托时间 （UTC时区）
Response JSON：
{
"code": "string",
"msg": "string",
"ts": 0,
"data": {
"currentpageindex": 0,
"pagesize": 0,
"totalitemcount": 0,
"totalpagecount": 0,
"haspreviouspage": true,
"hasnextpage": true,
"pagedata": [
{
"id": 0,
"type": "string",
"currency": "string",
"txhash": "string",
"amount": 0,
"factamount": 0,
"address": "string",
"addresstag": "string",
"comfirmnode": 0,
"fee": 0,
"status": 0,
"createtime": "2018-08-27T09:01:06.686Z",
"updatetime": "2018-08-27T09:01:06.686Z"
}
]
}
}
-
四、 响应代码
代码
说明
备注
200
业务执行成功
-1
业务执行失败
-99
系统异常
-40001
授权错误
-40003
缺少必要的参数
-40004
非法参数(类型错误)
-5001
数据签名校验失败
-9000
错误的请求
-9001
参数取值范围错误
-9002
交易对不存在
-9003
币种不存在
-9004
错误的日期格式
-9005
余额不足无法冻结
-9006
错误的签名方法
9000
请求数据有效
1.TMT观察网遵循行业规范，任何转载的稿件都会明确标注作者和来源；
2.TMT观察网的原创文章，请转载时务必注明文章作者和"来源：TMT观察网"，不尊重原创的行为TMT观察网或将追究责任；
3.作者投稿可能会经TMT观察网编辑修改或补充。
