IconCreated with Sketch.

OpenApi 接口文档

  • 新手指引
    • 代码示例
  • 订单服务
    • 杠杆批量下单接口
    • 现货下单接口
    • 现货取消接口
    • 现货批量下单接口V2
  • CMC对接
    • 交易列表接口(Trade)
    • 币对行情接口(Ticker)
    • 币种列表接口(Asset)
    • 盘口数据接口(OrderBook)
  • K线行情
    • WS行情
    • 查询买卖盘深度
    • 查询系统支持的所有交易对及精度
    • 获取K线数据
    • 获取各个币对的最新成交价
    • 获取当前行情
    • 获取所有交易对行情
    • 获取行情成交记录
  • 币币委托
    • 获取全部委托
    • 获取全部成交记录
    • 获取当前委托v3
    • 获取订单详情
  • 杠杆委托
    • 获取杠杆全部成交记录
    • 获取杠杆当前委托
  • 账户资产
    • 用户信息
    • 获取杠杆资产余额
    • 资产余额

OpenApi接口文档

点此前往 新版交易文档

新手指引

代码示例

基本信息

Path: /demo/java

Method: GET

接口描述:

################################### Java版本-生成签名-start ################################
@Test
void test01() {
    String secret = "***密钥***";

    HashMap<String,String> dataMap = new HashMap<String,String>();
    //接口所需参数
    dataMap.put("api_key", "api_key");
    dataMap.put("type", "1");
    dataMap.put("side", "BUY");
    dataMap.put("volume", "10");
    dataMap.put("price", "0.0001");
    dataMap.put("symbol", "btcusdt");
    dataMap.put("time", "1593601408000");
    String sign = "";
    try {
        sign = this.getSign(dataMap, secret);
    } catch (UnsupportedEncodingException e1) {
        e1.printStackTrace();
    }
    System.out.println("签名sign:"+sign);
}

//字典顺序排序map中的key,拼接字符串,securt拼接到最后,MD5 = sign
private String getSign(HashMap<String,String> resultMap, String secret) throws UnsupportedEncodingException {
    Set<String> keys = resultMap.keySet();
    String[] paramArr = keys.toArray(new String[keys.size()]);
    Arrays.sort(paramArr);
    StringBuilder sb = new StringBuilder();
    for(String key : paramArr) {
        String value = resultMap.get(key);
        sb.append(key).append(value);
    }
    String lastStr = sb.toString() + secret;
    String digest = DigestUtils.md5Hex(lastStr.getBytes("UTF-8"));

    return digest;
}
################################### Java版本-生成签名-end ##################################




######################################### curl版本 #########################################
curl -X POST \
  https://openapi.bitwind.com/open/api/create_order \
  -H 'Postman-Token: 957fef75-23a3-b30b-06b1-189676efc5ca' \
  -d 'api_key=api_key&price=5&side=BUY&sign=sign&symbol=btcusdt&time=1566445997732&type=1&volume=1'




######################################### java版本 #########################################
OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/x-www-form-urlencoded");
RequestBody body = RequestBody.create(mediaType, "api_key=api_key&price=5&side=BUY&sign=sign&symbol=btcusdt&time=1566445997732&type=1&volume=1");
Request request = new Request.Builder()
  .url("https://openapi.bitwind.com/open/api/create_order")
  .post(body)
  .addHeader("Content-Type", "application/x-www-form-urlencoded")
  .build();

Response response = client.newCall(request).execute();




######################################### php版本 #########################################
$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://openapi.bitwind.com/open/api/create_order",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "api_key=api_key&price=5&side=BUY&sign=sign&symbol=btcusdt&time=1566445997732&type=1&volume=1",
  CURLOPT_HTTPHEADER => array(
    "Content-Type: application/x-www-form-urlencoded"
  ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}




######################################### python版本 #########################################
import http.client

conn = http.client.HTTPConnection("openapi,bitwind,com")

payload = "api_key=api_key&price=5&side=BUY&sign=sign&symbol=btcusdt&time=1566445997732&type=1&volume=1"

headers = {
    'Content-Type': "application/x-www-form-urlencoded"
    }

conn.request("POST", "open,api,create_order", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))




######################################### go版本 #########################################
package main

import (
  "fmt"
  "strings"
  "net/http"
  "io/ioutil"
)

func main() {

  url := "https://openapi.bitwind.com/open/api/create_order"

  payload := strings.NewReader("api_key=api_key&price=5&side=BUY&sign=sign&symbol=btcusdt&time=1566445997732&type=1&volume=1")

  req, _ := http.NewRequest("POST", url, payload)

  req.Header.Add("Content-Type", "application/x-www-form-urlencoded")

  res, _ := http.DefaultClient.Do(req)

  defer res.Body.Close()
  body, _ := ioutil.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))

}

请求参数

订单服务

杠杆批量下单接口

基本信息

Path: /open/api/margin/mass_replace

Method: POST

接口描述:

