NAV
English 中文
shell

介绍

新版本优化升级

BitZ为您提供了一套简单又强大的API接口,帮助您快速、高效的获取行情和进行交易。

使用交易API前,请在用户中心创建API,获取您的API Key和Secret,并设置API的IP访问限制。

官网首页: 官网1 官网2

更新日志

生效时间 接口 类型 摘要
2020.08.04 /Trade/addEntrustSheetBatch 修改 不再需要密码参数(tradePwd)
2020.08.04 /Trade/addEntrustSheet 修改 不再需要密码参数(tradePwd)

接入说明

域名

https://apiv2.bitz.com

https://apiv2.bit-z.pro

https://api.bitzapi.com

https://api.bitzoverseas.com

https://api.bitzspeed.com

限制

全部接口频次限制
限频参数:Ip、Uid、Apikey
限制频次:5000次/分钟

单个接口频次限制
限频参数:Uid、Apikey
限制频次:30次/秒

验签

说明

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

组成

GET示例
获取当前法币汇率信息 接口; symbols 为接口需要的 交易对 参数 (验签也需要该参数)

curl "https://apiv2.bitz.com/V2/Market/currencyRate?\
accessKey=dca69b225ef11f9105275da52cc560cf\
&timestamp=2019-11-21T08%3A20%3A58\
&signature=P0ctuNHKJTHHEUPd3t0dRAbrm8RBR8ufbT2chgvIF4s%3D\
&symbols=cny_usdt%2Ceur_jpy\
"

POST示例
撤销限价委托 接口; order-id 为接口需要的 订单id 参数 (验签也需要该参数)

curl "https://apiv2.bitz.com/V2/Trade/cancelEntrustSheet?\
accessKey=dca69b225ef11f9105275da52cc560cf\
&timestamp=2019-11-21T08%3A20%3A58\
&signature=P0ctuNHKJTHHEUPd3t0dRAbrm8RBR8ufbT2chgvIF4s%3D\
&order-id=12345654321\
-X POST\
-d order-id=12345654321\
"

方法请求地址:即访问服务器地址 apiv2.bitz.com,比如 apiv2.bitz.com/V2/Market/currencyRate

API 访问密钥(accessKey):您申请的 API Key 中的 Access Key。

时间戳(timestamp):您发出请求的时间 (UTC 时间) 。如:2017-05-11T16:22:06。在查询请求中包含此值有助于防止第三方截取您的请求。

必选和可选参数:每个方法都有一组用于定义 API 调用的必需参数和可选参数。可以在每个方法的说明中查看这些参数及其含义。 请一定注意:对于 GET、POST 请求,每个方法自带的参数都需要进行签名运算。

签名:签名计算得出的值,用于确保签名有效和未被篡改。

创建APIKEY

创建 API Key 您可以在 这里 创建 API Key。

API Key 包括以下两部分

步骤

计算签名的请求需要进行规范,因为使用 HMAC 进行签名计算时,使用不同内容计算得到的结果会完全不同。所以在进行签名计算前,请先对请求进行规范化处理。

https://apiv2.bitz.com/V2/Market/currencyRate?

accessKey=dca69b225ef11f9105275da52cc560cf

&timestamp=2019-11-21T08%3A20%3A58

&signature=P0ctuNHKJTHHEUPd3t0dRAbrm8RBR8ufbT2chgvIF4s%3D

&symbols=cny_usdt%2Ceur_jpy

1. 参数编码

symbols=cny_usdt%2Ceur_jpy

accessKey=dca69b225ef11f9105275da52cc560cf

timestamp=2019-11-21T08%3A20%3A58

2. 参数排序

accessKey=dca69b225ef11f9105275da52cc560cf

timestamp=2019-11-21T08%3A20%3A58

symbols=cny_usdt%2Ceur_jpy

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

accessKey=dca69b225ef11f9105275da52cc560cf&timestamp=2019-11-21T08%3A20%3A58&symbols=cny_usdt%2Ceur_jpy

4. 生成数字签名

P0ctuNHKJTHHEUPd3t0dRAbrm8RBR8ufbT2chgvIF4s%3D

5. 请求加入签名

https://apiv2.bitz.com/V2/Market/currencyRate?

accessKey=dca69b225ef11f9105275da52cc560cf

&timestamp=2019-11-21T08%3A20%3A58

&signature=P0ctuNHKJTHHEUPd3t0dRAbrm8RBR8ufbT2chgvIF4s%3D

&symbols=cny_usdt%2Ceur_jpy

请求格式

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

返回格式

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

键名 类型 描述
status int 状态码
msg string 信息
time int 时间
microtime string 时间(微妙)
source string 来源
data object 接口返回数据主体

使用示例

源码下载地址:

https://github.com/api-demo-file/api-v2-sign-demo

基础信息

获取当前法币汇率信息

example of CURL

curl "https://apiv2.bitz.com/V2/Market/currencyRate?\
symbols=cny_usdt%2Ceur_jpy\
"

Payload

{
  "status": 200,
  "msg": "",
  "time": 1573207257,
  "microtime": "0.25998300 1573207257",
  "source": "api",
  "data": {
    "cny_usdt": {       // 币对
      "coin": "cny",    // 币种
      "currencyCoin": "usdt",       // 汇率币种
      "rate": "0.146471",           // 汇率
      "rateTime": "2018-08-03 23:29:03",    // 汇率时间
      "ratenm": "cny/usdt",         // 汇率名称
      "flatform": "api.k780.com",   // 读取平台
      "created": "1533461732",      // 记录时间(戳)
      "timezone": "PRC"             // 时区
    },
    "usdt_cny": {
      "coin": "usdt",
      "currencyCoin": "cny",
      "rate": "6.853000",
      "rateTime": "2018-08-03 23:29:03",
      "ratenm": "usdt/cny",
      "flatform": "api.k780.com",
      "created": "1533559242",
      "timezone": "PRC"
    }
  }
}

GET /V2/Market/currencyRate

参数

参数名 必选 类型 备注
symbols string cny_usdt,usdt_cny 传入时返回指定数据,英文逗号分隔,否则返回全部

返回字段

字段名 必选 类型 备注
coin string 币种
currencyCoin string 汇率币种
rate string 汇率
rateTime string 汇率时间
ratenm string 汇率名称
flatform string 读取平台
created string 记录时间(戳)
timezone string 时区

获取虚拟货币法币汇率信息

example of CURL

curl "https://apiv2.bitz.com/V2/Market/currencyCoinRate?\
coins=btc%2Cusdt\
"

Payload

{
  "status": 200,
  "msg": "",
  "time": 1573207257,
  "microtime": "0.25998300 1573207257",
  "source": "api",
  "data": {
    "btc": {
      "dkkt": "47619.53224133",
      "usdt": "7392.98000000",
      "eth": "17.85045531",
      "bz": "54141.85165132",
      "cny": "50474.01874773",
      "jpy": "822173.04270462",
      "krw": "7850869.56521739",
      "usd": "7392.98000000",
      "dkk": "47619.53224133",
      "btc": "1"
    },
    "usdt": {
      "btc": "0.00014298",
      "dkkt": "6.45648650",
      "eth": "0.00245718",
      "bz": "7.72797527",
      "usdt": "1",
      "cny": "6.85382169",
      "jpy": "111.50758251",
      "krw": "1114.82720178",
      "dkk": "6.45648650",
      "usd": "1"
    }
  }
}

GET /V2/Market/currencyCoinRate

参数

参数名 必选 类型 备注
coins string btc,usdt 传入时返回指定数据,英文逗号分隔,否则返回全部

获取币种对应汇率信息

example of CURL

curl "https://apiv2.bitz.com/V2/Market/coinRate?\
coins=btc%2Ceth\
"

Payload

{
    "status": 200,
    "msg": "",
    "data": {
        "btc": {
            "btc": "1",
            "usdt": "9490.0300000000",
            "eth": "36.1630824832",
            "trx": "533304.8904058450",
            "bz": "86132.6442721791",
            "dkkt": "60927.3137147383",
            "cny": "66392.2498800000",
            "jpy": "1016572.0136000000",
            "krw": "11358616.9070000000",
            "eur": "8180.4058600000",
            "sgd": "13119.9664750000",
            "rub": "673811.1100600000",
            "usd": "9490.0300000000"
        },
        "eth": {
            "eth": "1",
            "btc": "0.0276525100",
            "usdt": "262.4650000000",
            "trx": "14754.7030616008",
            "bz": "2381.7843041843",
            "dkkt": "1685.0517041264",
            "cny": "1836.2051400000",
            "jpy": "28115.2508000000",
            "krw": "314144.3585000000",
            "eur": "226.2448300000",
            "sgd": "362.8578625000",
            "rub": "18635.5399300000",
            "usd": "262.4650000000"
        }
    },
    "time": 1595487121,
    "microtime": "0.44669800 1595487121",
    "source": "api"
}

GET /V2/Market/coinRate

参数

参数名 必选 类型 备注
coins string btc,eth 传入时返回指定数据,英文逗号分隔,否则返回全部

获取服务器当前时间

example of CURL

curl "https://apiv2.bitz.com/V2/Market/getServerTime"

Payload

{
  "status": 200,
  "msg": "",
  "time": 1573207257,
  "microtime": "0.25998300 1573207257",
  "source": "api",
  "data": []
}

GET /V2/Market/getServerTime

钱包(充币和提币)

充币地址查询

