1111區(qū)塊鏈
ont ... txhash True String 交易哈希 amount True Number($double) 量 factamount True Number($double) 成功到賬量 address True String 地址 addresstag True String 地址標(biāo)簽 comfirmnode True Integer($int32) 確認(rèn)節(jié)點(diǎn)數(shù) fee T。
一、 REST API簡(jiǎn)介
HEX交易平臺(tái)API目的為平臺(tái)用戶提供一套獨(dú)立的API,可以幫助用戶快速接入HEX交易系統(tǒng),實(shí)現(xiàn)程序化交易。
swagger地址:https://open.hex.com/swagger/index.html
API正式地址:https://open.hex.com
測(cè)試賬戶與密鑰:請(qǐng)至主站 hex.com 注冊(cè)為平臺(tái)用戶,然后在用戶中心API欄目中自行申請(qǐng),審核通過(guò)后,即可獲得API AccessKey、SecretKey。
這兩個(gè)密鑰與賬號(hào)安全緊密相關(guān),無(wú)論何時(shí)都請(qǐng)勿向其它人透露。
通過(guò)OPEN API可以實(shí)現(xiàn)以下功能:
1、市場(chǎng)行情信息查詢(K線、深度、實(shí)時(shí)成交、24小時(shí)行情等);
2、賬戶資產(chǎn)信息查詢;
3、下單、撤單操作;
4、訂單信息、充提記錄查詢;
二、 簽名認(rèn)證&請(qǐng)求說(shuō)明
通過(guò)用戶中心獲取到API AccessKey以及SecretKey,接口的安全性驗(yàn)證基于這兩個(gè)字段進(jìn)行簽名與驗(yàn)簽。目前服務(wù)端接口只校驗(yàn)請(qǐng)求參數(shù)的合法性,以防止數(shù)據(jù)被篡改,應(yīng)答數(shù)據(jù)暫未加密返回。
目前服務(wù)器端只接收HttpGet、HttpPost的請(qǐng)求,其中HttpPost采用json數(shù)據(jù)格式提交至服務(wù)器端,并且POST接口方法本身參數(shù)不參與簽名計(jì)算,只需將通用參數(shù)做參數(shù)簽名即可。HttpGet采用請(qǐng)求地址傳遞參數(shù),必填參數(shù)與通用參數(shù)必須參與簽名,另外有默認(rèn)值的參數(shù)可以不傳遞,不傳遞系統(tǒng)將采用默認(rèn)參數(shù)賦值并不參與簽名,如有傳遞,系統(tǒng)將會(huì)把此參數(shù)加入到簽名參數(shù)中參與簽名,另外系統(tǒng)統(tǒng)一采用https請(qǐng)求,服務(wù)器應(yīng)答統(tǒng)一json格式輸出。
HttpGet & HttpPost調(diào)用對(duì)比 |
||
Method |
HttpGet |
HttpPost |
Content-Type |
application/x-www-form-urlencoded |
application/json |
參數(shù)傳遞方式 |
地址欄傳值 |
Body |
簽名字段 |
必填 有參數(shù)值的參數(shù) |
通用參數(shù) |
通用參數(shù) |
|||
參數(shù) |
是否必填 |
類(lèi)型/默認(rèn)值 |
說(shuō)明 |
AccessKey |
True |
String |
API 訪問(wèn)密鑰您申請(qǐng)的 API 中的AccessKey。 |
SignatureMethod |
True |
String/MD5 |
簽名方法,此處使用 MD5 |
SignatureVersion |
True |
String/1 |
簽名版本,簽名協(xié)議的版本,此處使用1 |
RandStr |
True |
String |
隨機(jī)字符串,建議使用GUID,保證唯一性 |
Timestamp |
True |
Integer($int64) |
發(fā)出請(qǐng)求的時(shí)間戳 (UTC 時(shí)區(qū)) |
簽名計(jì)算:
Signature=MD5(urlencode(sortedlist(p1=xxx&p2=xxx&...&secretkey=您的密鑰).lower(),'utf-8'))
Signature:簽名計(jì)算后的結(jié)果(32位長(zhǎng)度的字符串,此參數(shù)必須傳遞到請(qǐng)求中,服務(wù)器端通過(guò)此參數(shù)驗(yàn)證請(qǐng)求的合法性)
MD5():加密方法,請(qǐng)勿遺漏;
urlencode():參數(shù)字符串編碼方式,采用utf-8編碼;
sortedlist():以參數(shù)的字母升序排序(a-z);
lower():字符串轉(zhuǎn)小寫(xiě);
以上計(jì)算公式為偽代碼,具體簽名方式請(qǐng)看代碼實(shí)例。
示例:請(qǐng)求接口 GET /v1/order/detail
AccessKey = 2cc8fdcd-462d-40cf-bde0-a240f0b02508
SecretKey = 2d8f4982-3b15-43d3-aaec-99444e8cc7ce
RandStr = 89320394
Timestamp = 1534409404916
OrderID = 1000300224
Signature 計(jì)算過(guò)程:
1:參數(shù)拼接 sortedlist().tolower() 之后的結(jié)果為:
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')
之后的結(jié)果為:
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')
之后的結(jié)果為:
23da2f23886db136ab280e9cb28aa5f5
4:最終請(qǐng)求地址為:
GET /v1/order/detail?OrderID=1000300224&AccessKey=2cc8fdcd-462d-40cf-bde0-a240f0b02508&RandStr=89320394&Timestamp=1534409404916&Signature=23da2f23886db136ab280e9cb28aa5f5
三、 API Reference
接口列表
接口數(shù)據(jù)類(lèi)型 |
請(qǐng)求方法 |
類(lèi)型 |
描述 |
需要驗(yàn)簽 |
市場(chǎng)行情 |
GET /market/history.kline |
GET |
K線 |
Yes |
市場(chǎng)行情 |
GET /market/detail.merged |
GET |
單個(gè)symbol滾動(dòng)24小時(shí)交易和最優(yōu)報(bào)價(jià)聚合行情 |
Yes |
市場(chǎng)行情 |
GET /market/detail |
GET |
Yes |
|
市場(chǎng)行情 |
GET /market/tickers |
GET |
全部symbol的交易行情 |
Yes |
市場(chǎng)行情 |
GET /market/depth |
GET |
Yes |
|
市場(chǎng)行情 |
GET /market/trade |
GET |
Yes |
|
市場(chǎng)行情 |
GET /market/history.trade |
GET |
單個(gè)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 |
查詢當(dāng)前系統(tǒng)時(shí)間(UTC時(shí)間戳) |
Yes |
賬戶 |
GET /v1/account/accounts |
GET |
查詢用戶的所有賬戶狀態(tài) |
Yes |
賬戶 |
GET /v1/account/balance |
GET |
查詢指定賬戶余額 |
Yes |
交易 |
POST /v1/order/create | POST |
下單 |
Yes |
交易 |
POST /v1/order/cancel | POST |
撤銷(xiāo)一個(gè)訂單 |
Yes |
交易 |
POST /v1/order/batch.cancel | POST |
按orderid批量撤銷(xiāo)訂單(max:30) |
Yes |
用戶訂單 |
GET /v1/order/detail | GET |
根據(jù)orderid查詢訂單詳情 |
Yes |
用戶訂單 |
GET /v1/order/orders | GET |
查詢用戶當(dāng)前委托、或歷史委托訂單 |
Yes |
申請(qǐng)?zhí)釒? |
POST /v1/user/withdraw/create | POST |
申請(qǐng)?zhí)釒? |
Yes |
撤銷(xiāo)提幣 |
POST /v1/user/withdraw/revoke | POST |
撤銷(xiāo)提幣申請(qǐng) |
Yes |
查詢充提 |
GET /v1/user/query/deposit-withdraw | GET |
查詢充提記錄 |
Yes |
-
GET /market/history.kline K線
請(qǐng)求參數(shù):
參數(shù)名稱(chēng)
是否必須
類(lèi)型
描述
默認(rèn)值
取值范圍
Symbol
True
String
交易對(duì)
btcusdt, bchbtc, rcneth …
Period
True
String
K線類(lèi)型
1min, 5min, 15min, 30min, 60min, 1day,1week, 1mon
Size
False
Integer($int32)
獲取數(shù)量
500
[1~1000]
AccessKey
True
String
API訪問(wèn)KEY
SignatureMethod
True
String
簽名方法
HmacSHA256
此處使用:HmacSHA256
SignatureVersion
True
String
簽名版本
1
此處使用:1
RandStr
True
String
隨機(jī)字符串
Timestamp
True
Integer($int64)
時(shí)間戳(UTC時(shí)區(qū))
Signature
True
String
簽名結(jié)果(非簽名字段)
請(qǐng)求實(shí)例:
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
響應(yīng)數(shù)據(jù):
參數(shù)名稱(chēng)
是否必須
類(lèi)型
描述
取值范圍
code
True
String
請(qǐng)求處理響應(yīng)碼
msg
True
String
請(qǐng)求處理響應(yīng)消息
ts
True
Integer($int64)
服務(wù)器響應(yīng)時(shí)間戳(UTC,毫秒)
data
True
Object
響應(yīng)數(shù)據(jù)
data數(shù)據(jù)結(jié)構(gòu)說(shuō)明
symbol
True
String
交易對(duì)
btcusdt, bchbtc, rcneth …
amount
True
Number($double)
成交量
open
True
Number($double)
開(kāi)盤(pán)價(jià)
close
True
Number($double)
收盤(pán)價(jià)(當(dāng)K線為最晚的一根時(shí),是最新成交價(jià))
low
True
Number($double)
最低價(jià)
high
True
Number($double)
最高價(jià)
ts
True
Integer($int64)
時(shí)間戳
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 單個(gè)symbol滾動(dòng)24小時(shí)交易和最優(yōu)報(bào)價(jià)聚合行情
請(qǐng)求參數(shù):
參數(shù)名稱(chēng)
是否必須
類(lèi)型
描述
默認(rèn)值
取值范圍
Symbol
True
String
交易對(duì)
btcusdt, bchbtc, rcneth …
AccessKey
True
String
API訪問(wèn)KEY
SignatureMethod
True
String
簽名方法
HmacSHA256
此處使用:HmacSHA256
SignatureVersion
True
String
簽名版本
1
此處使用:1
RandStr
True
String
隨機(jī)字符串
Timestamp
True
Integer($int64)
時(shí)間戳(UTC時(shí)區(qū))
Signature
True
String
簽名結(jié)果(非簽名字段)
請(qǐng)求實(shí)例:
GET /market/detail.merged?Symbol=btcusdt&AccessKey=e12b3b62-8a2a-4bb0-a526-a63695485113&SignatureMethod=HmacSHA256&SignatureVersion=1&RandStr=89320394&Timestamp=1534409404916&Signature=xxxxxxxxxxxxxxxxxxxxx
響應(yīng)參數(shù):
參數(shù)名稱(chēng)
是否必須
類(lèi)型
描述
取值范圍
code
True
String
請(qǐng)求處理響應(yīng)碼
msg
True
String
請(qǐng)求處理響應(yīng)消息
ts
True
Integer($int64)
服務(wù)器響應(yīng)時(shí)間戳(UTC,毫秒)
data
True
Object
響應(yīng)數(shù)據(jù)
data數(shù)據(jù)結(jié)構(gòu)說(shuō)明
symbol
True
String
交易對(duì)
btcusdt, bchbtc, rcneth …
amount
True
Number($double)
成交量
open
True
Number($double)
開(kāi)盤(pán)價(jià)
close
True
Number($double)
收盤(pán)價(jià)(當(dāng)K線為最晚的一根時(shí),是最新成交價(jià))
low
True
Number($double)
最低價(jià)
high
True
Number($double)
最高價(jià)
ts
True
Integer($int64)
時(shí)間戳
bid
True
Object
買(mǎi)賣(mài)信息{price:價(jià)格,amount:量}
ask
True
Object
買(mǎi)賣(mài)信息{price:價(jià)格,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 單個(gè)symbol滾動(dòng)24小時(shí)交易聚合行情
請(qǐng)求參數(shù):
參數(shù)名稱(chēng)
是否必須
類(lèi)型
描述
默認(rèn)值
取值范圍
Symbol
True
String
交易對(duì)
btcusdt, bchbtc, rcneth …
AccessKey
True
String
API訪問(wèn)KEY
SignatureMethod
True
String
簽名方法
HmacSHA256
此處使用:HmacSHA256
SignatureVersion
True
String
簽名版本
1
此處使用:1
RandStr
True
String
隨機(jī)字符串
Timestamp
True
Integer($int64)
時(shí)間戳(UTC時(shí)區(qū))
Signature
True
String
簽名結(jié)果(非簽名字段)
請(qǐng)求實(shí)例:
GET /market/detail?Symbol=btcusdt&AccessKey=e12b3b62-8a2a-4bb0-a526-a63695485113&SignatureMethod=HmacSHA256&SignatureVersion=1&RandStr=89320394&Timestamp=1534409404916&Signature=xxxxxxxxxxxxxxxxxxxxx
響應(yīng)參數(shù):
參數(shù)名稱(chēng)
是否必須
類(lèi)型
描述
取值范圍
code
True
String
請(qǐng)求處理響應(yīng)碼
msg
True
String
請(qǐng)求處理響應(yīng)消息
ts
True
Integer($int64)
服務(wù)器響應(yīng)時(shí)間戳(UTC,毫秒)
data
True
Object
響應(yīng)數(shù)據(jù)
data數(shù)據(jù)結(jié)構(gòu)說(shuō)明
symbol
True
String
交易對(duì)
btcusdt, bchbtc, rcneth …
amount
True
Number($double)
成交量
open
True
Number($double)
開(kāi)盤(pán)價(jià)
close
True
Number($double)
收盤(pán)價(jià)(當(dāng)K線為最晚的一根時(shí),是最新成交價(jià))
low
True
Number($double)
最低價(jià)
high
True
Number($double)
最高價(jià)
ts
True
Integer($int64)
時(shí)間戳
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的交易行情
請(qǐng)求參數(shù):
參數(shù)名稱(chēng)
是否必須
類(lèi)型
描述
默認(rèn)值
取值范圍
AccessKey
True
String
API訪問(wèn)KEY
SignatureMethod
True
String
簽名方法
HmacSHA256
此處使用:HmacSHA256
SignatureVersion
True
String
簽名版本
1
此處使用:1
RandStr
True
String
隨機(jī)字符串
Timestamp
True
Integer($int64)
時(shí)間戳(UTC時(shí)區(qū))
Signature
True
String
簽名結(jié)果(非簽名字段)
請(qǐng)求實(shí)例:
GET /market/tickers?AccessKey=e12b3b62-8a2a-4bb0-a526-a63695485113&SignatureMethod=HmacSHA256&SignatureVersion=1&RandStr=89320394&Timestamp=1534409404916&Signature=xxxxxxxxxxxxxxxxxxxxx
響應(yīng)數(shù)據(jù):
參數(shù)名稱(chēng)
是否必須
類(lèi)型
描述
取值范圍
code
True
String
請(qǐng)求處理響應(yīng)碼
msg
True
String
請(qǐng)求處理響應(yīng)消息
ts
True
Integer($int64)
服務(wù)器響應(yīng)時(shí)間戳(UTC,毫秒)
data
True
List[Object]
響應(yīng)數(shù)據(jù)
data數(shù)據(jù)結(jié)構(gòu)說(shuō)明
symbol
True
String
交易對(duì)
btcusdt, bchbtc, rcneth …
amount
True
Number($double)
成交量
open
True
Number($double)
開(kāi)盤(pán)價(jià)
close
True
Number($double)
收盤(pán)價(jià)(當(dāng)K線為最晚的一根時(shí),是最新成交價(jià))
low
True
Number($double)
最低價(jià)
high
True
Number($double)
最高價(jià)
ts
True
Integer($int64)
時(shí)間戳
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 單個(gè)symbol市場(chǎng)深度行情
請(qǐng)求參數(shù):
參數(shù)名稱(chēng)
是否必須
類(lèi)型
描述
默認(rèn)值
取值范圍
Symbol
True
String
交易對(duì)
btcusdt, bchbtc, rcneth …
Type
True
String
Depth類(lèi)型
step0,step1,step2,step3,step4,step5(合并深度0-5); step0時(shí),不合并深度;
AccessKey
True
String
API訪問(wèn)KEY
SignatureMethod
True
String
簽名方法
HmacSHA256
此處使用:HmacSHA256
SignatureVersion
True
String
簽名版本
1
此處使用:1
RandStr
True
String
隨機(jī)字符串
Timestamp
True
Integer($int64)
時(shí)間戳(UTC時(shí)區(qū))
Signature
True
String
簽名結(jié)果(非簽名字段)
請(qǐng)求實(shí)例:
GET /market/depth?Symbol=btcusdt&Type=step1&AccessKey=e12b3b62-8a2a-4bb0-a526-a63695485113&SignatureMethod=HmacSHA256&SignatureVersion=1&RandStr=89320394&Timestamp=1534409404916&Signature=xxxxxxxxxxxxxxxxxxxxx
響應(yīng)數(shù)據(jù):
參數(shù)名稱(chēng)
是否必須
類(lèi)型
描述
取值范圍
code
True
String
請(qǐng)求處理響應(yīng)碼
msg
True
String
請(qǐng)求處理響應(yīng)消息
ts
True
Integer($int64)
服務(wù)器響應(yīng)時(shí)間戳(UTC,毫秒)
data
True
Object
響應(yīng)數(shù)據(jù)
data數(shù)據(jù)結(jié)構(gòu)說(shuō)明
bids
True
List[Object]
買(mǎi)盤(pán)信息[{price:成交價(jià),amount:成交量}] 按price降序
asks
True
List[Object]
賣(mài)盤(pán)信息[{price:成交價(jià),amount:成交量}] 按price升序
ts
True
Integer($int64)
時(shí)間戳
Response JSON:
{
"code": "string",
"msg": "string",
"ts": 0,
"data": {
"ts": 0,
"bids": [
{
"price": 0,
"amount": 0
}
],
"asks": [
{
"price": 0,
"amount": 0
}
]
}
}
-
GET /market/trade 單個(gè)symbol最新成交記錄
請(qǐng)求參數(shù):
參數(shù)名稱(chēng)
是否必須
類(lèi)型
描述
默認(rèn)值
取值范圍
Symbol
True
String
交易對(duì)
btcusdt, bchbtc, rcneth …
AccessKey
True
String
API訪問(wèn)KEY
SignatureMethod
True
String
簽名方法
HmacSHA256
此處使用:HmacSHA256
SignatureVersion
True
String
簽名版本
1
此處使用:1
RandStr
True
String
隨機(jī)字符串
Timestamp
True
Integer($int64)
時(shí)間戳(UTC時(shí)區(qū))
Signature
True
String
簽名結(jié)果(非簽名字段)
請(qǐng)求參數(shù):
GET /market/trade?Symbol=btcusdt&AccessKey=e12b3b62-8a2a-4bb0-a526-a63695485113&SignatureMethod=HmacSHA256&SignatureVersion=1&RandStr=89320394&Timestamp=1534409404916&Signature=xxxxxxxxxxxxxxxxxxxxx
響應(yīng)參數(shù):
參數(shù)名稱(chēng)
是否必須
類(lèi)型
描述
取值范圍
code
True
String
請(qǐng)求處理響應(yīng)碼
msg
True
String
請(qǐng)求處理響應(yīng)消息
ts
True
Integer($int64)
服務(wù)器響應(yīng)時(shí)間戳(UTC,毫秒)
data
True
Object
響應(yīng)數(shù)據(jù)
data數(shù)據(jù)結(jié)構(gòu)說(shuō)明
price
True
Number($double)
成交價(jià)
amount
True
Number($double)
成交量
direction
True
Integer($int32)
主動(dòng)成交方向(1:買(mǎi)入,-1:賣(mài)出)
[1,-1]
ts
True
Integer($int64)
時(shí)間戳
Response JSON:
{
"code": "string",
"msg": "string",
"ts": 0,
"data": {
"price": 0,
"amount": 0,
"direction": 0,
"ts": 0
}
}
-
GET /market/history.trade 單個(gè)symbol批量成交記錄
請(qǐng)求參數(shù):
參數(shù)名稱(chēng)
是否必須
類(lèi)型
描述
默認(rèn)值
取值范圍
Symbol
True
String
交易對(duì)
btcusdt, bchbtc, rcneth …
Size
False
Integer($int32)
獲取交易記錄的數(shù)量
1
[1~1000]
AccessKey
True
String
API訪問(wèn)KEY
SignatureMethod
True
String
簽名方法
HmacSHA256
此處使用:HmacSHA256
SignatureVersion
True
String
簽名版本
1
此處使用:1
RandStr
True
String
隨機(jī)字符串
Timestamp
True
Integer($int64)
時(shí)間戳(UTC時(shí)區(qū))
Signature
True
String
簽名結(jié)果(非簽名字段)
請(qǐng)求實(shí)例:
GET /market/history.trade?Symbol=btcusdt&Size=200&AccessKey=e12b3b62-8a2a-4bb0-a526-a63695485113&SignatureMethod=HmacSHA256&SignatureVersion=1&RandStr=89320394&Timestamp=1534409404916&Signature=xxxxxxxxxxxxxxxxxxxxx
響應(yīng)參數(shù):
參數(shù)名稱(chēng)
是否必須
類(lèi)型
描述
取值范圍
code
True
String
請(qǐng)求處理響應(yīng)碼
msg
True
String
請(qǐng)求處理響應(yīng)消息
ts
True
Integer($int64)
服務(wù)器響應(yīng)時(shí)間戳(UTC,毫秒)
data
True
List[Object]
響應(yīng)數(shù)據(jù)
data數(shù)據(jù)結(jié)構(gòu)說(shuō)明
price
True
Number($double)
成交價(jià)
amount
True
Number($double)
成交量
direction
True
Integer($int32)
主動(dòng)成交方向(1:買(mǎi)入,-1:賣(mài)出)
[1,-1]
ts
True
Integer($int64)
時(shí)間戳
Response JSON:
{
"code": "string",
"msg": "string",
"ts": 0,
"data": [
{
"price": 0,
"amount": 0,
"direction": 0,
"ts": 0
}
]
}
-
GET /v1/common/symbols 交易品種的計(jì)價(jià)貨幣和報(bào)價(jià)精度
請(qǐng)求數(shù)據(jù):
參數(shù)名稱(chēng)
是否必須
類(lèi)型
描述
默認(rèn)值
取值范圍
AccessKey
True
String
API訪問(wèn)KEY
SignatureMethod
True
String
簽名方法
HmacSHA256
此處使用:HmacSHA256
SignatureVersion
True
String
簽名版本
1
此處使用:1
RandStr
True
String
隨機(jī)字符串
Timestamp
True
Integer($int64)
時(shí)間戳(UTC時(shí)區(qū))
Signature
True
String
簽名結(jié)果(非簽名字段)
請(qǐng)求實(shí)例:
GET /v1/common/symbols?AccessKey=e12b3b62-8a2a-4bb0-a526-a63695485113&SignatureMethod=HmacSHA256&SignatureVersion=1&RandStr=89320394&Timestamp=1534409404916&Signature=xxxxxxxxxxxxxxxxxxxxx
響應(yīng)參數(shù):
參數(shù)名稱(chēng)
是否必須
類(lèi)型
描述
取值范圍
code
True
String
請(qǐng)求處理響應(yīng)碼
msg
True
String
請(qǐng)求處理響應(yīng)消息
ts
True
Integer($int64)
服務(wù)器響應(yīng)時(shí)間戳(UTC,毫秒)
data
True
List[Object]
響應(yīng)數(shù)據(jù)
data數(shù)據(jù)結(jié)構(gòu)說(shuō)明
id
True
Integer($int64)
交易ID
basecurrency
True
String
基礎(chǔ)幣種
quotecurrency
True
String
計(jì)價(jià)幣種
symbol
True
String
交易對(duì)
priceprecision
True
String
價(jià)格精度位數(shù)(0為個(gè)位)
amountprecision
True
String
數(shù)量精度位數(shù)(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 交易幣種列表
請(qǐng)求參數(shù):
參數(shù)名稱(chēng)
是否必須
類(lèi)型
描述
默認(rèn)值
取值范圍
AccessKey
True
String
API訪問(wèn)KEY
SignatureMethod
True
String
簽名方法
HmacSHA256
此處使用:HmacSHA256
SignatureVersion
True
String
簽名版本
1
此處使用:1
RandStr
True
String
隨機(jī)字符串
Timestamp
True
Integer($int64)
時(shí)間戳(UTC時(shí)區(qū))
Signature
True
String
簽名結(jié)果(非簽名字段)
請(qǐng)求實(shí)例:
GET /v1/common/currencies?AccessKey=e12b3b62-8a2a-4bb0-a526-a63695485113&SignatureMethod=HmacSHA256&SignatureVersion=1&RandStr=89320394&Timestamp=1534409404916&Signature=xxxxxxxxxxxxxxxxxxxxx
響應(yīng)參數(shù):
參數(shù)名稱(chēng)
是否必須
類(lèi)型
描述
取值范圍
code
True
String
請(qǐng)求處理響應(yīng)碼
msg
True
String
請(qǐng)求處理響應(yīng)消息
ts
True
Integer($int64)
服務(wù)器響應(yīng)時(shí)間戳(UTC,毫秒)
data
True
List[Object]
響應(yīng)數(shù)據(jù)
data數(shù)據(jù)結(jié)構(gòu)說(shuō)明
id
True
Integer($int64)
幣種ID
currencyname
True
String
幣種名稱(chēng)
Response JSON:
{
"code": "string",
"msg": "string",
"ts": 0,
"data": [
{
"id": 0,
"currencyname": "string"
}
]
}
-
GET /v1/common/rate 匯率
請(qǐng)求參數(shù):
參數(shù)名稱(chēng)
是否必須
類(lèi)型
描述
默認(rèn)值
取值范圍
AccessKey
True
String
API訪問(wèn)KEY
SignatureMethod
True
String
簽名方法
HmacSHA256
此處使用:HmacSHA256
SignatureVersion
True
String
簽名版本
1
此處使用:1
RandStr
True
String
隨機(jī)字符串
Timestamp
True
Integer($int64)
時(shí)間戳(UTC時(shí)區(qū))
Signature
True
String
簽名結(jié)果(非簽名字段)
請(qǐng)求實(shí)例:
GET /v1/common/rate?AccessKey=e12b3b62-8a2a-4bb0-a526-a63695485113&SignatureMethod=HmacSHA256&SignatureVersion=1&RandStr=89320394&Timestamp=1534409404916&Signature=xxxxxxxxxxxxxxxxxxxxx
響應(yīng)參數(shù):
參數(shù)名稱(chēng)
是否必須
類(lèi)型
描述
取值范圍
code
True
String
請(qǐng)求處理響應(yīng)碼
msg
True
String
請(qǐng)求處理響應(yīng)消息
ts
True
Integer($int64)
服務(wù)器響應(yīng)時(shí)間戳(UTC,毫秒)
data
True
List[Object]
響應(yīng)數(shù)據(jù)
data數(shù)據(jù)結(jié)構(gòu)說(shuō)明
currencyname
True
String
幣種名稱(chēng)
rate
True
Number($double)
匯率
ts
True
Integer($int64)
更新時(shí)間戳
Response JSON:
{
"code": "string",
"msg": "string",
"ts": 0,
"data": [
{
"currencyname": "string",
"rate": 0,
"ts": 0
}
]
}
-
GET /v1/common/timestamp 查詢當(dāng)前系統(tǒng)時(shí)間(UTC時(shí)間戳)
請(qǐng)求參數(shù):
參數(shù)名稱(chēng)
是否必須
類(lèi)型
描述
默認(rèn)值
取值范圍
AccessKey
True
String
API訪問(wèn)KEY
SignatureMethod
True
String
簽名方法
HmacSHA256
此處使用:HmacSHA256
SignatureVersion
True
String
簽名版本
1
此處使用:1
RandStr
True
String
隨機(jī)字符串
Timestamp
True
Integer($int64)
時(shí)間戳(UTC時(shí)區(qū))
Signature
True
String
簽名結(jié)果(非簽名字段)
請(qǐng)求參數(shù):
GET /v1/common/rate?AccessKey=e12b3b62-8a2a-4bb0-a526-a63695485113&SignatureMethod=HmacSHA256&SignatureVersion=1&RandStr=89320394&Timestamp=1534409404916&Signature=xxxxxxxxxxxxxxxxxxxxx
響應(yīng)參數(shù):
參數(shù)名稱(chēng)
是否必須
類(lèi)型
描述
取值范圍
code
True
String
請(qǐng)求處理響應(yīng)碼
msg
True
String
請(qǐng)求處理響應(yīng)消息
ts
True
Integer($int64)
服務(wù)器響應(yīng)時(shí)間戳(UTC,毫秒)
data
True
Object
響應(yīng)數(shù)據(jù)(當(dāng)前系統(tǒng)時(shí)間戳UTC)
Response JSON:
{
"code": "string",
"msg": "string",
"ts": 0,
"data": {}
}
-
GET /v1/account/accounts 查詢用戶的所有賬戶狀態(tài)
請(qǐng)求參數(shù):
參數(shù)名稱(chēng)
是否必須
類(lèi)型
描述
默認(rèn)值
取值范圍
AccessKey
True
String
API訪問(wèn)KEY
SignatureMethod
True
String
簽名方法
HmacSHA256
此處使用:HmacSHA256
SignatureVersion
True
String
簽名版本
1
此處使用:1
RandStr
True
String
隨機(jī)字符串
Timestamp
True
Integer($int64)
時(shí)間戳(UTC時(shí)區(qū))
Signature
True
String
簽名結(jié)果(非簽名字段)
請(qǐng)求實(shí)例:
GET /v1/account/accounts?AccessKey=e12b3b62-8a2a-4bb0-a526-a63695485113&SignatureMethod=HmacSHA256&SignatureVersion=1&RandStr=89320394&Timestamp=1534409404916&Signature=xxxxxxxxxxxxxxxxxxxxx
響應(yīng)參數(shù):
參數(shù)名稱(chēng)
是否必須
類(lèi)型
描述
取值范圍
code
True
String
請(qǐng)求處理響應(yīng)碼
msg
True
String
請(qǐng)求處理響應(yīng)消息
ts
True
Integer($int64)
服務(wù)器響應(yīng)時(shí)間戳(UTC,毫秒)
data
True
List[Object]
響應(yīng)數(shù)據(jù)
data數(shù)據(jù)結(jié)構(gòu)說(shuō)明
userid
True
Integer($int64)
用戶id
type
True
String
賬戶類(lèi)型
status
True
String
賬戶狀態(tài)(pending:審核中,notpass:審核不通過(guò),working:正常,frozen:已凍結(jié))
Response JSON:
{
"code": "string",
"msg": "string",
"ts": 0,
"data": [
{
"userid": 0,
"type": "string",
"status": "string"
}
]
}
-
GET /v1/account/balance 查詢指定賬戶余額
請(qǐng)求參數(shù):
參數(shù)名稱(chēng)
是否必須
類(lèi)型
描述
默認(rèn)值
取值范圍
AccessKey
True
String
API訪問(wèn)KEY
SignatureMethod
True
String
簽名方法
HmacSHA256
此處使用:HmacSHA256
SignatureVersion
True
String
簽名版本
1
此處使用:1
RandStr
True
String
隨機(jī)字符串
Timestamp
True
Integer($int64)
時(shí)間戳(UTC時(shí)區(qū))
Signature
True
String
簽名結(jié)果(非簽名字段)
請(qǐng)求實(shí)例:
GET /v1/account/balance?AccessKey=e12b3b62-8a2a-4bb0-a526-a63695485113&SignatureMethod=HmacSHA256&SignatureVersion=1&RandStr=89320394&Timestamp=1534409404916&Signature=xxxxxxxxxxxxxxxxxxxxx
響應(yīng)參數(shù):
參數(shù)名稱(chēng)
是否必須
類(lèi)型
描述
取值范圍
code
True
String
請(qǐng)求處理響應(yīng)碼
msg
True
String
請(qǐng)求處理響應(yīng)消息
ts
True
Integer($int64)
服務(wù)器響應(yīng)時(shí)間戳(UTC,毫秒)
data
True
List[Object]
響應(yīng)數(shù)據(jù)
data數(shù)據(jù)結(jié)構(gòu)說(shuō)明
currency
True
String
幣種名稱(chēng)
balance
True
Number($double)
余額
frozen
True
Number($double)
凍結(jié)
Response JSON:
{
"code": "string",
"msg": "string",
"ts": 0,
"data": [
{
"currency": "string",
"balance": 0,
"frozen": 0
}
]
}
-
POST /v1/order/create 下單
請(qǐng)求參數(shù):
參數(shù)名稱(chēng)
是否必須
類(lèi)型
描述
默認(rèn)值
取值范圍
Symbol
True
String
交易對(duì)
btcusdt, bchbtc, rcneth …
Amount
True
Number($double)
限價(jià)單表示下單數(shù)量,市價(jià)買(mǎi)單時(shí)表示買(mǎi)多少錢(qián),市價(jià)賣(mài)單時(shí)表示賣(mài)多少幣
OrderType
True
String
訂單類(lèi)型(limit限價(jià)單,market 市價(jià)單)
[Limit,Market]
Direction
True
String
交易方向(buy:買(mǎi),sell:賣(mài))
[Buy,Sell]
Price
False
Number($double)
下單價(jià)格,市價(jià)單不傳該參數(shù)
Source
False
String
訂單來(lái)源
AccessKey
True
String
API訪問(wèn)KEY
SignatureMethod
True
String
簽名方法
HmacSHA256
此處使用:HmacSHA256
SignatureVersion
True
String
簽名版本
1
此處使用:1
RandStr
True
String
隨機(jī)字符串
Timestamp
True
Integer($int64)
時(shí)間戳(UTC時(shí)區(qū))
Signature
True
String
簽名結(jié)果(非簽名字段)
請(qǐng)求實(shí)例:
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"
}
響應(yīng)參數(shù):
參數(shù)名稱(chēng)
是否必須
類(lèi)型
描述
取值范圍
code
True
String
請(qǐng)求處理響應(yīng)碼
msg
True
String
請(qǐng)求處理響應(yīng)消息
ts
True
Integer($int64)
服務(wù)器響應(yīng)時(shí)間戳(UTC,毫秒)
data
True
Integer($int64)
成功返回訂單ID
Response JSON:
{
"code": "string",
"msg": "string",
"ts": 0,
"data": {}
}
-
POST /v1/order/cancel 撤銷(xiāo)一個(gè)訂單
請(qǐng)求參數(shù):
參數(shù)名稱(chēng)
是否必須
類(lèi)型
描述
默認(rèn)值
取值范圍
OrderID
True
Integer($int64)
訂單ID
AccessKey
True
String
API訪問(wèn)KEY
SignatureMethod
True
String
簽名方法
HmacSHA256
此處使用:HmacSHA256
SignatureVersion
True
String
簽名版本
1
此處使用:1
RandStr
True
String
隨機(jī)字符串
Timestamp
True
Integer($int64)
時(shí)間戳(UTC時(shí)區(qū))
Signature
True
String
簽名結(jié)果(非簽名字段)
請(qǐng)求實(shí)例:
POST /v1/order/cancel {
"orderid": 129332000293,
"accesskey": "e12b3b62-8a2a-4bb0-a526-a63695485113",
"signaturemethod": "HmacSHA256",
"signatureversion": "1",
"randstr": "89320394",
"timestamp": 1534409404916,
"signature": "xxxxxxxxxxxxxxxxxxxxx "
}
響應(yīng)參數(shù):
參數(shù)名稱(chēng)
是否必須
類(lèi)型
描述
取值范圍
code
True
String
請(qǐng)求處理響應(yīng)碼
msg
True
String
請(qǐng)求處理響應(yīng)消息
ts
True
Integer($int64)
服務(wù)器響應(yīng)時(shí)間戳(UTC,毫秒)
data
True
Integer($int64)
成功返回訂單ID
Response JSON:
{
"code": "string",
"msg": "string",
"ts": 0,
"data": {}
}
-
POST /v1/order/batch.cancel 按orderid批量撤銷(xiāo)訂單(max:30)
請(qǐng)求參數(shù):
參數(shù)名稱(chēng)
是否必須
類(lèi)型
描述
默認(rèn)值
取值范圍
OrderID
True
List[Integer($int64)]
訂單ID集合
AccessKey
True
String
API訪問(wèn)KEY
SignatureMethod
True
String
簽名方法
HmacSHA256
此處使用:HmacSHA256
SignatureVersion
True
String
簽名版本
1
此處使用:1
RandStr
True
String
隨機(jī)字符串
Timestamp
True
Integer($int64)
時(shí)間戳(UTC時(shí)區(qū))
Signature
True
String
簽名結(jié)果(非簽名字段)
請(qǐng)求實(shí)例:
POST /v1/order/batch.cancel {
"orderid": [
1000300224,
1000300225
],
"accesskey": "e12b3b62-8a2a-4bb0-a526-a63695485113",
"signaturemethod": "HmacSHA256",
"signatureversion": "1",
"randstr": "89320394",
"timestamp": 1534409404916,
"signature": "xxxxxxxxxxxxxxxxxxxxx"
}
響應(yīng)參數(shù):
參數(shù)名稱(chēng)
是否必須
類(lèi)型
描述
取值范圍
code
True
String
請(qǐng)求處理響應(yīng)碼
msg
True
String
請(qǐng)求處理響應(yīng)消息
ts
True
Integer($int64)
服務(wù)器響應(yīng)時(shí)間戳(UTC,毫秒)
data
True
List[Object]
成功返回訂單ID集合
data數(shù)據(jù)結(jié)構(gòu)說(shuō)明
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 根據(jù)orderid查詢訂單詳情
請(qǐng)求參數(shù):
參數(shù)名稱(chēng)
是否必須
類(lèi)型
描述
默認(rèn)值
取值范圍
OrderID
True
Integer($int64)
訂單ID
AccessKey
True
String
API訪問(wèn)KEY
SignatureMethod
True
String
簽名方法
HmacSHA256
此處使用:HmacSHA256
SignatureVersion
True
String
簽名版本
1
此處使用:1
RandStr
True
String
隨機(jī)字符串
Timestamp
True
Integer($int64)
時(shí)間戳(UTC時(shí)區(qū))
Signature
True
String
簽名結(jié)果(非簽名字段)
請(qǐng)求實(shí)例:
GET /v1/order/detail?OrderID=1000300224&AccessKey=e12b3b62-8a2a-4bb0-a526-a63695485113&SignatureMethod=HmacSHA256&SignatureVersion=1&RandStr=89320394&Timestamp=1534409404916&Signature=xxxxxxxxxxxxxxxxxxxxx
響應(yīng)參數(shù):
參數(shù)名稱(chēng)
是否必須
類(lèi)型
描述
取值范圍
code
True
String
請(qǐng)求處理響應(yīng)碼
msg
True
String
請(qǐng)求處理響應(yīng)消息
ts
True
Integer($int64)
服務(wù)器響應(yīng)時(shí)間戳(UTC,毫秒)
data
True
Object
成功返回訂單信息
data數(shù)據(jù)結(jié)構(gòu)說(shuō)明
orderid
True
Integer($int64)
訂單ID
ordertype
True
Integer($int32)
訂單類(lèi)型(1:限價(jià)單,2:市價(jià)單,3:止盈止損單)
direction
True
Integer($int32)
交易方向(1:買(mǎi)入,-1:賣(mài)出)
price
True
Number($double)
委托價(jià)
amount
True
Number($double)
委托量
transactionamount
True
Number($double)
成交量
fee
True
Number($double)
手續(xù)費(fèi)率
symbol
True
String
交易對(duì)
btcusdt, bchbtc, rcneth …
orderstatus
True
Integer($int32)
訂單狀態(tài)
訂單狀態(tài)(0:已提交,1:部分成交,2:已撤單,3:全部成交,4:部分成交已撤單,5:系統(tǒng)自動(dòng)撤單)
updatetime
True
String($date-time)
最后成交時(shí)間(UTC時(shí)區(qū))
createtime
True
String($date-time)
委托時(shí)間(UTC時(shí)區(qū))
basecurrency
True
String
基礎(chǔ)貨幣
quotecurrency
True
String
計(jì)價(jià)貨幣
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 查詢用戶當(dāng)前委托、或歷史委托訂單
請(qǐng)求參數(shù):
參數(shù)名稱(chēng)
是否必須
類(lèi)型
描述
默認(rèn)值
取值范圍
OrderID
False
Integer($int64)
訂單ID
OrderType
False
String
訂單類(lèi)型
Limit:限價(jià)單,Market:市價(jià)單
OrderStatus
False
String
訂單狀態(tài)
(0:已提交,1:部分成交,2:已撤單,3:全部成交,4:部分成交已撤單,5:系統(tǒng)自動(dòng)撤單)
例如:查詢進(jìn)行中的訂單傳0,1
Symbol
False
String
交易對(duì)
btcusdt, bchbtc, rcneth …
Direction
False
String
交易方向
Buy:買(mǎi)入, Sell:賣(mài)出
StartTime
False
String
委托開(kāi)始時(shí)間(UTC)
EndTime
False
String
委托結(jié)束時(shí)間(UTC)
PageIndex
False
Integer($int32)
當(dāng)前頁(yè)
1
PageSize
False
Integer($int32)
頁(yè)大小
30
[30~500]
AccessKey
True
String
API訪問(wèn)KEY
SignatureMethod
True
String
簽名方法
HmacSHA256
此處使用:HmacSHA256
SignatureVersion
True
String
簽名版本
1
此處使用:1
RandStr
True
String
隨機(jī)字符串
Timestamp
True
Integer($int64)
時(shí)間戳(UTC時(shí)區(qū))
Signature
True
String
簽名結(jié)果(非簽名字段)
請(qǐng)求實(shí)例:
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
響應(yīng)參數(shù):
參數(shù)名稱(chēng)
是否必須
類(lèi)型
描述
取值范圍
code
True
String
請(qǐng)求處理響應(yīng)碼
msg
True
String
請(qǐng)求處理響應(yīng)消息
ts
True
Integer($int64)
服務(wù)器響應(yīng)時(shí)間戳(UTC,毫秒)
data
True
Object
成功返回訂單信息
data數(shù)據(jù)結(jié)構(gòu)說(shuō)明
currentpageindex
True
Integer($int32)
當(dāng)前頁(yè)
pagesize
True
Integer($int32)
頁(yè)大小
totalitemcount
True
Integer($int32)
總記錄數(shù)
totalpagecount
True
Integer($int32)
總頁(yè)數(shù)
haspreviouspage
True
Bool
是否有上一頁(yè)
hasnextpage
True
Bool
是否有下一頁(yè)
pagedata
True
Object
分頁(yè)數(shù)據(jù)
pagedata數(shù)據(jù)結(jié)構(gòu)說(shuō)明
orderid
True
Integer($int64)
訂單ID
ordertype
True
Integer($int32)
訂單類(lèi)型(1:限價(jià)單,2:市價(jià)單,3:止盈止損單)
direction
True
Integer($int32)
交易方向(1:買(mǎi)入,-1:賣(mài)出)
price
True
Number($double)
委托價(jià)
amount
True
Number($double)
委托量
transactionamount
True
Number($double)
成交量
fee
True
Number($double)
手續(xù)費(fèi)率
symbol
True
String
交易對(duì)
btcusdt, bchbtc, rcneth …
orderstatus
True
Integer($int32)
訂單狀態(tài)
訂單狀態(tài)(0:已提交,1:部分成交,2:已撤單,3:全部成交,4:部分成交已撤單,5:系統(tǒng)自動(dòng)撤單)
updatetime
True
String($date-time)
最后成交時(shí)間(UTC時(shí)區(qū))
createtime
True
String($date-time)
委托時(shí)間 (UTC時(shí)區(qū))
basecurrency
True
String
基礎(chǔ)貨幣
quotecurrency
True
String
計(jì)價(jià)貨幣
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 申請(qǐng)?zhí)釒?
請(qǐng)求參數(shù):
參數(shù)名稱(chēng)
是否必須
類(lèi)型
描述
默認(rèn)值
取值范圍
Currency
True
String
幣種
btc, eth, ont ...
Address
True
String
提幣地址
Amount
True
Number($double)
提幣數(shù)量
Fee
False
Number($double)
手續(xù)費(fèi)
AddressTag
False
String
地址標(biāo)簽
AccessKey
True
String
API訪問(wèn)KEY
SignatureMethod
True
String
簽名方法
HmacSHA256
此處使用:HmacSHA256
SignatureVersion
True
String
簽名版本
1
此處使用:1
RandStr
True
String
隨機(jī)字符串
Timestamp
True
Integer($int64)
時(shí)間戳(UTC時(shí)區(qū))
Signature
True
String
簽名結(jié)果(非簽名字段)
請(qǐng)求實(shí)例:
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"
}
響應(yīng)參數(shù):
參數(shù)名稱(chēng)
是否必須
類(lèi)型
描述
取值范圍
code
True
String
請(qǐng)求處理響應(yīng)碼
msg
True
String
請(qǐng)求處理響應(yīng)消息
ts
True
Integer($int64)
服務(wù)器響應(yīng)時(shí)間戳(UTC,毫秒)
data
True
Object
成功返回訂單信息
data數(shù)據(jù)結(jié)構(gòu)說(shuō)明
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 撤銷(xiāo)提幣申請(qǐng)
請(qǐng)求參數(shù):
參數(shù)名稱(chēng)
是否必須
類(lèi)型
描述
默認(rèn)值
取值范圍
WithdrawID
True
Integer($int64)
提幣ID
AccessKey
True
String
API訪問(wèn)KEY
SignatureMethod
True
String
簽名方法
HmacSHA256
此處使用:HmacSHA256
SignatureVersion
True
String
簽名版本
1
此處使用:1
RandStr
True
String
隨機(jī)字符串
Timestamp
True
Integer($int64)
時(shí)間戳(UTC時(shí)區(qū))
Signature
True
String
簽名結(jié)果(非簽名字段)
請(qǐng)求實(shí)例:
POST /v1/user/withdraw/revoke {
"withdrawid": 245038294992,
"accesskey": "e12b3b62-8a2a-4bb0-a526-a63695485113",
"signaturemethod": "HmacSHA256",
"signatureversion": "1",
"randstr": "89320394",
"timestamp": 1534409404916,
"signature": "xxxxxxxxxxxxxxxxxxxxx"
}
響應(yīng)參數(shù):
參數(shù)名稱(chēng)
是否必須
類(lèi)型
描述
取值范圍
code
True
String
請(qǐng)求處理響應(yīng)碼
msg
True
String
請(qǐng)求處理響應(yīng)消息
ts
True
Integer($int64)
服務(wù)器響應(yīng)時(shí)間戳(UTC,毫秒)
data
True
Object
成功返回訂單信息
data數(shù)據(jù)結(jié)構(gòu)說(shuō)明
succeed
True
Bool
true:操作成功,false:操作失敗
Response JSON:
{
"code": "string",
"msg": "string",
"ts": 0,
"data": {}
}
-
GET /v1/user/query/deposit-withdraw 查詢充提記錄
請(qǐng)求參數(shù):
參數(shù)名稱(chēng)
是否必須
類(lèi)型
描述
默認(rèn)值
取值范圍
Currency
True
String
幣種
Type
True
String
類(lèi)型
deposit:充值 、withdraw:提幣
PageIndex
False
Integer($int32)
當(dāng)前頁(yè)
1
PageSize
False
Integer($int32)
頁(yè)大小
30
[30~500]
AccessKey
True
String
API訪問(wèn)KEY
SignatureMethod
True
String
簽名方法
HmacSHA256
此處使用:HmacSHA256
SignatureVersion
True
String
簽名版本
1
此處使用:1
RandStr
True
String
隨機(jī)字符串
Timestamp
True
Integer($int64)
時(shí)間戳(UTC時(shí)區(qū))
Signature
True
String
簽名結(jié)果(非簽名字段)
請(qǐng)求實(shí)例:
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
響應(yīng)參數(shù):
參數(shù)名稱(chēng)
是否必須
類(lèi)型
描述
取值范圍
code
True
String
請(qǐng)求處理響應(yīng)碼
msg
True
String
請(qǐng)求處理響應(yīng)消息
ts
True
Integer($int64)
服務(wù)器響應(yīng)時(shí)間戳(UTC,毫秒)
data
True
Object
成功返回訂單信息
data數(shù)據(jù)結(jié)構(gòu)說(shuō)明
currentpageindex
True
Integer($int32)
當(dāng)前頁(yè)
pagesize
True
Integer($int32)
頁(yè)大小
totalitemcount
True
Integer($int32)
總記錄數(shù)
totalpagecount
True
Integer($int32)
總頁(yè)數(shù)
haspreviouspage
True
Bool
是否有上一頁(yè)
hasnextpage
True
Bool
是否有下一頁(yè)
pagedata
True
Object
分頁(yè)數(shù)據(jù)
pagedata數(shù)據(jù)結(jié)構(gòu)說(shuō)明
id
True
Integer($int64)
提幣ID/充值ID
type
True
String
類(lèi)型
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
地址標(biāo)簽
comfirmnode
True
Integer($int32)
確認(rèn)節(jié)點(diǎn)數(shù)
fee
True
Number($double)
手續(xù)費(fèi)
status
True
Integer($int32)
充值/提幣狀態(tài)
充幣狀態(tài)(0:待處理,1:充幣成功,2:充幣失?。?
提幣狀態(tài)(0:待處理,1:提幣成功,2:提幣失敗,3:提幣審核中,4:審核不通過(guò),5:已撤銷(xiāo))
updatetime
True
String($date-time)
最后成交時(shí)間(UTC時(shí)區(qū))
createtime
True
String($date-time)
委托時(shí)間 (UTC時(shí)區(qū))
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"
}
]
}
}
-
四、 響應(yīng)代碼
代碼
說(shuō)明
備注
200
業(yè)務(wù)執(zhí)行成功
-1
業(yè)務(wù)執(zhí)行失敗
-99
系統(tǒng)異常
-40001
授權(quán)錯(cuò)誤
-40003
缺少必要的參數(shù)
-40004
非法參數(shù)(類(lèi)型錯(cuò)誤)
-5001
數(shù)據(jù)簽名校驗(yàn)失敗
-9000
錯(cuò)誤的請(qǐng)求
-9001
參數(shù)取值范圍錯(cuò)誤
-9002
交易對(duì)不存在
-9003
幣種不存在
-9004
錯(cuò)誤的日期格式
-9005
余額不足無(wú)法凍結(jié)
-9006
錯(cuò)誤的簽名方法
9000
請(qǐng)求數(shù)據(jù)有效
1.TMT觀察網(wǎng)遵循行業(yè)規(guī)范,任何轉(zhuǎn)載的稿件都會(huì)明確標(biāo)注作者和來(lái)源;
2.TMT觀察網(wǎng)的原創(chuàng)文章,請(qǐng)轉(zhuǎn)載時(shí)務(wù)必注明文章作者和"來(lái)源:TMT觀察網(wǎng)",不尊重原創(chuàng)的行為T(mén)MT觀察網(wǎng)或?qū)⒆肪控?zé)任;
3.作者投稿可能會(huì)經(jīng)TMT觀察網(wǎng)編輯修改或補(bǔ)充。