mass_place:下单参数。side:方向(买卖方向BUY、SELL)
-------------------------type:类型(1:限价委托、2:市价委托)
-------------------------volume:购买数量(多义,复用字段) type=1:表示买卖数量type=2:买则表示总价格,卖表示总数量
-------------------------price:委托单价,type=2不需要此参数
-------------------------fee_is_user_exchange_coin:(冗余字段)当交易所有平台币时,此参数表示是否使用用平台币

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
mass_place text 否 [{"side":"SELL","type":"1","volume":"1","price":"10","fee_is_user_exchange_coin":"0"}] mass_place:下单参数
symbol text 是 btcusdt 币种 ,例 btcusdt
time text 是 1567415490190 时间戳
sign text 是 sign 签名
api_key text 是 api_key api_key
mass_cancel text 否 [78321,78322,78323] 撤单参数,订单id,多个订单id使用英文逗号分隔

返回数据

名称类型是否必须默认值备注其他信息
codestring必须

mock: 0

msgstring必须

mock: success

dataobject非必须
├─ mass_cancelobject []非必须批量撤单信息

item 类型: object

├─ msgstring必须
├─ codestring必须
├─ order_idnumber必须撤销订单id
├─ mass_placeobject []非必须批量下单信息

item 类型: object

├─ msgstring必须
├─ codestring必须
├─ order_idnumber必须订单id

现货下单接口

基本信息

Path: /open/api/create_order

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
side text 是 SELL 买卖方向BUY、SELL
type text 是 1 挂单类型,1:限价委托、2:市价委托
volume text 是 0.001 购买数量(多义,复用字段) type=1:表示买卖数量 type=2:买则表示总价格,卖表示总数量
symbol text 是 bchusdt 市场标记,bchusdt
time text 是 1567415490190 时间戳
api_key text 是 1174082eaf4002419a0628d77439090c api_key
sign text 是 74da381312ba855f5b03b867ef6d44b4 签名
price text 是 1 委托单价,type=2不需要此参数

返回数据

名称类型是否必须默认值备注其他信息
codestring非必须

mock: 0

msgstring非必须

mock: 成功

dataobject非必须
├─ order_idnumber非必须订单id

现货取消接口

基本信息

Path: /open/api/cancel_order

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
order_id text 是 10001 订单id
symbol text 是 bchusdt 市场标记,bchusdt
api_key text 是 1174082eaf4002419a0628d77439090c api_key
time text 是 1567415490190 时间戳
sign text 是 sign 签名

返回数据

名称类型是否必须默认值备注其他信息
codestring非必须

mock: 0

msgstring非必须

mock: 成功

datastring非必须

mock: ""

现货批量下单接口V2

基本信息

Path: /open/api/mass_replaceV2

Method: POST

接口描述:

mass_place 是需要发送到系统的一批订单,每次最多10条
mass_cancel 是需要撤回的一批订单,每次最多10条

mass_place:下单参数。side:方向(买卖方向BUY、SELL)
-------------------------type:类型(1:限价委托、2:市价委托)
-------------------------volume:购买数量(多义,复用字段) type=1:表示买卖数量type=2:买则表示总价格,卖表示总数量
-------------------------price:委托单价,type=2不需要此参数
-------------------------fee_is_user_exchange_coin:(冗余字段)当交易所有平台币时,此参数表示是否使用用平台币支付手续费,0否,1是

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
mass_place text 否 [{"side":"SELL","type":"1","volume":"1","price":"10","fee_is_user_exchange_coin":"0"}] mass_place:下单参数
symbol text 是 btcusdt 币种 ,例 btcusdt
time text 是 1567415490190 时间戳
sign text 是 sign 签名
api_key text 是 api_key api_key
mass_cancel text 否 [78321,78322,78323] 撤单参数,订单id,多个订单id使用英文逗号分隔

返回数据

名称类型是否必须默认值备注其他信息
codestring必须

mock: 0

msgstring必须

mock: success

dataobject非必须
├─ mass_cancelobject []非必须批量撤单信息

item 类型: object

├─ msgstring必须
├─ codestring必须
├─ order_idnumber必须撤销订单id
├─ mass_placeobject []非必须批量下单信息

item 类型: object

├─ msgstring必须
├─ codestring必须
├─ order_idnumber必须订单id

CMC对接

交易列表接口(Trade)

基本信息

Path: /open/pub/trades

Method: GET

接口描述:

{
	"code": "0",
	"msg": "suc",
	"message": null,
	"data": {
		"date": 1574735405297,
		"trades": [
                        {
				"tradeID": 3523643,
				"price": "0.01",
				"base_volume": "569000",
				"quote_volume": "0.01000000",
				"trade_timestamp": "1566360780",
				"type": "sell"
			},
			{
				"tradeID": 3523642,
				"price": "0.01",
				"base_volume": "569000",
				"quote_volume": "0.01000000",
				"trade_timestamp": "1566360780",
				"type": "sell"
			}
		]
	}
}

请求参数

Query