example of CURL

curl "https://apiv2.bitz.com/V2/Trade/getCoinAddress\
-X POST\
-d currency=eth\
"

Payload

{
    "status": 200,
    "msg": "",
    "data": {
        "address": "0xed95eaf08***********ac936b8c702" // 充值地址
    },
    "time": 1582525979,
    "microtime": "0.55819500 1582525979",
    "source": "api"
}

Payload (eos)

{
    "status": 200,
    "msg": "",
    "data": {
        "memo": "2******8",       // 充值标志
        "address": "b******sit1"  // 充值账户
    },
    "time": 1582526057,
    "microtime": "0.06580900 1582526057",
    "source": "api"
}

POST /V2/Trade/getCoinAddress

参数

参数名 必选 类型 备注
currency string 币种名称
type 选填 string 类型, usdt 需要,接受值 erc20,omni,trc20

返回字段

字段名 必选 类型 备注
memo 选填 string 充值标志
address string 充值账户

提币地址查询

example of CURL

curl "https://apiv2.bitz.com/V2/Trade/getCoinAddressList\
-X POST\
-d currency=eth\
"

Payload

{
    "status": 200,
    "msg": "",
    "time": 1579165863,
    "microtime": "0.31119300 1579165863",
    "source": "api",
    "data": {
        "wallet": [
            {
                "name": "withdrawETH",  // 钱包名称
                "address": "0x30056a9d28f768aa0363604660301481b30e5f34",  // 区块链提币地址
                "currency": "eth",      // 币种
                "chain": "",            // 链标志
                "memo": ""              // MEMO 标志
            }
        ]
    }
}

POST /V2/Trade/getCoinAddressList

参数

参数名 必选 类型 备注
currency string 币种名称

返回字段

字段名 必选 类型 备注
name string 钱包名称
address string 区块链提币地址
currency string 币种
chain string 链标志
memo string MEMO 标志

虚拟币提币

example of CURL

curl "https://apiv2.bitz.com/V2/Trade/coinOut\
-X POST\
-d currency=btc\
&amount=10\
&address=xxx\
"

Payload

{
  "status": 200,
  "msg": "",
  "time": 1573207257,
  "microtime": "0.25998300 1573207257",
  "source": "api",
  "data": {
    "id": "196979",         // 提币唯一标志
    "email": "*****@email.com",   // 用户邮箱
    "coin": "btct",         // 币种
    "netwark_fee": "",      // 网络费
    "eid": "23112"          
  }
}

POST /V2/Trade/coinOut

参数

参数名 必选 类型 备注
currency string 币种名称
amount float 数量
address string 地址
memo 选填 string memo
type 选填 string 类型, usdt 需要,接收值 erc20,omni,trc20

返回字段

字段名 必选 类型 备注
id string 提币唯一标志
email string 用户邮箱
coin string 币种
netwark_fee string 网络费

充提记录

POST /V2/Trade/depositOrwithdraw

example of CURL

curl "https://apiv2.bitz.com/V2/Trade/depositOrwithdraw\
-X POST\
-d currency=btc\
&page=1\
&size=10\
"

Payload

{
  "status": 200,
  "msg": "",
  "time": 1573207257,
  "microtime": "0.25998300 1573207257",
  "source": "api",
  "data": {
    "data": [       // 数据
      {
        "id": "397574",   // 数据唯一标志
        "uid": "2033056", // 用户唯一标志
        "address": "1AG1gZvQAYu3WBvgg7p4BMMghQD2gE693k",    // 提币地址   
        "txHash": "",                    // 提币交易hash
        "confirm": "0",                   // 网络确认数
        "amount": "1000.00000000",        // 提币数
        "status": 1,                      // 状态 
        "updatedAt": "0",                // 更新时间(戳)
        "addressUrl": "http://omniexplorer.info/lookupadd.aspx?address=",   // 区块链地址状态查询
        "txidUrl": "http://omniexplorer.info/lookuptx.aspx?txid=",          // 区块链交易状态查询
        "description": "Tether",          // 交易描述
        "currency": "usdt",               // 币种
        "memo": ""                        // 交易标志
      }
    ],
    "pageInfo": { // 分页数据
      "limit": "10",          // 条数
      "offest": "0",          // 起始位置
      "current_page": 1,      // 当前页
      "page_size": 10,        // 每页条数
      "total_count": 2,       // 总条数
      "page_count": 1         // 总页数
    }
  }
}

参数

参数名 必选 类型 备注
currency string 币种名称
type integer 1:充,2:提
page integer 当前页数
size integer 每页展示数量 最大值 100
startTime string 开始时间戳
endTime string 结束时间戳

返回字段

data

字段名 必选 类型 备注
id string 数据唯一标志
uid string 用户唯一标志
address string 提币地址
txHash string 提币交易hash
confirm string 网络确认数
amount string 提币数
status int 状态
updatedAt string 更新时间(戳)
addressUrl string 区块链地址状态查询
txidUrl string 区块链交易状态查询
description string 交易描述
currency string 币种
memo string 交易标志

pageInfo

字段名 必选 类型 备注
limit int 条数
offest int 起始位置
current_page int 当前页
page_size int 每页条数
total_count int 总条数
page_count int 总页数

status 说明

符号
说明
1 待确认
2 审核中
3 等待中
4 已完成
5 取消

币币行情

获取牌价数据

example of CURL

curl "https://apiv2.bitz.com/V2/Market/ticker?\
symbol=eth_btc\
"

Payload

{
  "status": 200,
  "msg": "",
  "time": 1579246083,
  "microtime": "0.10447900 1579246083",
  "source": "api",
  "data": {
    "symbol": "btc_usdt",       // 币对
    "vol": "0.00",              // 成交额
    "amount": "0.00",           // 成交量
    "priceChange24h": "0.00",   // 价格浮动百分比
    "open": "5000.00",          // 开盘价
    "high": "9999.99",          // 最高价
    "low": "1.00",              // 最低价
    "now": "5000.00",           // 当前价
    "firstId": 9091334076,      // 第一单
    "lastId": 9091334076,       // 最后一单
    "count": 34,                // 成交笔数
    "numberPrecision": 2,       // 数量小数点
    "pricePrecision": 2,        // 价格小数点
    "cny": "34357.50",          // cny 汇率
    "usd": "5000.00",           // usd 汇率
    "krw": "5791700.00",        // krw 汇率 
    "jpy": "551150.00",         // jpy 汇率
    "rub": "308187.50",         // rub 汇率
    "ask": [
      "8928.53",                // 卖一价
      "0.7000"                  // 卖一量
    ],
    "bid": [
      "8928.63",                // 买一价
      "1.7000"                  // 买一量
    ]
  }
}

GET /V2/Market/ticker

参数

参数名 必选 类型 备注
symbol string eth_btc、ltc_btc 交易对

返回字段

字段名 必选 类型 备注
symbol string 币对
vol string 成交额
amount string 成交量
priceChange24h string 价格浮动百分比
open string 开盘价
high string 最高价
low string 最低价
now string 当前价
firstId int 第一单
lastId int 最后一单
count int 成交笔数
numberPrecision int 数量小数点
pricePrecision int 价格小数点
cny string cny 汇率
usd string usd 汇率
krw string krw 汇率
jpy string jpy 汇率
rub string rub 汇率
ask array 卖一价,卖一量
bid array 买一价,买一量

市场深度数据

example of CURL

curl "https://apiv2.bitz.com/V2/Market/depth?\
symbol=eth_btc\
"

Payload

{
  "status": 200,
  "msg": "",
  "time": 1532671014,
  "microtime": "0.49301600 1532671014",
  "source": "api",
  "data": {
    "asks": [   // 卖
      [
        "57.70000000",      // 价格
        "1.6783",           // 数量
        "96.837910000000"   // 总价
      ],
    ],
    "bids": [  // 买
      [
        "0.00121238",       //价格
        "1398.9960",        //数量
        "1.696114770480"    //总价
      ],
    ],
    "coinPair": "ltc_btc"   // 币对名称
  }
}

GET /V2/Market/depth

参数

参数名 必选 类型 备注
symbol string eth_btc、ltc_btc 交易对

返回字段

字段名 必选 类型 备注
asks array 价格,数量,总价(卖)
bids array 价格,数量,总价(买)
coinPair array 币对名称

获取成交单

example of CURL

curl "https://apiv2.bitz.com/V2/Market/order?\
symbol=eth_btc\
"

Payload

{
  "status": 200,
  "msg": "",
  "time": 1573207257,
  "microtime": "0.25998300 1573207257",
  "source": "api",
  "data": [
    {
      "id": 105526523,
      "t": "12:58:48",    // 时间
      "T": 1535796654,
      "p": "0.01053000",  // 价格
      "n": "11.9096",     // 数量
      "s": "buy"          // 类型 buy/sell
    }
  ]
}

GET /V2/Market/order

参数

参数名 必选 类型 备注
symbol string eth_btc、ltc_btc 交易对

返回字段

字段名 必选 类型 备注
t string 时间
p string 价格
n string 数量
s string 类型 buy/sell

获取所有牌价数据

example of CURL

curl "https://apiv2.bitz.com/V2/Market/tickerall?\
symbols=eth_btc\
"

Payload

