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觀察網編輯修改或補充。