参数名称 是否必须 示例 备注
base 是 btc
quote 是 usdt
trades 否 100 默认返回100条记录

返回数据

名称类型是否必须默认值备注其他信息
codestring非必须
msgstring非必须
messagenull非必须
dataobject非必须
├─ datenumber非必须
├─ tradesobject []非必须

item 类型: object

├─ tradeIDnumber必须交易记录ID
├─ pricestring必须价格
├─ base_volumestring必须基础货币交易量
├─ quote_volumestring必须计价货币交易量
├─ trade_timestampstring必须交易时间 时间戳
├─ typestring必须交易方向(sell/buy)

币对行情接口(Ticker)

基本信息

Path: /open/pub/ticker

Method: GET

接口描述:

{
	"code": "0",
	"msg": "suc",
	"message": null,
	"data": {
		"date": 1574735405297,
		"ticker": {
			"BTC_USDT": {
				"base_id": "1",
				"quote_id": "825",
				"last_price": "10000",
				"quote_volume": "20000",
				"base_volume": "2"
			},
			"LTC_BTC": {
				"base_id": "2",
				"quote_id": "1",
				"last_price": "0.00699900",
				"base_volume": "20028,526",
				"quote_volume": "279594"
			}
		}
	}
}

请求参数

返回数据

名称类型是否必须默认值备注其他信息
codestring非必须
msgstring非必须
messagenull非必须
dataobject非必须
├─ datenumber非必须
├─ tickerobject非必须
├─ BTC_USDTobject非必须
├─ base_idstring非必须base货币ID
├─ quote_idstring非必须计价货币ID
├─ last_pricestring非必须最新交易价格
├─ quote_volumestring非必须计价货币交易量
├─ base_volumestring非必须基础货币交易量
├─ LTC_BTCobject非必须
├─ base_idstring非必须base货币ID
├─ quote_idstring非必须计价货币ID
├─ last_pricestring非必须
├─ base_volumestring非必须
├─ quote_volumestring非必须

币种列表接口(Asset)

基本信息

Path: /open/pub/asset

Method: GET

接口描述:

{
	"code": "0",
	"msg": "suc",
	"message": null,
	"data": {
		"date": 1574735405297,
		"asset": {
			"BTC": {
				"name": "bitcoin",
				"unified_cryptoasset_id": "1",
				"can_withdraw": "true",
				"can_deposit": "true",
				"min_withdraw": "0.01",
				"max_withdraw ": "100"
			},
			"ETH": {
				"name": "bitcoin",
				"unified_cryptoasset_id": "1027",
				"can_withdraw": "true",
				"can_deposit": "true",
				"min_withdraw": "0.01",
				"max_withdraw ": "100"
			}
		}
	}
}

请求参数

返回数据

名称类型是否必须默认值备注其他信息
codestring非必须
msgstring非必须
messagenull非必须
dataobject非必须
├─ datenumber非必须
├─ assetobject非必须
├─ BTCobject非必须
├─ namestring非必须币种全称
├─ unified_cryptoasset_idstring非必须币种ID
├─ can_withdrawstring非必须是否开启提现
├─ can_depositstring非必须是否开启充值
├─ min_withdrawstring非必须最小提现数额
├─ max_withdraw string非必须最大提现数额
├─ ETHobject非必须
├─ namestring非必须
├─ unified_cryptoasset_idstring非必须币种ID
├─ can_withdrawstring非必须
├─ can_depositstring非必须
├─ min_withdrawstring非必须
├─ max_withdraw string非必须

盘口数据接口(OrderBook)

基本信息

Path: /open/pub/orderbook

Method: GET

接口描述:

{
	"code": "0",
	"msg": "suc",
	"message": null,
	"data": {
		"date": 1574735405297,
		"orderbook": {
			"bids": [
				["12462000", "0.04548320"],
				["12457000", "3.00000000"]
			],
			"asks": [
				["12506000", "2.73042000"],
				["12508000", "0.33660000"]
			]
		}
	}
}

请求参数

Query

参数名称 是否必须 示例 备注
base 是 btc btc
quote 是 usdt usdt
depth 否 0,1,2 不填默认为0
bids 否 150
asks 否 150

返回数据

名称类型是否必须默认值备注其他信息
codestring非必须
msgstring非必须
messagenull非必须
dataobject非必须
├─ datenumber非必须
├─ orderbookobject非必须
├─ bidsarray []非必须

item 类型: array

├─ 非必须
├─ 非必须
├─ asksarray []非必须

item 类型: array

├─ 非必须
├─ 非必须

K线行情

WS行情

基本信息

Path: wss://wspool.hiotc.pro/kline-api/ws

Method: GET

接口描述:

订阅-K线行情

  • 请求:
{"event":"sub","params":{"channel":"market_$base$quote_kline_[1min/5min/15min/30min/60min/1day/1week/1month]","cb_id":"自定义"}}
  • 返回订阅状态1次:
{"event_rep":"subed","channel":"market_$base$quote_kline_[1min/5min/15min/30min/60min/1day/1week/1month]","cb_id":"原路返回","ts":1506584998239,"status":"ok"}
  • 持续返回订阅消息:
{
    "channel":"market_$base$quote_kline_[1min/5min/15min/30min/60min/1day/1week/1month]",//订阅的交易对行情$base$quote表示btckrw等
    "ts":1506584998239,//请求时间
    "tick":{
        "id":1506602880,//时间刻度起始值
        "amount":123.1221,//交易额
        "vol":1212.12211,//交易量
        "open":2233.22,//开盘价
        "close":1221.11,//收盘价
        "high":22322.22,//最高价
        "low":2321.22//最低价
    }
}

订阅-前24小时行情

  • 请求:
{"event":"sub","params":{"channel":"market_$base$quote_ticker","cb_id":"自定义"}}
  • 返回订阅状态1次:
{"event_rep":"subed","channel":"market_$base$quote_ticker","cb_id":"原路返回","ts":1506584998239,"status":"ok","lower_frame":"0"} // lower_frame: 0 币对没下架、 1 币对下架
  • 持续返回订阅消息:
{
    "channel":"market_$base$quote_ticker",//订阅的交易对行情$base$quote表示btckrw等
    "ts":1506584998239,//请求时间
    "tick":{
        "id":1506584998,//冗余,无实际意义,时间戳
        "amount":123.1221,//交易额
        "vol":1212.12211,//交易量
        "open":2233.22,//开盘价
        "close":1221.11,//收盘价
        "high":22322.22,//最高价
        "low":2321.22,//最低价
        "rose":-0.2922,//涨幅
        "ts":1506584998239,//数据产生时间
        "lower_frame":"0"
    }
}

订阅-深度盘口(高频)

  • 请求:
{"event":"sub","params":{"channel":"market_$base$quote_depth_step[0-2]","cb_id":"自定义","asks":150,"bids":150}}
  • 返回订阅状态1次:
{"event_rep":"subed","channel":"market_$base$quote_depth_step[0-2]","cb_id":"原路返回","asks":150,"bids":150,"ts":1506584998239,"status":"ok"}
  • 注:第一次订阅成功会立刻返回一次全量数据, 另外server也会定期推个全量数据给前端 避免数据出问题
  • 全量:前端直接替换原有盘口
{
    "channel":"market_$base$quote_depth_step[0-2]",//$base$quote表示btckrw等,深度有3个维度,0、1、2
    "ts":1506584998239,//请求时间
    "tick":{
        "asks":[//卖盘
            [22112.22,0.9332],
            [22112.21,0.2],
        ],
        "buys":[//买盘
            [22111.22,0.9332],
            [22111.21,0.2],
        ]
    }
}
  • 注: 增量盘口信息 前端只需要替换价格对应的数量即可, volume=0时删除, price与原有盘口某个价格段的price相等时更新volume, 新的price直接新增
  • 增量盘口信息(该盘口变化的价格段)
{
    "channel":"market_$base$quote_depth_step[0-2]",//$base$quote表示btckrw等,深度有3个维度,0、1、2
    "ts":1506584998239,//请求时间
    "tick":{
        "side": "asks", 买卖盘方向  asks: 卖盘  buys: 买盘
        "price" : 133.55,  盘口对应的某个价格段
        "volume" : 44.22   价格段对应的数量
    }
}

订阅-深度盘口

  • 请求:
{"event":"sub","params":{"channel":"market_$base$quote_depth_step[0-2]","cb_id":"自定义","asks":150,"bids":150}}
  • 返回订阅状态1次:
{"event_rep":"subed","channel":"market_$base$quote_depth_step[0-2]","cb_id":"原路返回","asks":150,"bids":150,"ts":1506584998239,"status":"ok"}
  • 持续返回订阅消息:
{
    "channel":"market_$base$quote_depth_step[0-2]",//$base$quote表示btckrw等,深度有3个维度,0、1、2
    "ts":1506584998239,//请求时间
    "tick":{
        "asks":[//卖盘
            [22112.22,0.9332],
            [22112.21,0.2]
        ],
        "buys":[//买盘
            [22111.22,0.9332],
            [22111.21,0.2]
        ]
    }
}

订阅-实时成交信息

  • 请求:
{"event":"sub","params":{"channel":"market_$base$quote_trade_ticker","cb_id":"自定义"}}
  • 返回订阅状态1次:
{"event_rep":"subed","channel":"market_$base$quote_trade_ticker","cb_id":"原路返回","ts":1506584998239,"status":"ok"}
  • 持续返回订阅消息:
{
    "channel":"market_$base$quote_trade_ticker",//订阅的交易对行情$base$quote表示btckrw等
    "ts":1506584998239,//请求时间
    "tick":{
        "id":12121,//data中最大交易ID
        "ts":1506584998239,//data中最大时间
        "data":[
            {
                "id":12121,//交易ID
                "side":"buy",//买卖方向buy,sell
                "price":32.233,//单价
                "vol":232,//数量
                "amount":323,//总额
                "ts":1506584998239,//数据产生时间
                "ds":'2017-09-10 23:12:21'
            },
            {
                "id":12120,//交易ID
                "side":"buy",//买卖方向buy,sell
                "price":32.233,//单价
                "vol":232,//数量
                "amount":323,//总额
                "ts":1506584998239,//数据产生时间
                "ds":'2017-09-10 23:12:21'
            }
        ]
    }
}