{
  "status": 200,
  "msg": "",
  "time": 1573207257,
  "microtime": "0.25998300 1573207257",
  "source": "api",
  "data": {
    "777_btc": {
      "symbol": "777_btc",
      "vol": "2.5926",            // 成交额
      "volume": "2120645.6004",   // 成交量
      "priceChange24h": "-4.83",  // 价格浮动百分比
      "ask": [
        "0.01029941",             // 卖一价
        "1.6702"                  // 卖一量
      ],
      "bid": [
        "0.01029941",             // 买一价
        "1.6702"                  // 买一量
      ],
      "open": "0.00000118",       // 开盘价
      "high": "0.00000130",       // 最高价
      "low": "0.00000109",        // 最低价
      "now": "0.00000124",        // 当前价
      "firstId": "105551102",     // 第一单
      "lastId": "105853063",      // 最后一单
      "count": "2650",            // 成交笔数
      "numberPrecision": "4",     // 数量小数点
      "pricePrecision": "8",      // 价格小数点
      "cny": "0.06912764",
      "usd": "0.01014551",
      "krw": "6.35"
    }
  }
}

GET /V2/Market/tickerall

参数

参数名 必选 类型 备注
symbols string eth_btc,ltc_btc 交易对,传入时返回指定数据,英文逗号分隔,否则返回全部

返回字段

字段名 必选 类型 备注
vol string 成交额
volume string 成交量
priceChange24h string 价格浮动百分比
ask array 卖一价,卖一量
bid string 买一价,买一量
open string 开盘价
high string 最高价
low string 最低价
now string 当前价
firstId string 第一单
lastId string 最后一单
count string 成交笔数
numberPrecision string 数量小数点
pricePrecision string 价格小数点

获取K线数据 kline

example of CURL

curl "https://apiv2.bitz.com/V2/Market/kline?\
symbol=eth_btc\
period=30min\
size=10\
"

Payload

{
  "status": 200,
  "msg": "",
  "time": 1573207257,
  "microtime": "0.25998300 1573207257",
  "source": "api",
  "data": {
    "period": "1mon",           // 返回数据时间粒度,也就是每个点的时间区间
    "symbol": "eos_btc",        // 交易对
    "to": "1506700800000",      // 时间
    "size": "300",              // 返回 K 线数据条数
    "bars": [
      {
        "id": "1530288000000",      // 时间戳,单位毫秒,并以此作为此K线柱的id
        "open": "0.00127236",       // 本阶段开盘价
        "high": "0.00159900",       // 本阶段最高价
        "low": "0.00120082",        // 本阶段最低价
        "close": "0.00120148",      // 本阶段收盘价
        "amount": "539601.23460000",// 交易量
        "datetime": "2018-06-30 00:00:00"
      }
    ]
  }
}

GET /V2/Market/kline

参数

参数名 必选 类型 备注
size integer 获取数量 范围1-300
startTime string 毫秒时间戳,返回传入毫秒时间戳之后的数据
endTime string 毫秒时间戳,返回传入毫秒时间戳之前的数据
symbol string eth_btc、ltc_btc 交易对
period string 1min 、5min 、15min 、30min 、60min、 4hour 、 1day 、5day 、1week、 1mon

返回字段

字段名 必选 类型 备注
period string 返回数据时间粒度,也就是每个点的时间区间
symbol string 交易对
to string 时间
size string 返回 K 线数据条数

bars

字段名 必选 类型 备注
id string 时间戳,单位秒,并以此作为此K线柱的id
open string 本阶段开盘价
high string 本阶段最高价
low string 本阶段最低价
close string 本阶段收盘价
amount string 交易量

获取交易对数据

example of CURL

curl "https://apiv2.bitz.com/V2/Market/symbolList?\
symbols=eth_btc\
"

Payload

{
  "status": 200,
  "msg": "",
  "time": 1579248124,
  "microtime": "0.62609500 1579248124",
  "source": "api",
  "data": {
    "eth_btc": {
      "id": "15",
      "symbol": "eth_btc",      // 交易对
      "baseCurrency": "eth",
      "quoteCurrency": "btc",
      "amountPrecision": "4",   // 数量小数点
      "pricePrecision": "8",    // 价格小数点
      "status": "1",
      "minOrderAmt": "0.001",           // 每笔最小交易数量
      "maxOrderAmt": "500000000.000",   // 每笔最大交易数量
      "marketBuyFloat": "4"     // 买入小数点
    }
  }
}

GET /V2/Market/symbolList

参数

参数名 必选 类型 备注
symbols string eth_btc,ltc_btc 交易对,传入时返回指定数据,英文逗号分隔,否则返回全部

返回字段

字段名 必选 类型 备注
symbol string 交易对
amountPrecision string 数量小数点
pricePrecision string 价格小数点
minOrderAmt string 每笔最小交易数量
maxOrderAmt string 每笔最大交易数量
marketBuyFloat string 买入小数点

币币交易

提交限价委托

example of CURL

curl "https://apiv2.bitz.com/V2/Trade/addEntrustSheet\
-X POST\
-d type=2\
&price=8500\
&amount=1\
&symbol=btc_usdt\
"

Payload

{
    "status": 200,
    "msg": "",
    "time": 1579505907,
    "microtime": "0.41723500 1579505907",
    "source": "api",
    "data": {
        "orderId": 1036049896,  // 委托单id
        "accountId": 70001018,  // 用户id
        "price": "8500.00",     // 价格
        "amount": "1.00",       // 数量
        "numberOver": "1.00",   // 剩余数额
        "flag": "sale",         // 交易类型
        "status": 0,            // 状态 0未成交 1部分成交 2全部成交 3已取消
        "coinFrom": "btc",      // 要兑换的币
        "coinTo": "usdt",       // 目标兑换
        "fieldAmount": 0        // 交易成功数量
    }
}

POST /V2/Trade/addEntrustSheet

参数

参数名 必选 类型 备注
type string 购买类型 1买进 2 卖出
price float 委托价格
amount float 委托数量
symbol string 交易对,例如 eth_btc

返回字段

字段名 必选 类型 备注
orderId int 委托单id
accountId int 用户id
price string 价格
amount string 数量
numberOver string 剩余数额
flag string 交易类型
status int 状态 0未成交 1部分成交 2全部成交 3已取消
coinFrom string 要兑换的币
coinTo string 目标兑换
fieldAmount float 交易成功数量

提交市价委托

example of CURL

curl "https://apiv2.bitz.com/V2/Trade/marketTrade\
-X POST\
-d type=2\
&amount=1\
&symbol=btc_usdt\
"

Payload

{
    "status": 200,
    "msg": "",
    "time": 1579506291,
    "microtime": "0.96183900 1579506291",
    "source": "api"
    "data": {
        "orderId": 1036051145,  // 委托单id
        "accountId": 70001018,  // 用户uid
        "price": null,          // 价格
        "amount": "1.00",       // 数量
        "numberOver": "1.00",   // 剩余数量
        "flag": "sale",         // 买卖标志
        "status": 0,            // 0未成交 1部分成交 2全部成交 3已取消
        "coinFrom": "btc",      // 要兑换的币
        "coinTo": "usdt",       // 目标兑换
        "numberDeal": 0,        // 成交数量
        "total": null           // 总量
    }
}

POST /V2/Trade/marketTrade

参数

参数名 必选 类型 备注
symbol string 交易对名称,例如 eth_btc
amount string 买时传入金额,卖时传入数量
type int 类型 1 买 2 卖

返回字段

字段名 必选 类型 备注
orderId int 委托单id
accountId int 用户uid
price string/null 价格
amount string 数量
numberOver string 剩余数量
flag string 买卖标志
status int 0未成交 1部分成交 2全部成交 3已取消
coinFrom string 要兑换的币
coinTo string 目标兑换
numberDeal float 成交数量
total string/null 总量

批量提交限价委托

example of CURL

curl "https://apiv2.bitz.com/V2/Trade/addEntrustSheetBatch\
-X POST\
-d tradeData=[{\"coins\":\"dkkt_usdt\",\"number\":1,\"price\":0.6,\"type\":1},{\"coins\":\"dkkt_usdt\",\"number\":1,\"price\":0.7,\"type\":1}]\
"

Payload

{
    "status": 200,
    "msg": "",
    "time": 1579507028,
    "microtime": "0.16015400 1579507028",
    "source": "api",
    "data": [   // 依序返回每个委托单的信息
        {
            "orderId": 1036053514,  // 委托单id
            "accountId": 70001018,  // UID
            "price": "8500.00",     // 委托价格
            "amount": "1.00",       // 委托数量
            "numberOver": "1.00",   // 剩余数量
            "flag": "sale",         // 买卖类型
            "status": 0,            // 0未成交 1部分成交 2全部成交 3已取消
            "coinFrom": "btc",      // 要兑换的币
            "coinTo": "usdt",       // 目标兑换
            "fieldAmount": 0        // 成交数量
        }
    ]
}

POST /V2/Trade/addEntrustSheetBatch

参数

参数名 必选 类型 备注
tradeData string 请求json串,最大30组数据

tradeData 字段说明

参数名 必选 类型 备注
type string 购买类型 1买进 2 卖出
price float 委托价格
number float 委托数量
coins string 交易对名称,例如 eth_btc

说明

批量下单中有一条包含错误参数,会导致全部失败

返回字段

字段名 必选 类型 备注
orderId int 委托单id
accountId int UID
price string 委托价格
amount string 委托数量
numberOver string 剩余数量
flag string 买卖类型
status int 0未成交 1部分成交 2全部成交 3已取消
coinFrom string 要兑换的币
coinTo string 目标兑换
fieldAmount float 成交数量