请求-K线历史数据

  • 增加请求参数endIdx,pageSize(最多300,默认300条数据),如果endIdx为空,则返回最近300条历史数据
  • 请求:
{"event":"req","params":{"channel":"market_$base$quote_kline_[1min/5min/15min/30min/60min/1day/1week/1month]","cb_id":"自定义","since":"1506602880"}}//since缺省时返回最新300条,有值时返回大于since的最多1小时数据,since有强校验,不能早于当前1小时  since取到59
  • 返回一次历史数据:
{
    "event_rep":"rep","channel":"market_$base$quote_kline_[1min/5min/15min/30min/60min/1day/1week/1month]","cb_id":"原路返回",
    "since":"1506602880",//since缺省时返回最新300条,有值时返回大于since的最多1小时数据,since有强校验,不能早于当前1小时
    "ts":1506584998239,//请求时间
    "data":[//300条
        {
            "id":1506602880,//时间刻度起始值
            "amount":123.1221,//交易额
            "vol":1212.12211,//交易量
            "open":2233.22,//开盘价
            "close":1221.11,//收盘价
            "high":22322.22,//最高价
            "low":2321.22//最低价
        },
        {
            "id":1506602880,//时间刻度起始值
            "amount":123.1221,//交易额
            "vol":1212.12211,//交易量
            "open":2233.22,//开盘价
            "close":1221.11,//收盘价
            "high":22322.22,//最高价
            "low":2321.22//最低价
        }
    ]
}

请求-成交历史数据

  • 请求:
{"event":"req","params":{"channel":"market_$base$quote_trade_ticker","cb_id":"自定义","top":200}}
  • 直接返回成交信息:
{
    "event_rep":"rep","channel":"market_$base$quote_trade_ticker","cb_id":"原路返回","ts":1506584998239,"status":"ok",
    "top":200,//最大支持200
    "data":[
        {
            "id":12121,//交易ID
            "side":"buy",//买卖方向buy,sell
            "price":32.233,//单价
            "vol":232,//数量
            "amount":323,//总额
            "ts":1506584998239//数据产生时间
        },
        {
            "id":12120,//交易ID
            "side":"buy",//买卖方向buy,sell
            "price":32.233,//单价
            "vol":232,//数量
            "amount":323,//总额
            "ts":1506584998239,//数据产生时间
            "ds":'2017-09-10 23:12:21'
        }
    ]
}

请求-首页24行情数据

  • 请求方式:
{"event":"req","params":{"channel":"review"}}
  • 返回数据示例:
{
   event_rep: "rep",
   channel: "review",
   data: {
          bchbtc:  {amount: "115.968833484"close: "0.07956"high: "0.086323"low: "0.079251"open: "0.086323"rose: "-0.07834528"vol: "1393.247"}
          bchusdt: {amount: "416316.164145661", close: "513.56", high: "556.42", low: "510.85", open: "555.71", …}
          btcusdt: {amount: "999341.34124", close: "6450.18", high: "6486.39", low: "6359.63", open: "6435.79", …}
   }
}

请求参数

查询买卖盘深度

基本信息

Path: /open/api/market_dept

Method: GET

接口描述:

{
    "code": "0",
    "msg": "suc",
    "data": {
        "tick": {
            "asks": [//卖盘(BTCUSDT)
                [
                    7230.1782,//价格(USDT)
                    6.133//数量(BTC)
                ],
                [
                    7230.3757,
                    0.007
                ]
            ],
            "bids": [//买盘(BTCUSDT)
                [
                    7225.5867,//价格(USDT)
                    0.001//数量(BTC)
                ],
                [
                    7225.4409,
                    1.425
                ]
            ],
        }
    }
}

请求参数

Query

参数名称 是否必须 示例 备注
symbol 是 btcusdt 市场标记,btcusdt
type 是 step0 深度类型,step0, step1, step2(合并深度0-2);step0时,精度最高

返回数据

名称类型是否必须默认值备注其他信息
codestring必须

mock: 0

msgstring必须code>0失败

mock: suc

dataobject必须
├─ tickobject必须
├─ asksarray []必须卖盘

item 类型: array

├─ 非必须
├─ 非必须
├─ bidsarray []必须买盘

item 类型: array

├─ 非必须
├─ 非必须

查询系统支持的所有交易对及精度

基本信息

Path: /open/api/common/symbols

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
codestring必须

mock: 0

msgstring必须code>0失败

mock: suc