撤销限价委托

example of CURL

curl "https://apiv2.bitz.com/V2/Trade/cancelEntrustSheet\
-X POST\
-d orderId=12345654321\
"

Payload

{
  "status": 200,
  "msg": "",
  "time": 1573207257,
  "microtime": "0.25998300 1573207257",
  "source": "api",
  "data": {
    "updateAssetsData": {       // 资产变动
      "coin": "bz",             // 币种
      "over": "1000.00000000",  // 可用
      "lock": "-1000.00000000"  // 冻结
    },
    "assetsInfo": {             // 用户当前资产
      "coin": "bz",
      "over": "999.00000000",
      "lock": "-999.00000000"
    }
  }
}

POST /V2/Trade/cancelEntrustSheet

参数

参数名 必选 类型 备注
orderId string 委托单id

返回字段

字段名 必选 类型 备注
updateAssetsData <Assets> 资产变动
assetsInfo <Assets> 用户当前资产

Assets

字段名 必选 类型 备注
coin string 币种
over string 可用
lock string 冻结

批量撤销限价委托

example of CURL

curl "https://apiv2.bitz.com/V2/Trade/cancelAllEntrustSheet\
-X POST\
-d ids=1,2,3,4,5\
"

Payload

{
  "status": 200,
  "msg": "",
  "time": 1573207257,
  "microtime": "0.25998300 1573207257",
  "source": "api",
  "data": {
    "744173808": {              // 委托单 ID
      "updateAssetsData": {       // 资产变动
        "coin": "bz",             // 币种
        "over": "1000.00000000",  // 可用
        "lock": "-1000.00000000"  // 冻结
      },
      "assetsInfo": {             // 用户当前资产
        "coin": "bz",
        "over": "999.00000000",
        "lock": "-999.00000000"
      }
    }
  }
}

POST /V2/Trade/cancelAllEntrustSheet

参数

参数名 必选 类型 备注
ids string 委托单ids 1,2,3,4 以英文逗号分隔

返回字段

字段名 必选 类型 备注
updateAssetsData <Assets> 资产变动
assetsInfo <Assets> 用户当前资产

Assets

字段名 必选 类型 备注
coin string 币种
over string 可用
lock string 冻结

获取个人历史委托单

example of CURL

curl "https://apiv2.bitz.com/V2/Trade/getUserHistoryEntrustSheet\
-X POST\
-d coinFrom=vtc\
&coinTo=dkkt\
"

Payload

{
  "status": 200,
  "msg": "",
  "time": 1573207257,
  "microtime": "0.25998300 1573207257",
  "source": "api",
  "data": {
    "data": [   // 订单数据列表
      {
        "orderId":"693248739",   // 订单号
        "accountId":"2074056",
        "price":"100.00000000",   // 委托价格
        "amount":"10.0000",       // 委托数量
        "fieldCashAmount":"0.00000000",   // 已成交总金额
        "numberOver":"0.0000",    // 剩余数量
        "fieldAmount":"0.0000",   // 成交数量
        "flag":"sale",            // 买卖类型
        "status":3,               // 0:未成交, 1:部分成交, 2:全部成交, 3:已经撤销
        "isNew":"N",              // 新委托
        "coinFrom":"vtc",         // 要兑换的币
        "coinTo":"dkkt",          // 目标兑换
        "tradeType" :"1",         // 1 限价 2 市价
        "createdAt": "1533035300"
      }
    ],
    "pageInfo": {             // 分页信息
      "limit": "10",          // 每页条数
      "offest": "0",          // 起始条目
      "current_page": 1,      // 当前页
      "page_size": 10,        // 每页显示数
      "total_count": 2,       // 总条数
      "page_count": 1         // 总页数
    }
  }
}

POST /V2/Trade/getUserHistoryEntrustSheet

参数

参数名 必选 类型 备注
coinFrom string eos、vtc 币种
coinTo string btc、eth交易区间
type integer 1:买,2:卖 不传时返回所有
page integer 当前页数
size integer 每页展示数量 最大值 100
startTime string 开始时间戳
endTime string 结束时间戳

返回字段

data

字段名 必选 类型 备注
orderId string 订单号
price string 委托价格
amount string 委托数量
fieldCashAmount string 已成交总金额
numberOver string 剩余数量
fieldAmount string 成交数量
flag string 买卖类型
status int 0:未成交, 1:部分成交, 2:全部成交, 3:已经撤销
isNew string 新委托
coinFrom string 要兑换的币
coinTo string 目标兑换
tradeType string 1 限价 2 市价

pageInfo

字段名 必选 类型 备注
limit int 每页条数
offest int 起始条目
current_page int 当前页
page_size int 每页显示数
total_count int 总条数
page_count int 总页数

获取个人当前委托单

example of CURL

curl "https://apiv2.bitz.com/V2/Trade/getUserNowEntrustSheet\
-X POST\
-d coinFrom=vtc\
&coinTo=dkkt\
"

Payload

{
  "status": 200,
  "msg": "",
  "time": 1573207257,
  "microtime": "0.25998300 1573207257",
  "source": "api",
  "data": {
    "data": [
      {
        "orderId": "693248739",  // 订单号
        "accountId": "2074056",
        "price": "100",           // 委托价格
        "amount": "10",           // 委托数量
        "numberOver": "10",       // 剩余数量
        "flag": "sale",           // 买卖类型
        "status": "0",            // 0:未成交, 1:部分成交, 2:全部成交, 3:已经撤销
        "coinFrom": "vtc",        // 要兑换的币
        "coinTo": "dkkt",         // 目标兑换
        "fieldAmount": "0",       // 成交数量
        "isNew": "N",             // 新委托
        "tradeType": "1",         //1 限价 2 市价
        "createdAt": "1533035300",          // 创建时间(戳)
        "fieldCashAmount": "0.00000000"     // 已成交总金额
      }
    ],
    "pageInfo": {         // 分页数据
      "limit": "10",      // 每页条数
      "offest": "0",      // 起始条数
      "current_page": 1,  // 当前页
      "page_size": 10,    // 每页显示数
      "total_count": 2,   // 总条数
      "page_count": 1     // 总页数
    }
  }
}

POST /V2/Trade/getUserNowEntrustSheet

参数

参数名 必选 类型 备注
coinFrom string eos、vtc 币种
coinTo string btc、eth交易区间
type integer 1:买,2:卖 不传时返回所有
page integer 当前页数
size integer 每页展示数量 最大值100
startTime string 开始时间戳
endTime string 结束时间戳

返回字段

data

字段名 必选 类型 备注
orderId string 订单号
price string 委托价格
amount string 委托数量
numberOver string 剩余数量
flag string 买卖类型
status int 0:未成交, 1:部分成交, 2:全部成交, 3:已经撤销
coinFrom string 要兑换的币
coinTo string 目标兑换
fieldAmount string 成交数量
isNew string 新委托
tradeType string 1 限价 2 市价
createdAt string 创建时间(戳)
fieldCashAmount string 已成交总金额

pageInfo

字段名 必选 类型 备注
limit int 每页条数
offest int 起始条目
current_page int 当前页
page_size int 每页显示数
total_count int 总条数
page_count int 总页数

获取委托单详情

example of CURL

curl "https://apiv2.bitz.com/V2/Trade/getEntrustSheetInfo\
-X POST\
-d orderId=123456\
"

Payload

{
    "status": 200,
    "msg": "",
    "time": 1579509364,
    "microtime": "0.46752700 1579509364",
    "source": "api",
    "data": {
        "orderId": "1036053514",      // 订单ID
        "accountId": "70001018",      // UID
        "price": "8500.0000000000",   // 单价
        "amount": "1.00000000",       // 数量
        "fieldCashAmount": "8500.000000000000000000", // 委托总价格
        "numberOver": "1.00000000",   // 剩余数量
        "fieldAmount": "0.00000000",  // 成交数量
        "flag": "sale",               // 买卖标志
        "status": 3,                  // 0:未成交, 1:部分成交, 2:全部成交, 3:已经撤销
        "coinFrom": "btc",            // 要兑换的币
        "coinTo": "usdt",             // 目标兑换
        "averagePrice": "0",          // 成交均价
        "orderTotalPrice": "0",       // 订单成交价格
        "tradeType": "1",             // 1 限价 2 市价
        "createdAt": "1579507025"     // 提交时间
    }
}

POST /V2/Trade/getEntrustSheetInfo

参数

参数名 必选 类型 备注
orderId string 委托单id

返回字段

字段名 必选 类型 备注
orderId string 委托单id
accountId string 用户uid
price string 单价
amount string 数量
fieldCashAmount string 委托总价格
numberOver string 剩余数量
fieldAmount string 成交数量
flag string 买卖标志
status int 0:未成交, 1:部分成交, 2:全部成交, 3:已经撤销
coinFrom string 要兑换的币
coinTo string 目标兑换
averagePrice string 成交均价
orderTotalPrice string 订单成交价格
tradeType string 1 限价 2 市价
createdAt string 提交时间

获取个人资产

example of CURL

curl "https://apiv2.bitz.com/V2/Assets/getUserAssets\
-X POST"

Payload