dataobject必须
├─ symbolstring必须交易对
├─ base_coinstring必须基础币种
├─ count_coinstring必须计价货币
├─ price_precisioninteger必须价格精度位数(0为个位)
├─ amount_precisioninteger必须数量精度位数(0为个位)

获取K线数据

基本信息

Path: /open/api/get_records

Method: GET

接口描述:

{
    "code": "0", //code>0 失败
    "msg": "suc",
    "message": null,
    "data": [
        [
            1575862380, //时间戳
            7488.0048, //开盘价
            7494.3289, //最高
            7487.8441, //最低
            7491.4864, //收盘价
            61.85934342, //交易量
            463413.3915064308 //交易额
        ],
        [
            1575862440,
            7491.2481,
            7492.7238,
            7490.505,
            7491.0626,
            47.8,
            358101.3027824
        ]
    ]
}

请求参数

Query

参数名称 是否必须 示例 备注
symbol 是 btcusdt 市场标记,例如btcusdt、ethbtc
period 是 1 单位为分钟,例如1分钟则为1,一天则为1440

返回数据

名称类型是否必须默认值备注其他信息
codestring非必须

mock: 0

msgstring非必须

mock: suc

dataarray []非必须

item 类型: array

├─ 非必须
├─ 非必须

获取各个币对的最新成交价

基本信息

Path: /open/api/market

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
api_key 是 api_key api_key
time 是 1576131763759 时间戳
sign 是 sign 签名

返回数据

名称类型是否必须默认值备注其他信息
codestring非必须

mock: 0

msgstring非必须

mock: suc

dataobject非必须
├─ btcusdtnumber非必须币对名称
├─ eosethnumber非必须币对名称
├─ ethusdtnumber非必须币对名称
├─ xxx-xxxnumber非必须币对名称(其他开放交易的币对)

获取当前行情

基本信息

Path: /open/api/get_ticker

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
symbol 是 btcusdt 市场标记,例如btcusdt、ethbtc

返回数据

名称类型是否必须默认值备注其他信息
codestring非必须

mock: 0

msgstring非必须

mock: suc

dataobject非必须
├─ highstring非必须最高价
├─ volstring非必须交易量
├─ lastnumber非必须最新成交价
├─ lowstring非必须最低价
├─ buynumber非必须买一价
├─ sellnumber非必须卖一价
├─ rosestring非必须涨跌幅
├─ timenumber非必须时间戳

获取所有交易对行情

基本信息

Path: /open/api/get_allticker

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
codestring非必须

mock: 0

msgstring非必须

mock: suc

dataobject非必须
├─ datenumber非必须返回数据时服务器时间
├─ tickerobject []非必须

item 类型: object

├─ symbolstring必须交易对(交易对1(base)简称_交易对2(quote)简称)
├─ highstring必须最高价
├─ lowstring必须最低价
├─ buynumber必须买一价
├─ sellnumber必须卖一价
├─ volstring必须成交量(最近的24小时)
├─ lastnumber必须最新成交价
├─ rosestring必须涨跌幅

获取行情成交记录

基本信息

Path: /open/api/get_trades

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
symbol 是 btcusdt 市场标记,btcusdt

返回数据

名称类型是否必须默认值备注其他信息
codestring非必须

mock: 0

msgstring非必须

mock: suc

dataobject []非必须

item 类型: object

├─ idnumber必须成交id
├─ amountnumber必须成交数量
├─ pricenumber必须成交价格
├─ typestring必须主动单方向
├─ tsnumber必须成交时间(时间戳)
├─ dsstring必须成交时间(日期格式)

币币委托

获取全部委托

基本信息

Path: /open/api/v2/all_order

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
symbol 是 btcusdt 市场标记,btcusdt
startDate 否 2019-12-10 12:00:01 开始时间,精确到秒"yyyy-MM-dd mm:hh:ss"
endDate 否 2019-12-10 18:00:01 结束时间,精确到秒"yyyy-MM-dd mm:hh:ss"
pageSize 否 20 页面大小
page 否 1 页码
api_key 是 api_key api_key
time 是 1575887255534 时间戳
sign 是 sign 签名

返回数据

名称类型是否必须默认值备注其他信息
codestring非必须
msgstring非必须
dataobject非必须
├─ countnumber非必须
├─ orderListobject []非必须

item 类型: object

├─ idnumber必须订单id
├─ sidestring必须买卖方向
├─ side_msgstring必须买卖方向信息
├─ statusnumber必须订单状态
├─ status_msgstring必须订单状态信息
├─ created_atnumber必须创建时间
├─ pricestring必须限价单挂单价格
├─ volumestring必须挂单总数量
├─ typenumber必须委托订单类型
├─ sourcenumber必须订单来源
├─ source_msgstring必须订单来源信息
├─ total_pricestring必须订单总金额
├─ remain_volumestring必须未成交数量
├─ deal_volumestring必须成交数量
├─ avg_pricestring必须成交均价
├─ baseCoinstring必须基础货币
├─ countCoinstring必须计价货币

获取全部成交记录

基本信息

Path: /open/api/all_trade

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
symbol 是 btcusdt 市场标记,btcusdt
startDate 否 2019-12-10 12:00:01 开始时间,精确到秒“yyyy-MM-dd HH:mm:ss”
endDate 否 2019-12-10 18:00:01 结束时间,精确到秒“yyyy-MM-dd HH:mm:ss”
pageSize 否 20 页面大小
page 否 1 页码
api_key 是 api_key api_key
time 是 1575887255534 时间戳
sign 是 sign 签名
sort 否 1 1表示id倒序(需要id倒序可以使用)

返回数据

名称类型是否必须默认值备注其他信息
codestring非必须

mock: 0

msgstring非必须

mock: suc

dataobject非必须
├─ countnumber非必须
├─ resultListobject []非必须

item 类型: object

├─ idnumber非必须成交id
├─ sidestring非必须买卖方向
├─ ask_user_idnumber非必须卖方用户id
├─ bid_user_idnumber非必须买方用户id
├─ typestring非必须买卖方向信息
├─ bid_idnumber非必须买单id
├─ ask_idnumber非必须卖单id
├─ pricestring非必须成交价格
├─ volumestring非必须成交数量
├─ deal_pricestring非必须成交金额(price*volume)
├─ feestring非必须买或卖单手续费
├─ feeCoinstring非必须买或卖单支付手续费的币种
├─ ctimenumber非必须成交时间

获取当前委托v3

基本信息

Path: /open/api/v3/new_order

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
symbol 是 btcusdt 市场标记,btcusdt
pageSize 否 20 页面大小
page 否 1 页码
api_key 是 api_key api_key
time 是 1575887255534 时间戳
sign 是 sign 签名
pendingCancel 是 0 0表示排除待撤单状态订单

返回数据

名称类型是否必须默认值备注其他信息
codestring非必须

mock: 0

msgstring非必须

mock: suc

dataobject非必须
├─ countnumber非必须
├─ resultListobject []非必须

item 类型: object

├─ idnumber必须订单id
├─ sidestring必须买卖方向
├─ side_msgstring必须买卖方向信息
├─ statusnumber必须订单状态
├─ status_msgstring必须订单状态信息
├─ created_atnumber必须订单创建时间
├─ pricestring必须限价单挂单价格
├─ volumestring必须挂单总数量
├─ typenumber必须委托订单类型
├─ sourcenumber必须订单来源
├─ source_msgstring必须订单来源信息
├─ total_pricestring必须订单总金额
├─ remain_volumestring必须未成交数量
├─ deal_volumestring必须成交数量
├─ avg_pricestring必须成交均价
├─ baseCoinstring必须基础货币
├─ countCoinstring必须计价货币

获取订单详情

基本信息

Path: /open/api/order_info

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
order_id 是 orderId 订单Id
symbol 是 btcusdt 市场标记,btcusdt
api_key 是 api_key api_key
time 是 1575887255534 时间戳
sign 是 sign 签名

返回数据

名称类型是否必须默认值备注其他信息
codestring非必须

mock: 0

msgstring非必须

mock: suc

dataobject非必须
├─ trade_listobject []非必须成交信息

item 类型: object

├─ volumestring非必须成交数量
├─ feeCoinstring非必须买或卖单支付手续费的币种
├─ pricestring非必须成交价格
├─ feestring非必须买或卖单手续费
├─ ctimenumber非必须成交时间
├─ deal_pricestring非必须成交金额(volume*price)
├─ idnumber非必须成交id
├─ typestring非必须买入或卖出信息
├─ order_infoobject非必须订单信息
├─ idnumber非必须订单id
├─ sidestring非必须买卖方向
├─ side_msgstring非必须买卖方向信息
├─ statusnumber非必须订单状态
├─ status_msgstring非必须订单状态信息
├─ created_atnumber非必须订单创建时间
├─ pricestring非必须限价单挂单价格
├─ volumestring非必须挂单总数量
├─ typenumber非必须委托订单类型
├─ sourcenumber非必须订单来源
├─ source_msgstring非必须订单来源信息
├─ total_pricestring非必须订单总金额
├─ remain_volumestring非必须未成交数量
├─ deal_volumestring非必须成交数量
├─ avg_pricestring非必须成交均价
├─ baseCoinstring非必须基础货币
├─ countCoinstring非必须计价货币
├─ tradeListobject []非必须成交信息(冗余)

item 类型: object

├─ volumestring非必须
├─ feeCoinstring非必须
├─ pricestring非必须
├─ feestring非必须
├─ ctimenumber非必须
├─ deal_pricestring非必须
├─ idnumber非必须
├─ typestring非必须

杠杆委托

获取杠杆全部成交记录

基本信息