{
  "status": 200,
  "msg": "",
  "time": 1573207257,
  "microtime": "0.25998300 1573207257",
  "source": "api",
  "data": {
    "cny": "0.00000000",        // CNY 估值
    "usd": "0.00000000",        // USD 估值
    "btc_total": "0.00000000",  // BTC 估值
    "list": [
      {
        "currency": "zpr",          // 币种名称
        "balance": "37.49067275",   // 余额
        "over": "37.49067275",      // 可用
        "lock": "0.00000000",       // 冻结
        "btc": "0.00000000",        // btc 估值
        "usd": "0.00000000",        // usd 估值
        "cny": "0.00000000"         // cny 估值
      }
    ]
  }
}

POST /V2/Assets/getUserAssets

返回字段

字段名 必选 类型 备注
cny string CNY 估值
usd string USD 估值
btc_total string BTC 估值
list array<asset> 资产列表

asset

字段名 必选 类型 备注
currency string 币种名称
balance string 余额
over string 可用
lock string 冻结
btc string btc 估值
usd string usd 估值
cny string cny 估值

合约行情

合约交易市场列表

example of CURL

curl "https://apiv2.bitz.com/V2/Market/getContractCoin?\
contractId=123456\
"

Payload

{
  "status": 200,
  "msg": "",
  "time": 1573207257,
  "microtime": "0.25998300 1573207257",
  "source": "api",
  "data": [
    {
      "contractId": "101",                // 合约id
      "symbol": "BTC",                    // 合约标识
      "settleAnchor": "USDT",             // 结算单位
      "quoteAnchor": "USDT",              // 计价单位
      "contractAnchor": "BTC",            // 合约单位
      "contractValue": "0.00100000",      // 单张合约价值
      "pair": "BTC_USDT",                 // 合约市场
      "expiry": "0000-00-00 00:00:00",    // 合约交割时间(非永续合约)
      "maxLeverage": "100",               // 最大杠杆倍数
      "maintanceMargin": "0.00500000",    // 维持保证金比例
      "makerFee": "-0.00030000",          // maker费率
      "takerFee": "0.00070000",           // taker费率
      "settleFee": "0.00070000",          // 交割费率
      "priceDec": "1",                    // 价格浮点数显示位数
      "anchorDec": "2",                   // 结算单位浮点数显示位数
      "status": "1",                      // 合约状态,1:交易中,0:暂停交易,-1:永久停止
      "isreverse": "-1",                  // 1:反向合约,-1:正向合约
      "allowCross": "1",                  // 是否可以全仓,1:可以,-1:不可以
      "allowLeverages": "2",              // 系统允许开的杠杆倍数
      "maxOrderNum": "50",                // 最多可挂未成交委单数量
      "maxAmount": "5000",                // 单个委单最多数量限制
      "minAmount": "1",                   // 单个委单最少数量限制
      "maxPositionAmount": "5000"         // 最大持仓数量
    }
  ]
}

GET /V2/Market/getContractCoin

参数

参数名 必选 类型 备注
contractId int 合约ID

返回字段

字段名 必选 类型 备注
contractId string 合约id
symbol string 合约标识
settleAnchor string 结算单位
quoteAnchor string 计价单位
contractAnchor string 合约单位
contractValue string 单张合约价值
pair string 合约市场
expiry string 合约交割时间(非永续合约)
maxLeverage string 最大杠杆倍数
maintanceMargin string 维持保证金比例
makerFee string maker费率
takerFee string taker费率
settleFee string 交割费率
priceDec string 价格浮点数显示位数
anchorDec string 结算单位浮点数显示位数
status string 合约状态,1:交易中,0:暂停交易,-1:永久停止
isreverse string 1:反向合约,-1:正向合约
allowCross string 是否可以全仓,1:可以,-1:不可以
allowLeverages string 系统允许开的杠杆倍数
maxOrderNum string 最多可挂未成交委单数量
maxAmount string 单个委单最多数量限制
minAmount string 单个委单最少数量限制
maxPositionAmount string 最大持仓数量

合约K线数据 contract kline

example of CURL

curl "https://apiv2.bitz.com/V2/Market/getContractKline?\
contractId=123456\
&type=5m\
&size=20\
"

Payload

{
  "status": 200,
  "msg": "",
  "time": 1573207257,
  "microtime": "0.25998300 1573207257",
  "source": "api",
  "data": {
    "lists": [
      [
        "1558433100000",        // 时间
        "7921.69000000",        // 开盘价
        "7921.96000000",        // 最高价
        "7882.31000000",        // 最低价
        "7882.31000000",        // 收盘价
        "1793940.00000000",     // 交易量
        "14183930623.27000000"  // 成交额
      ]
    ]
  }
}

GET /V2/Market/getContractKline

参数

参数名 必选 类型 备注
contractId int 合约ID
type string K线类型 1m, 5m, 15m, 30m, 1h, 4h, 1d
size int 获取数据数量 1-300, 默认300

合约交易市场深度

example of CURL

curl "https://apiv2.bitz.com/V2/Market/getContractOrderBook?\
contractId=123456\
&depth=10\
"

Payload

{
  "status": 200,
  "msg": "",
  "time": 1573207257,
  "microtime": "0.25998300 1573207257",
  "source": "api",
  "data": {
    "bids": [
      {
        "price": "57.70000000",   // 买一价格
        "amount": "2820"          // 买一️数量
      }
    ],
    "asks": [
      {
        "price": "8202.70000000", // 卖一价格
        "amount": "4863"          // 卖一数量
      }
    ]
  }
}

GET /V2/Market/getContractOrderBook

参数

参数名 必选 类型 备注
contractId int 合约ID
depth string 深度条数 5, 10, 15, 20, 30, 100,默认10

返回字段

字段名 必选 类型 备注
bids array<item> 买深度
asks array<item> 卖深度

item

字段名 必选 类型 备注
price string 价格
amount string 数量

获取某个合约成交历史

example of CURL

curl "https://apiv2.bitz.com/V2/Market/getContractTradesHistory?\
contractId=123456\
&pageSize=10\
"

Payload

{
  "status": 200,
  "msg": "",
  "time": 1573207257,
  "microtime": "0.25998300 1573207257",
  "source": "api",
  "data": {
    "lists": [
      {
        "time": 1558432920,   // 成交时间戳
        "price": "7926.41",   // 价格
        "num": 7137,          // 合约张数
        "type": "buy"         // 交易类型
      }
    ]
  }
}

GET /V2/Market/getContractTradesHistory

参数

参数名 必选 类型 备注
contractId int 合约ID
pageSize int 获取数据数量 10-300条数据 默认10

返回字段

字段名 必选 类型 备注
time string 成交时间戳
price string 价格
num string 合约张数
type string 交易类型

获取合约交易最新行情

example of CURL

curl "https://apiv2.bitz.com/V2/Market/getContractTickers?\
contractId=123456\
"

Payload

{
  "status": 200,
  "msg": "",
  "time": 1573207257,
  "microtime": "0.25998300 1573207257",
  "source": "api",
  "data": [
    {
      "contractId": "101",      // 合约ID
      "pair": "BTC_USD",        // 合约市场
      "min": "7252.26",         // 24H最低价
      "max": "8316.42",         // 24H最高价
      "latest": "8061.40",      // 最新价格
      "change24h": "0.1072",    // 24H涨跌比例
      "amount": "3445152.00",   // 成交量
      "volumn": "437.18",       // 成交额
      "openInterest": "810.00", // 持仓量
      "indexPrice": "8065.25",  // 指数价格
      "fairPrice": "8060.09",   // 公平价格
      "nextFundingRate": "-0.00075000"  // 预测资金费率
    }
  ]
}

GET /V2/Market/getContractTickers

参数

参数名 必选 类型 备注
contractId int 合约ID

返回字段

字段名 必选 类型 备注
contractId string 合约ID
pair string 合约市场
min string 24H最低价
max string 24H最高价
latest string 最新价格
change24h string 24H涨跌比例
amount string 成交量
volumn string 成交额
openInterest string 持仓量
indexPrice string 指数价格
fairPrice string 公平价格
nextFundingRate string 预测资金费率

合约交易

合约交易下单

example of CURL

curl "https://apiv2.bitz.com/V2/Contract/addContractTrade\
-X POST\
-d contractId=12345654321\
&amount=10\
&leverage=10\
&direction=1\
&type=market\
&isCross=1\
"

Payload

{
  "status": 200,
  "msg": "",
  "time": 1573207257,
  "microtime": "0.25998300 1573207257",
  "source": "api",
  "data": {
    "orderId": 710370 // 生成的交易 ID
  }
}

POST /V2/Contract/addContractTrade

参数

参数名 必选 类型 备注
contractId int 合约ID
price float 价格,如果传入类型为market,则无需传递price
amount int 合约张数
leverage float 杠杆倍数
direction int 委托方向 1: 做多;-1: 做空
type string 委托类型 limit: 限价单; market: 市价单,要求字符串小写
isCross int 是否全仓 1: 全仓,-1:非全仓

返回字段

字段名 必选 类型 备注
orderId int 生成的交易 ID

合约交易取消委托

请求

example of CURL

curl "https://apiv2.bitz.com/V2/Contract/cancelContractTrade\
-X POST\
-d entrustSheetId=12345654321\
"

Payload

{
  "status": 200,
  "msg": "",
  "time": 1573207257,
  "microtime": "0.25998300 1573207257",
  "source": "api",
  "data": {
    "orderId": 710370   // 取消的交易 ID
  }
}

POST /V2/Contract/cancelContractTrade

参数