Path: /open/api/margin/all_trade

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
type 是 2 2杠杆订单,1币币订单
symbol 是 btcusdt 市场标记,btcusdt
startDate 否 2019-12-10 12:00:01 开始时间,精确到秒“yyyy-MM-dd HH:mm:ss”
endDate 否 2019-12-10 18:00:01 结束时间,精确到秒“yyyy-MM-dd HH:mm:ss”
pageSize 否 20 页面大小
page 否 1 页码
api_key 是 api_key api_key
time 是 1575887255534 时间戳
sign 是 sign 签名
sort 否 1 1表示id倒序(需要id倒序可以使用)

返回数据

名称类型是否必须默认值备注其他信息
codestring非必须

mock: 0

msgstring非必须

mock: suc

dataobject非必须
├─ countnumber非必须
├─ resultListobject []非必须

item 类型: object

├─ idnumber非必须成交id
├─ sidestring非必须买卖方向
├─ ask_user_idnumber非必须卖方用户id
├─ bid_user_idnumber非必须买方用户id
├─ typestring非必须买卖方向信息
├─ bid_idnumber非必须买单id
├─ ask_idnumber非必须卖单id
├─ pricestring非必须成交价格
├─ volumestring非必须成交数量
├─ deal_pricestring非必须成交金额(price*volume)
├─ feestring非必须买或卖单手续费
├─ feeCoinstring非必须买或卖单支付手续费的币种
├─ ctimenumber非必须成交时间

获取杠杆当前委托

基本信息

Path: /open/api/margin/new_order

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
type 是 2 2杠杆订单,1币币订单
symbol 是 btcusdt 市场标记,btcusdt
startDate 否 2019-12-12 12 开始时间,精确到秒“yyyy-MM-dd mm:hh:ss”
endDate 否 2019-12-12 18 结束时间,精确到秒“yyyy-MM-dd mm:hh:ss”
pageSize 否 20 页面大小
page 否 1 页码
api_key 是 api_key api_key
time 是 1576131763759 时间戳
sign 是 sign 签名

返回数据

名称类型是否必须默认值备注其他信息
codestring非必须

mock: 0

msgstring非必须

mock: suc

dataobject非必须
├─ countnumber非必须
├─ resultListobject []非必须

item 类型: object

├─ idnumber非必须订单id
├─ sidestring非必须买卖方向
├─ side_msgstring非必须买卖方向信息
├─ statusnumber非必须订单状态
├─ status_msgstring非必须订单状态信息
├─ created_atnumber非必须订单创建时间
├─ pricestring非必须限价单挂单价格
├─ volumestring非必须挂单总数量
├─ typenumber非必须委托订单类型
├─ sourcenumber非必须订单来源
├─ source_msgstring非必须订单来源信息
├─ total_pricestring非必须订单总金额
├─ remain_volumestring非必须未成交数量
├─ deal_volumestring非必须成交数量
├─ avg_pricestring非必须成交均价
├─ baseCoinstring非必须基础货币
├─ countCoinstring非必须计价货币

账户资产

用户信息

基本信息

Path: /open/api/user/info

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

Body

名称类型是否必须默认值备注其他信息
api_keystring必须
timestring必须
signstring必须

返回数据

名称类型是否必须默认值备注其他信息
codestring非必须0成功
msgstring非必须
dataobject非必须
├─ uidnumber非必须uid
├─ mobileNumberstring非必须手机
├─ emailstring非必须邮箱
├─ inviteCodestring非必须邀请码

获取杠杆资产余额

基本信息

Path: /open/api/margin/symbol/balance

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Query

参数名称 是否必须 示例 备注
symbol 是 btcusdt 币对名称
api_key 是 api_key api_key
time 是 1576131763759 时间戳
sign 是 sign 签名

返回数据

名称类型是否必须默认值备注其他信息
codestring非必须

mock: 0

msgstring非必须

mock: suc

dataobject非必须
├─ symbolstring非必须币对名称
├─ riskRatenumber非必须风险率
├─ quoteTotalBalancenumber非必须quote杠杆总资产(正常+冻结)
├─ quoteNormalBalancenumber非必须quote杠杆正常余额
├─ quoteLockBalancenumber非必须quote杠杆冻结余额
├─ burstPricenumber非必须爆仓价
├─ baseLockBalancenumber非必须base杠杆冻结余额
├─ baseNormalBalancenumber非必须base杠杆正常余额
├─ quoteCoinstring非必须计价货币(quote资产)
├─ baseCoinstring非必须基础货币(base资产)
├─ baseTotalBalancenumber非必须base杠杆总资产(正常+冻结)

资产余额

基本信息

Path: /open/api/user/account

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
api_key 是 api_key api_key
time 是 1576131763759 时间戳
sign 是 sign 签名

返回数据

名称类型是否必须默认值备注其他信息
codestring非必须

mock: 0

msgstring非必须

mock: suc

dataobject非必须
├─ total_assetstring非必须总资产
├─ coin_listobject []非必须

item 类型: object

├─ normalstring必须可用余额账户
├─ btcValuatinstring必须BTC估值
├─ lockedstring必须冻结账户
├─ coinstring必须数字货币名称

Build by OpenApi.