参数名 必选 类型 备注
entrustSheetId int 订单ID 返回值中的orderId

返回字段

字段名 必选 类型 备注
orderId int 生成的交易 ID

获取当前仓位

example of CURL

curl "https://apiv2.bitz.com/V2/Contract/getContractActivePositions\
-X POST\
-d contractId=12345654321\
"

Payload

{
  "status": 200,
  "msg": "",
  "time": 1573207257,
  "microtime": "0.25998300 1573207257",
  "source": "api",
  "data": {
    "positionId": "9", //仓位ID
    "contractId": "101", //合约ID
    "price": "7980.74",  //开仓均价
    "direction": "1",    //仓位方向,1:多仓,-1:空仓
    "amount": "1500",    //仓位的合约张数
    "liquidationPrice": "7287.98", //强平价格
    "rlzPnl": "0.00010170",   //已实现盈亏
    "unrlzPnl": "0.00044862", //未实现盈亏
    "margin": "0.01930883",   //仓位保证金
    "leverage": "10.00000000", //杠杆倍数
    "isCross": "-1",  //是否全仓, 1:是,-1:不是
    "pair": "BTC_USD" //合约标识
  }
}

POST /V2/Contract/getContractActivePositions

参数

参数名 必选 类型 备注
contractId int 合约ID

返回字段

字段名 必选 类型 备注
positionId string 仓位ID
contractId string 合约ID
price string 开仓均价
direction string 仓位方向,1:多仓,-1:空仓
amount string 仓位的合约张数
liquidationPrice string 强平价格
rlzPnl string 已实现盈亏
unrlzPnl string 未实现盈亏
margin string 仓位保证金
leverage string 杠杆倍数
isCross string 是否全仓, 1:是,-1:不是
pair string 合约标识

获取合约账户权益(资产)

example of CURL

curl "https://apiv2.bitz.com/V2/Contract/getContractAccountInfo\
"

Payload

{
  "status": 200,
  "msg": "",
  "time": 1573207257,     
  "microtime": "0.25998300 1573207257",
  "source": "api",
  "data": {
    "time": 1557928650,             
    "estimate_BTC": "8.00667445",   // 用户总权益 BTC 估值
    "estimate_USDT": "17000.00",    // 用户总权益 USDT 估值
    "estimate_CNY": "0.00",         // 用户总权益 CNY 估值
    "balances": [
      {
        "coin": "BTC",                    // 币种
        "balance": "8.00000000",          // 可用余额
        "positionMargin": "0.00635670",   // 仓位保证金
        "orderMargin": "0.00000000",      // 委托保证金
        "unrlzPnl": "0.00031774",         // 未实现盈亏
        "total": "8.00667445",            // 该币种的总估值
        "estimate_BTC": "8.00667445",     // 该币种的 BTC 总估值
        "estimate_USDT": "0.00",          // 该币种的 USDT 总估值
        "estimate_CNY": "0.00"            // 该币种的 CNY 总估值
      }
    ]
  }
}

POST /V2/Contract/getContractAccountInfo

返回字段

字段名 必选 类型 备注
estimate_BTC string 用户总权益 BTC 估值
estimate_USDT string 用户总权益 USDT 估值
estimate_CNY string 用户总权益 CNY 估值
balances <balance> 余额详情

balance

字段名 必选 类型 备注
coin string 币种
balance string 可用余额
positionMargin string 仓位保证金
orderMargin string 委托保证金
unrlzPnl string 未实现盈亏
total string 该币种的总估值
estimate_BTC string 该币种的 BTC 总估值
estimate_USDT string 该币种的 USDT 总估值
estimate_CNY string 该币种的 CNY 总估值

获取已平仓位列表

example of CURL

curl "https://apiv2.bitz.com/V2/Contract/getContractMyPositions\
-X POST\
-d contractId=12345654321\
&page=1\
&pagesize=10\
"

Payload

{
  "status": 200,
  "msg": "",
  "time": 1573207257,
  "microtime": "0.25998300 1573207257",
  "source": "api",
  "data": {
    "positionId": "9",        // 仓位ID
    "contractId": "101",      // 合约ID
    "rlzPnl": "0.00775756",   // 已实现盈亏
    "startTime": 1557747092,  // 交易开始时间
    "endTime": 1557783198,    // 交易完成时间
    "pair": "BTC_USD"         // 合约市场
  }
}

POST /V2/Contract/getContractMyPositions

参数

参数名 必选 类型 备注
contractId int 合约ID
page int 默认1 范围1-10
pageSize int 默认50 范围1-50

返回字段

字段名 必选 类型 备注
positionId string 仓位ID
contractId string 合约ID
rlzPnl string 已实现盈亏
startTime int 交易开始时间
endTime int 交易完成时间
pair string 合约市场

获取单个或多个委托单明细

example of CURL

curl "https://apiv2.bitz.com/V2/Contract/getContractOrderResult\
-X POST\
-d entrustSheetIds=12345654321\
"

Payload

{
  "status": 200,
  "msg": "",
  "time": 1573207257,
  "microtime": "0.25998300 1573207257",
  "source": "api",
  "data": {
    "orderId": "734709",  // 委托ID
    "contractId": "101",  // 合约ID
    "pair": "BTC_USD",    // 合约市场
    "amount": "500",      // 委托数量
    "price": "7500.00",   // 委托价格
    "type": "limit",      // 委托类型,limit:限价委托,market:市价委托
    "leverage": "10",     // 杠杆倍数
    "direction": "1",     // 委托方向,1:做多,-1:做空
    "orderStatus": "-1",  // 委托状态,0:未完成,1:已完成,-1:已取消
    "available": "500",   // 剩余委托张数
    "time": 1557994750    // 委托时间
  }
}

POST /V2/Contract/getContractOrderResult

参数

参数名 必选 类型 备注
entrustSheetIds string 委托单ID,最多50个,以英文逗号分隔 返回值中的orderId

返回字段

字段名 必选 类型 备注
orderId string 委托ID
contractId string 合约ID
pair string 合约市场
amount string 委托数量
price string 委托价格
type string 委托类型,limit:限价委托,market:市价委托
leverage string 杠杆倍数
direction string 委托方向,1:做多,-1:做空
orderStatus string 委托状态,0:未完成,1:已完成,-1:已取消
available string 剩余委托张数
time int 委托时间

获取某个委托的成交明细

example of CURL

curl "https://apiv2.bitz.com/V2/Contract/getContractTradeResult\
-X POST\
-d entrustSheetId=12345654321\
&page=1\
&pageSize=10\
"

Payload

{
  "status": 200,
  "msg": "",
  "time": 1573207257,
  "microtime": "0.25998300 1573207257",
  "source": "api",
  "data": {
    "tradeId": "6534702673362395142", // 成交ID
    "contractId": "101",              // 合约ID
    "pair": "BTC_USD",                // 合约市场
    "price": "8000.00",               // 成交价格
    "tradeNum": "500",                // 成交数量
    "time": 1557994526,               // 成交时间
    "orderId": "732204",              // 委托单ID
    "orderPrice": "8000.00",          // 委托价格
    "type": "buy",                    // 交易类型
    "tradeFee": "0.00001250",         // 交易手续费
    "leverage": "10",                 // 杠杆倍数
    "isCross": "-1"                   // 是否全仓,1:是,-1:不是
  }
}

POST /V2/Contract/getContractTradeResult

参数

参数名 必选 类型 备注
entrustSheetId int 返回值中的orderId
page int 默认1 范围1-10
pageSize int 默认50 范围1-50

返回字段

字段名 必选 类型 备注
tradeId string 成交ID
contractId string 合约ID
pair string 合约市场
price string 成交价格
tradeNum string 成交数量
time int 成交时间
orderId string 委托单ID
orderPrice string 委托价格
type string 交易类型
tradeFee string 交易手续费
leverage string 杠杆倍数
isCross string 是否全仓,1:是,-1:不是

获取我的活动委托

example of CURL

curl "https://apiv2.bitz.com/V2/Contract/getContractOrder\
-X POST\
-d contractId=12345654321\
"

Payload

{
  "status": 200,
  "msg": "",
  "time": 1573207257,
  "microtime": "0.25998300 1573207257",
  "source": "api",
  "data": {
    "orderId": "734709",  //委托单ID
    "contractId": "101",  //合约ID
    "amount": "500",      //委托张数
    "price": "7500.00",   //委托价格
    "type": "limit",      //委托类型,limit:限价委托,market:市价委托
    "leverage": "10",     //杠杆倍数
    "direction": "1",     //委托方向,1:做多,-1:做空
    "orderStatus": "0",   //委托状态,0:未完成,1:已完成,-1:已取消
    "isCross": "-1",      //是否全仓,1:是,-1:不是
    "available": "500",   //剩余委托张数
    "time": 1557994750,   //委托时间
    "pair": "BTC_USD"     //合约市场
  }
}

POST /V2/Contract/getContractOrder

参数

参数名 必选 类型 备注
contractId int 合约ID

返回字段

字段名 必选 类型 备注
orderId string 委托单ID
contractId string 合约ID
amount string 委托张数
price string 委托价格
type string 委托类型,limit:限价委托,market:市价委托
leverage string 杠杆倍数
direction string 委托方向,1:做多,-1:做空
orderStatus string 委托状态,0:未完成,1:已完成,-1:已取消
isCross string 是否全仓,1:是,-1:不是
available string 剩余委托张数
time int 委托时间
pair string 合约市场

获取我的委托历史

example of CURL

curl "https://apiv2.bitz.com/V2/Contract/getContractMyHistoryTrade\
-X POST\
-d contractId=12345654321\
"

Payload

{
  "status": 200,
  "msg": "",
  "time": 1573207257,
  "microtime": "0.25998300 1573207257",
  "source": "api",
  "data": {
    "orderId": "732204",    // 委托单ID
    "contractId": "101",    // 合约ID
    "price": "8000.00",     // 委托价格
    "amount": "500",        // 委托张数
    "type": "limit",        // 委托类型,limit:限价委托,market:市价委托
    "leverage": "10",       // 杠杆倍数
    "direction": "1",       // 委托方向,1:做多,-1:做空
    "orderStatus": "1",     // 委托状态,0:未完成,1:已完成,-1:已取消
    "isCross": "-1",        // 是否全仓,1:是,-1:不是
    "available": "0",       // 剩余委托张数
    "time": 1557993999,     // 委托时间
    "pair": "BTC_USD"       // 合约市场
  }
}

POST /V2/Contract/getContractMyHistoryTrade

参数

参数名 必选 类型 备注
contractId int 合约ID
page int 默认1 范围1-10
pageSize int 默认50 范围 1-50

返回字段

字段名 必选 类型 备注
orderId string 委托单ID
contractId string 合约ID
price string 委托价格
amount string 委托张数
type string 委托类型,limit:限价委托,market:市价委托
leverage string 杠杆倍数
direction string 委托方向,1:做多,-1:做空
orderStatus string 委托状态,0:未完成,1:已完成,-1:已取消
isCross string 是否全仓,1:是,-1:不是
available string 剩余委托张数
time int 委托时间
pair string 合约市场

获取我的成交历史

example of CURL

curl "https://apiv2.bitz.com/V2/Contract/getContractMyTrades\
-X POST\
-d contractId=12345654321\
"

Payload

{
    "status": 200,
    "msg": "",
    "time": 1573207257,
    "microtime": "0.25998300 1573207257",
    "source": "api",
    "data": [
        {
            "tradeId": "6534702673362395142", //成交ID
            "contractId": "1",                //合约ID
            "pair": "BTC_USD",                //合约市场
            "price": "8000.00",               //成交价格
            "num": "500",                     //成交数量
            "type": "buy",                    //交易类型
            "tradeFee": "0.00001250",         //交易手续费
            "leverage": "10",                 //杠杆倍数
            "isCross": "-1",                  //是否全仓,1:是,-1:不是
            "time": 1557994526                //成交时间
        }
    ]
}

POST /V2/Contract/getContractMyTrades

参数

参数名 必选 类型 备注
contractId int 合约ID
page int 默认1 范围1-10
pageSize int 默认50 范围1-50

返回字段

字段名 必选 类型 备注
tradeId string 成交ID
contractId string 合约ID
pair string 合约市场
price string 成交价格
num string 成交数量
type string 交易类型
tradeFee string 交易手续费
leverage string 杠杆倍数
isCross string 是否全仓,1:是,-1:不是
time int 成交时间

websockets行情

websocket URL

wss://wsapi.bitz.plus/

数据压缩

为了提高数据传输效率,BitZ WebSocket API已于2019年10月08日17:00 (UTC+8)停止返回非压缩数据,仅返回GZIP压缩数据,请BitZ API用户们尽快升级: 订阅时增加dataType=1参数,收到数据后用户客户端解压。解压缩请参考文档及 demo

心跳及长连接策略

  1. 客户端5秒发送ping字符串到服务器,服务器将返回pong字符串,以此心跳维持长连接
  2. 服务器10秒检测: 如果60秒内没有收到客户端的ping消息,将主动断开连接
  3. 服务器5秒检测与客户端之间的网络连接状态,如此时网络中断,服务器会删除此次订阅,客户端不会再收到新消息,客户端此时需要重新发起订阅请求,以前的订阅请求都将失效
  4. 服务器在向客户端发送新消息时,也会检测此时的网络连接状态,如网络中断,同上处理

发送请求 命令格式

发送json

{
    "action":"Topic.sub",
    "data":{
        "symbol":"bz_usdt",
        "type":"market,depth,order,kline",
        "resolution":"60min",
        "_CDID":"100002",
        "dataType":"1"
    },
    "msg_id":1562156656532
}

命令详解:

action :

data :

1. symbol
2. type
3. resolution (非必传)
4. _CDID
5. dataType

msg_id :

market 行情消息

market 行情消息:

{
    "msgId": 0,     // 消息id
    "params": [],   // 参数
    "data": {       // data数据
        "btc_usdt": {               // 交易对名称
            "s": "btc_usdt",        // 交易对名称
            "q": "748289393.19",    // 24小时交易额
            "v": "68457.02",        // 24小时交易量
            "tp": "6.58",           // 今日涨跌幅
            "p24": "11.74",         // 24小时涨跌幅
            "o": "10138.95",        // 开盘价
            "h": "11500.00",        // 24小时最高价
            "l": "9728.61",         // 24小时最低价
            "n": "11330.00",        // 当前价格
            "nP": 4,                // 数量展示小数点位
            "pP": 2,                // 价格展示小数点位
            "cny": "77978.74",      // 人民币估值
            "usd": "11330.00",      // 美元估值
            "krw": "13235981.30",   // 韩元估值
            "jpy": "1220905.17"     // 日元估值
        },
        ...... // 其他所有交易对行情
    },
    "action": "Pushdata.market",    // 订阅类型
    "time": 1562159048028,          // 消息时间
    "source": "sub-api"             // 发送来源
}

推送字段

字段名 必选 类型 备注
s string 交易对名称
q string 24小时交易额
v string 24小时交易量
tp string 今日涨跌幅
p24 string 24小时涨跌幅
o string 开盘价
h string 24小时最高价
l string 24小时最低价
n string 当前价格
nP int 数量展示小数点位
pP int 价格展示小数点位
cny string 人民币估值
usd string 美元估值
krw string 韩元估值
jpy string 日元估值

order 成交单信息

order 成交单信息:

{
    "msgId": 0, // 消息id
    "params": { // 参数
        "symbol": "bz_usdt"     //交易对名称
    },
    "action": "Pushdata.order", //订阅类型
    "data": [   // data
        {
            "id": 1216814315,   // id
            "t": "21:04:10",    // 时间
            "T": 1562159050,    // 时间戳
            "p": "0.1599",      // 价格
            "n": "2185.0000",   // 数量
            "s": "sell"         // 方向 sell: 卖 buy:买
        }
    ],
    "time": 1562159051901,      // 消息时间
    "source": "sub-api"         // 消息来源
}

推送字段

字段名 必选 类型 备注
id int id
t string 时间
T int 时间戳
p string 价格
n string 数量
s string 方向 sell: 卖 buy:买

depth 深度信息

depth 深度信息:

{
    "msgId": 0, // 消息id
    "params": { // 参数
        "symbol": "bz_usdt"     // 交易对名称
    },
    "action": "Pushdata.depth", // 订阅类型
    "data": {   // data
        "asks": [            // 委托方向: asks: 卖、bids:买
            [
                "0.1586",       // 价格
                "616.4175",     // 数量
                "97.7638"       // 总额
            ]
        ]
    },
    "time": 1562159910917,  // 消息时间
    "source": "sub-api"     // 消息来源
}

推送字段

字段名 必选 类型 备注
asks array 卖列表:价格,数量,总额
bids array 买列表:价格,数量,总额

kline k线信息

kline k线信息:

{
    "msgId": 0, // 消息id
    "params": { // 参数
        "symbol": "bz_usdt",    // 交易对名称
        "resolution": "60min"   // k线类型
    },
    "action": "Pushdata.kline", // 订阅类型
    "data": {   // data
        "bars": [               // 包含k线轴列表
            {
                "time": "1562155200000",    // 毫秒时间戳
                "open": "0.1609",           // 开盘价
                "high": "0.1635",           // 最高价
                "low": "0.1575",            // 最低价
                "close": "0.1603",          // 收盘价
                "volume": "1288739.3374",   // 交易量
                "datetime": "2019-07-03 20:00:00" // k线轴时间
            }
        ],
        "resolution": "60min",      // k线类型
        "symbol": "bz_usdt",        //  k线交易对名称
        "from": "1562155200000",    // 开始时间
        "to": "1562151600000",      // 结束时间
        "size": 1                   // k线总数
    },
    "time": 1562156715923,  // 消息时间
    "source": "sub-api"     // 消息来源
}

推送字段

字段名 必选 类型 备注
bars array<BarItem> 包含k线轴列表
resolution string k线类型
symbol string k线交易对名称
from string 开始时间
to string 结束时间
size int k线总数

BarItem

字段名 必选 类型 备注
time string 毫秒时间戳
open string 开盘价
high string 最高价
low string 最低价
close string 收盘价
volume string 交易量
datetime string k线轴时间

错误提示

websocket 订单

简介

接入URL

Websocket 订单
wss://wsapi.bitz.plus/ws/v1

心跳消息

{
    "timestamp": 1594030416,
    "action": "ping"
}

{
    "action": "pong",
    "timestamp": 1594030416
}

当用户的Websocket客户端连接到 BitZ WebSocket 服务器后,客户端需定期(当前设为20秒)向服务器发送Ping消息并包含一整数值如下:

当服务端接收到此心跳信息后,会返回返回Pong消息并包含同一整数值:

action的有效取值

有效取值 取值说明
sub 订阅数据
req 数据请求
ping、pong 心跳数据
push 推送数据,服务端发送至客户端数据类型

限频

限制单API Key建连总数为10。当超过此限制时,会返回 -119 错误码

鉴权

鉴权请求格式如下:

{
    "ch": "auth",
    "params": {
        "accessKey": "040390e6935204a3c9c1ad0448e45356",
        "signatureMethod": "HmacSHA256",
        "signatureVersion": "1.0",
        "timestamp": "2020-07-06T04:21:11",
        "signature": "sx0y4SqYtW3Gy+Oq5lFyBi1Rjw+kFpJVDEyR/v+Cx+c="
    },
    "action": "req"
}

鉴权成功后返回数据格式如下:

{
    "action": "req",
    "code": 200,
    "ch": "auth"
}

参数说明

字段 必选 类型 描述
action string Websocket数据操作类型,鉴权固定值为req
ch string 请求主题,鉴权固定值为auth
accessKey string 您申请的API Key中的AccessKey
signatureMethod string 签名方法,用户计算签名寄语哈希的协议,固定值为HmacSHA256
signatureVersion string 签名协议版本,固定值为1.0
timestamp string 时间戳,您发出请求的时间(UTC时间)在查询请求中包含此值有助于防止第三方截取您的请求。如:2020-07-06T19:01:55 (UTC 时区)
signature string 签名, 计算得出的值,用于确保签名有效和未被篡改

签名步骤

PHP 签名函数示例

function loginSign($apikey, $apiSec) {
    $d = new DateTime() ;
    $d->setTimezone(new DateTimeZone("UTC")) ;
    $t = $d->format("Y-m-d\TH:i:s");

    $params['accessKey'] = $apikey ;
    $params['signatureMethod'] = 'HmacSHA256' ;
    $params['signatureVersion'] = '1.0' ;
    $params['timestamp'] = $t ;

    ksort($params) ;

    $ss = "" ; 

    foreach ($params as $key => $value) {
        if (strlen($ss)>0) {
            $ss.="&" ;
        }

        $ss.="$key=$value" ;
    }

    $sig = hash_hmac('sha256', $ss, $apiSec, true);
    $sig = base64_encode($sig);


    $params['signature'] = $sig ;

    return $params ;
}
  1. 生成参与签名的固定参数名为:accessKey,signatureMethod,signatureVersion,timestamp
  2. 签名方法参考 接入说明/验签
  3. 与 API 接口不同的是,参与 WS 签名的数据不需要进行url转码
  4. 签名有效期为 30 秒

订阅主题

注意:由于订阅依赖鉴权,所以订阅需要收到鉴权成功后进行(在没有完成鉴权的情况下调用订阅会提示 -101)

{
    "ch": "orders#ethusdt",
    "action": "sub"
}

请求成功后Websocket客户端会收到如下消息:

{
    "action": "sub",
    "code": 200,
    "ch": "orders#ethusdt"
}

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

订阅订单更新

API Key 权限:读取

订单的更新推送由任一以下事件触发:
- 订单创建(eventType=creation)
- 订单成交(eventType=trade)
- 订单撤销(eventType=cancellation)

不同事件类型所推送的消息中,字段列表略有不同。开发者可以采取以下两种方式设计返回的数据结构:
- 定义一个包含所有字段的数据结构,并允许某些字段为空
- 定义三个数据结构,分别包含各自的字段,并继承自一个包含公共数据字段的数据结构

订阅主题

orders#${symbol}

订阅参数

参数 数据类型 描述
symbol string 交易代码(支持通配符 * )

数据更新字段列表

当订单被挂单后 –

{
    "action": "push",
    "ch": "orders#ethusdt",
    "data": {
        "eventType": "creation",
        "orderCreateTime": 1594091249,
        "orderId": 7532423537,
        "orderPrice": "208.60",
        "orderSize": "0.1000",
        "orderStatus": "submitted",
        "symbol": "ethusdt",
        "type": "buy-limit"
    }
}
参数 数据类型 描述
eventType string 事件类型,有效值:creation
symbol string 交易代码
orderId long 订单ID
orderPrice string 订单价格
orderSize string 订单数量(对市价买单无效)
orderValue string 订单金额(仅对市价买单有效)
type string 订单类型,有效值:buy-market, sell-market, buy-limit, sell-limit
orderStatus string 订单状态,有效值:submitted
orderCreateTime long 订单创建时间

当订单成交后 –

{
    "action": "push",
    "ch": "orders#ethusdt",
    "data": {
        "tradePrice": "240.0000000000",
        "tradeVolume": "1.00000000",
        "tradeTime": 1599130028,
        "remainAmt": "0.000000",
        "orderId": 7557921347,
        "type": "buy-limit",
        "orderStatus": "filled",
        "symbol": "ethusdt",
        "eventType": "trade",
        "orderSize": "1.00000000",
        "filledSize": "1.00000000"
    }
}
参数 数据类型 描述
tradePrice string 成交价
tradeVolume string 成交量
tradeTime long 成交时间
remainAmt string 未成交数量(市价买单为未成交金额)
orderId long 订单ID
type string 订单类型,有效值:buy-market, sell-market, buy-limit, sell-limit
orderStatus string 订单状态,有效值:partial-filled, filled
symbol string 交易代码
eventType string 事件类型,有效值:trade
orderSize string 订单数量(对市价买单无效)
filledSize string 已成交数量(对市价买单无效)

注:
当一张taker订单同时与对手方多张订单成交后,所产生的每笔成交(tradePrice, tradeVolume, tradeTime)将被分别推送(而不是合并推送一笔)。

当订单被撤销后 –

{
    "action": "push",
    "ch": "orders#ethusdt",
    "data": {
        "eventType": "cancellation",
        "filledSize": "0.00000000",
        "lastActTime": 1599464706,
        "orderId": 7558094765,
        "orderPrice": "240.0000000000",
        "orderSize": "1.00000000",
        "orderStatus": "canceled",
        "remainAmt": "1.00000000",
        "symbol": "ethusdt",
        "type": "buy-limit"
    }
}
参数 数据类型 描述
eventType string 事件类型,有效值:cancellation
lastActTime string 订单最近更新时间
orderId string 订单ID
orderStatus string 订单状态,有效值:partial-canceled, canceled
remainAmt string 未成交数量(市价买单为未成交金额)
symbol string 交易代码
type string 订单类型,有效值:buy-market, sell-market, buy-limit, sell-limit
orderSize string 订单数量(对市价买单无效)
filledSize string 已成交数量(对市价买单无效)
orderPrice string 订单价格(对市价单无效)

错误码

The BitZ API uses the following error codes:

错误码 解释
200 成功
102 参数错误
103 校验失败
104 网络异常-1
105 签名不匹配
106 网络异常-2
107 请求路径错误
109 scretKey错误
110 访问请求次数超限
111 当前IP不在可信任IP范围内
112 服务正在维护中
114 每日请求次数已达上限
117 apikey有效期已到期
118 签名已过期
119 websocket 连接数受限
100015 交易密码错误
100044 请求数据失败
100101 交易对信息不存在
100201 交易对信息不存在
100301 交易对信息不存在
100401 交易对信息不存在
100302 k线type值错误
100303 k线size值超出范围
200000 委托单已撤销
200003 请先完善交易密码
200005 该账号不可交易
200025 临时停牌
200027 价格错误
200028 数量需大于0
200029 交易数量需在%s到%d之间
200030 超过价格范围
200031 资产不足
200032 请联系客服
200033 下单失败
200034 委托单已成交或已取消
200035 撤销失败,该委托单已成交
200036 撤销失败
200037 交易方向错误
200038 交易对错误
200055 委托记录不存在
200056 买入金额需在%s到%d之间
300069 apiKey不合法
300101 交易类型错误
300102 下单金额和数量不能小于0
300103 交易密码错误
301001 网络异常-3
200053 暂停充币
300041 暂停提币
200001 币种不存在
200054 暂时无法转出
300076 您的账号被限制充币
200004 钱包创建地址错误
300077 您的账号被限制提币
300046 请您先绑定邮箱
300007 请开启手机验证或谷歌验证
200003 请先完善交易密码
100015 验证交易密码错误
300040 单笔最小提币数量为%s,最大提币数量为%d
300042 修改安全设置后,需24小时后才能提现
300043 请先添加提币地址
100027 资产不足
300044 网络费设置错误
300048 不支持站内互转
300047 请输入合法的转出币地址
300049 memo最大的长度20位
300050 memo输入有误
300084 为使您的提币准确到账,向某些交易所地址提币必须输入正确格式的MEMO。若非此原因,请检查提币地址的格式是否错误
300045 您的账户单日提现限额为%s BTC,您还可以提现%d BTC
300075 需要审核且用户未绑定手机号
300091 非常抱歉,您的API提币额度超过限额,请您登录Bitz官方APP或官方网站,进行提币操作
100031 添加用户账号资产错误
100028 扣除资产错误
100031 添加用户账号资产错误
2001001 内部错误
2001003 参数错误
2001004 签名错误
2001005 合约不存在
2001006 该市场暂停交易
2001007 uid错误
2001008 未开通合约交易
2001009 价格错误
2001010 合约账户被锁定
300092 API提币地址没有加入白名单,且没有历史提币记录
300037 不在提币地址列表