Navbar
English 简体中文 繁体中文
json

简介

API 简介

欢迎使用BitV API！

此文档是BitV的唯一官方API文档，提供的功能和服务会在此持续更新，请大家及时关注。

您可以通过点击上方菜单来切换获取不同业务的API，还可通过点击右上方的语言按钮来切换文档语言。

文档右侧是请求参数以及响应结果的示例。

更新订阅

关于API新增、更新、下线等信息会提前发布公告进行通知，建议您关注和订阅我们的公告，及时获取相关信息。

联系我们

API 使用中如有疑问或咨询事项，请参考咨询事项 Q&A进行咨询。

快速入门

接入准备

如需使用API ，请先登录网页端，完成API key的申请和权限配置，再据此文档详情进行开发和交易。

您可以点击这里 创建 API Key。

每个母用户可创建20组Api Key，每个Api Key可对应设置读取、交易、提币三种权限。

权限说明如下：

创建成功后请务必记住以下信息：

接口类型

我们为用户提供两种接口，您可根据自己的使用场景和偏好来选择适合的方式进行查询行情、交易或提币。

REST API

REST，即Representational State Transfer的缩写，是目前较为流行的基于HTTP的一种通信机制，每一个URL代表一种资源。

交易或资产提币等一次性操作，建议开发者使用REST API进行操作。

WebSocket API

WebSocket是HTML5一种新的协议（Protocol）。它实现了客户端与服务器全双工通信，通过一次简单的握手就可以建立客户端和服务器连接，服务器可以根据业务规则主动推送信息给客户端。

市场行情和买卖深度等信息，建议开发者使用WebSocket API进行获取。

接口鉴权

以上两种接口均包含公共接口和私有接口两种类型。

公共接口可用于获取基础信息和行情数据。公共接口无需认证即可调用。

私有接口可用于交易管理和账户管理。每个私有请求必须使用您的API Key进行签名验证。

接入URLs

REST API

https://api.bitv.com

Websocket Feed（行情，不包含MBP增量行情）

wss://api.bitv.com/ws

Websocket Feed（行情，仅MBP增量行情）

wss://api.bitv.com/feed

Websocket Feed（资产和订单）

wss://api.bitv.com/ws/v2

签名认证

签名说明

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

一个合法的请求由以下几部分组成：

签名步骤

规范要计算签名的请求 因为使用 HMAC 进行签名计算时，使用不同内容计算得到的结果会完全不同。所以在进行签名计算前，请先对请求进行规范化处理。下面以查询某订单详情请求为例进行说明：

查询某订单详情时完整的请求URL

https://api.bitv.com/v1/order/orders?

AccessKeyId=e2xxxxxx-99xxxxxx-84xxxxxx-7xxxx

&SignatureMethod=HmacSHA256

&SignatureVersion=2

&Timestamp=2017-05-11T15:19:30

&order-id=1234567890

1. 请求方法（GET 或 POST，WebSocket用GET），后面添加换行符 “\n”

例如： GET\n

2. 添加小写的访问域名，后面添加换行符 “\n”

例如： api.bitv.com\n

3. 访问方法的路径，后面添加换行符 “\n”

例如查询订单：
/v1/order/orders\n

例如WebSocket v2
/ws/v2

4. 对参数进行URL编码，并且按照ASCII码顺序进行排序

例如，下面是请求参数的原始顺序，且进行URL编码后

AccessKeyId=e2xxxxxx-99xxxxxx-84xxxxxx-7xxxx

order-id=1234567890

SignatureMethod=HmacSHA256

SignatureVersion=2

Timestamp=2017-05-11T15%3A19%3A30

经过排序之后

AccessKeyId=e2xxxxxx-99xxxxxx-84xxxxxx-7xxxx

SignatureMethod=HmacSHA256

SignatureVersion=2

Timestamp=2017-05-11T15%3A19%3A30

order-id=1234567890

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

AccessKeyId=e2xxxxxx-99xxxxxx-84xxxxxx-7xxxx&SignatureMethod=HmacSHA256&SignatureVersion=2&Timestamp=2017-05-11T15%3A19%3A30&order-id=1234567890

6. 组成最终的要进行签名计算的字符串如下

GET\n

api.bitv.com\n

/v1/order/orders\n

AccessKeyId=e2xxxxxx-99xxxxxx-84xxxxxx-7xxxx&SignatureMethod=HmacSHA256&SignatureVersion=2&Timestamp=2017-05-11T15%3A19%3A30&order-id=1234567890

7. 用上一步里生成的 “请求字符串” 和你的密钥 (Secret Key) 生成一个数字签名

  1. 将上一步得到的请求字符串和 API 私钥作为两个参数，调用HmacSHA256哈希函数来获得哈希值。
  2. 将此哈希值用base-64编码，得到的值作为此次接口调用的数字签名。

4F65x5A2bLyMWVQj3Aqp+B4w+ivaA7n5Oi2SuYtCJ9o=

8. 将生成的数字签名加入到请求里

对于Rest接口：

  1. 把所有必须的认证参数添加到接口调用的路径参数里
  2. 把数字签名在URL编码后加入到路径参数里，参数名为“Signature”。

最终，发送到服务器的 API 请求应该为

https://api.bitv.com/v1/order/orders?AccessKeyId=e2xxxxxx-99xxxxxx-84xxxxxx-7xxxx&order-id=1234567890&SignatureMethod=HmacSHA256&SignatureVersion=2&Timestamp=2017-05-11T15%3A19%3A30&Signature=4F65x5A2bLyMWVQj3Aqp%2BB4w%2BivaA7n5Oi2SuYtCJ9o%3D

对于WebSocket接口：

  1. 按照要求的JSON格式，填入参数和签名。
  2. JSON请求中的参数不需要URL编码

例如：

{ "action": "req", "ch": "auth", "params": { "authType":"api", "accessKey": "e2xxxxxx-99xxxxxx-84xxxxxx-7xxxx", "signatureMethod": "HmacSHA256", "signatureVersion": "2.1", "timestamp": "2019-09-01T18:16:16", "signature": "4F65x5A2bLyMWVQj3Aqp+B4w+ivaA7n5Oi2SuYtCJ9o=" } }

子用户

子用户可以用来隔离资产与交易，资产可以在母子用户之间划转；子用户只能在子用户内进行交易，并且子用户之间资产不能直接划转，只有母用户有划转权限。

子用户拥有独立的登录账号密码和 API Key，均由母用户在网页端进行管理。

每个母用户可创建200个子用户，每个子用户可创建5组Api Key，每个Api Key可对应设置读取、交易两种权限。

子用户的 API Key 也可绑定 IP 地址, 有效期的限制与母用户的API Key一致。

子用户可以访问所有公共接口，包括基本信息和市场行情，子用户可以访问的私有接口如下：

接口 说明
POST /v1/order/orders/place 创建并执行订单
POST /v1/order/orders/{order-id}/submitcancel 撤销一个订单
POST /v1/order/orders/submitCancelClientOrder 撤销订单（基于client order ID）
POST /v1/order/orders/batchcancel 批量撤销订单
POST /v1/order/orders/batchCancelOpenOrders 撤销当前委托订单
GET /v1/order/orders/{order-id} 查询一个订单详情
GET /v1/order/orders 查询当前委托、历史委托
GET /v1/order/openOrders 查询当前委托订单
GET /v1/order/matchresults 查询成交
GET /v1/order/orders/{order-id}/matchresults 查询某个订单的成交明细
GET /v1/account/accounts 查询当前用户的所有账户
GET /v1/account/accounts/{account-id}/balance 查询指定账户的余额
GET /v1/account/history 查询账户流水
GET /v2/account/ledger 查询财务流水
POST /v1/account/transfer 资产划转

业务字典

交易对

交易对由基础币种和报价币种组成。以交易对 BTC/USDT 为例，BTC 为基础币种，USDT 为报价币种。

基础币种对应字段为 base-currency 。

报价币种对应字段为 quote-currency 。

账户

不同业务对应需要不同的账户，account-id为不同业务账户的唯一标识ID。

account-id可通过/v1/account/accounts接口获取，并根据account-type区分具体账户。

账户类型包括：

订单、成交相关ID说明

订单类型

当前的订单类型是由买卖方向以及订单操作类型组成，例如：buy-market，buy为买卖方向，market为操作类型。

买卖方向：

订单种类:

订单状态

接入说明

接口概览

接口分类 分类链接 概述
基础类 /v1/common/* 基础类接口，包括币种、币种对、时间戳等接口
行情类 /market/* 公共行情类接口，包括成交、深度、行情等
账户类 /v1/account/* /v1/subuser/* 账户类接口，包括账户信息，子用户等
订单类 /v1/order/* 订单类接口，包括下单、撤单、订单查询、成交查询等

该分类为大类整理，部分接口未遵循此规则，请根据需求查看有关接口文档。

新限频规则

限频规则

除已单独标注限频值为NEW的接口外 -

比如：

请求格式

所有的API请求都是restful，目前只有两种方法：GET和POST

返回格式

所有的接口都是JSON格式。其中v1和v2接口的JSON定义略有区别。

v1接口返回格式：最上层有四个字段：status, ch, ts 和 data。前三个字段表示请求状态和属性，实际的业务数据在data字段里。

以下是一个返回格式的样例：

{
  "status": "ok",
  "ch": "market.btcusdt.kline.1day",
  "ts": 1499223904680,
  "data": // per API response data in nested JSON object
}
参数名称 数据类型 描述
status string API接口返回状态
ch string 接口数据对应的数据流。部分接口没有对应数据流因此不返回此字段
ts long 接口返回的UTC时间的时间戳，单位毫秒
data object 接口返回数据主体

v2接口返回格式：最上层有三个字段：code, message 和 data。前两个字段表示返回码和错误消息，实际的业务数据在data字段里。

以下是一个返回格式的样例：

{
  "code": 200,
  "message": "",
  "data": // per API response data in nested JSON object
}
参数名称 数据类型 描述
code int API接口返回码
message string 错误消息（如果有）
data object 接口返回数据主体

数据类型

本文档对JSON格式中数据类型的描述做如下约定：

最佳实践

安全类

公共类

新限频规则

行情类

行情类数据的获取

最新成交价格的获取

盘口深度的获取

最新成交的获取

订单类

下单接口（/v1/order/orders/place）

搜索历史订单（/v1/order/orders）

订单状态变化的通知

账户类

资产变更

常见问题

API信息通知

关于API新增、更新、下线等信息会提前发布公告进行通知，建议您关注和订阅我们的公告，及时获取相关信息。

接入、验签相关

Q1：一个用户可以申请多少个Api Key？

A: 每个母用户可创建5组Api Key，每个Api Key可对应设置读取、交易、提币三种权限。 每个母用户还可创建200个子用户，每个子用户可创建5组Api Key，每个Api Key可对应设置读取、交易两种权限。

以下是三种权限的说明：

Q2：为什么经常出现断线、超时的情况？

A：请检查是否属于以下情况：

  1. 客户端服务器如在中国大陆境内，连接的稳定性很难保证。

Q3：为什么WebSocket总是断开连接？

A：常见原因有：

  1. 未回复Pong，WebSocket连接需在接收到服务端发送的Ping信息后回复Pong，保证连接的稳定。

  2. 网络原因造成客户端发送了Pong消息，但服务端并未接收到。

  3. 网络原因造成连接断开。

  4. 建议用户做好WebSocket连接断连重连机制，在确保心跳（Ping/Pong）消息正确回复后若连接意外断开，程序能够自动进行重新连接。

Q4：为什么签名认证总返回失败？

A：请对比使用Secret Key签名前的字符串与以下字符串的区别

对比时请注意一下几点：

1、签名参数应该按照ASCII码排序。比如下面是原始的参数：

AccessKeyId=e2xxxxxx-99xxxxxx-84xxxxxx-7xxxx

order-id=1234567890

SignatureMethod=HmacSHA256

SignatureVersion=2

Timestamp=2017-05-11T15%3A19%3A30

排序之后应该为：

AccessKeyId=e2xxxxxx-99xxxxxx-84xxxxxx-7xxxx

SignatureMethod=HmacSHA256

SignatureVersion=2

Timestamp=2017-05-11T15%3A19%3A30

order-id=1234567890

2、签名串需进行URL编码。比如：

3、签名需进行 base64 编码

4、Get请求参数需在签名串中

5、时间为UTC时间转换为YYYY-MM-DDTHH:mm:ss

6、检查本机时间与标准时间是否存在偏差（偏差应小于1分钟）

7、WebSocket发送验签认证消息时，消息体不需要URL编码

8、签名时所带Host应与请求接口时Host相同

如果您使用了代理，代理可能会改变请求Host，可以尝试去掉代理；

您使用的网络连接库可能会把端口包含在Host内，可以尝试在签名用到的Host中包含端口

9、Api Key 与 Secret Key中是否存在隐藏特殊字符，影响签名

Q5：调用接口返回gateway-internal-error错误是什么原因？

A：请检查是否属于以下情况：

  1. account-id 是否正确，需要由 GET /v1/account/accounts 接口返回的数据。

  2. 可能为网络原因，请稍后进行重试。

  3. 发送数据格式是否正确(需要标准JSON格式)。

  4. POST请求头header需要声明为Content-Type:application/json 。

Q6：调用接口返回 login-required错误是什么原因？

A：请检查是否属于以下情况：

  1. 应该将AccessKey参数带入URL中。
  2. 应该将Signature参数带入URL中。
  3. account-id 是否正确，是由 GET /v1/account/accounts 接口返回的数据。
  4. 限频发生后再次请求时可能引发该错误。

Q7: 调用Rest接口返回HTTP 405错误 method-not-allowed是什么原因？

A：该错误表明调用了不存在的Rest接口，请检查Rest接口路径是否准确。由于Nginx的设置，请求路径(Path)是大小写敏感的，请严格按照文档声明的大小写。

行情相关

Q1：当前盘口数据多久更新一次？

A：当前盘口数据数据一秒更新一次，无论是RESTful查询或是Websocket推送都是一秒一次。若需要实时的买一卖一价格数据，可使用WebSocket订阅market.$symbol.bbo主题，该主题会实时推送最新的买一卖一价格数据。

Q2：24小时行情接口(/market/detail)数据接口的成交量会出现负增长吗？

A：/market/detail接口中的成交量、成交金额为24小时滚动数据（平移窗口大小24小时），有可能会出现后一个窗口内的累计成交量、累计成交额小于前一窗口的情况。

Q3：如何获取最新成交价格？

A：推荐使用REST API GET /market/trade 接口请求最新成交，或使用WebSocket订阅market.$symbol.trade.detail主题，根据返回数据中的price获取。

Q4：K线是按照什么时间开始计算的？

A： K线周期以新加坡时间为基准开始计算，例如日K线的起始周期为新加坡时间0时-新加坡时间次日0时。

交易相关

Q1：account-id是什么？

A： account-id对应用户不同业务账户的ID，可通过/v1/account/accounts接口获取，并根据account-type区分具体账户。

账户类型包括：

Q2：client-order-id是什么？

A： client-order-id作为下单请求标识的一个参数，类型为字符串，长度为64。 此id为用户自己生成，24小时内有效。

Q3：如何获取下单数量、金额、小数限制、精度的信息？

A： 可使用 Rest API GET /v1/common/symbols 获取相关币对信息， 下单时注意最小下单数量和最小下单金额的区别。

常见返回错误如下：

Q4：WebSocket 订单更新推送主题orders.\$symbol 和 orders.$symbol.update的区别？

A： 区别如下：

  1. order.\$symbol 主题作为老的推送主题，会在一段时间后停止主题的维护和使用， 推荐使用order.$symbol.update主题。

  2. 新主题orders.$symbol.update具有严格的时序性，保证数据严格按照撮合成交顺序进行推送，且具有更快的时效性以及更低的时延。

  3. 为减少重复数据推送量以及更快的速度，在orders.$symbol.update推送中并未携带原始订单数量，价格信息，若需要此信息，建议可在下单时在本地维护订单信息，或在接收到推送消息后，使用Rest接口进行查询。

Q5： 为什么收到订单成功成交的消息后再次进行下单，返回余额不足？

A：为保证订单的及时送达以及低延时， 订单推送的结果是在撮合后直接推送，此时订单可能并未完成资产的清算。

建议使用以下方式保证资金可以正确下单：

  1. 结合资产推送主题accounts同步接收资产变更的消息，确保资金已经完成清算。

  2. 收到订单推送消息时，使用Rest接口调用账户余额，验证账户资金是否足够。

  3. 账户中保留相对充足的资金余额。

Q6: 撮合结果里的filled-fees和filled-points有什么区别？

A: 撮合成交中的成交手续费分为普通手续费以及抵扣手续费两种类型，两种类型不会同时存在。

  1. 普通手续费表示，在成交时未开启抵扣，使用原币进行手续费扣除。例如：在BTCUSDT币种对下购买BTC，filled-fees字段不为空，表示扣除了普通手续费，单位是BTC。

  2. 抵扣手续费表示，在成交时，开启了抵扣，使用抵扣资产作为手续费的抵扣。例如BTCUSDT币种对下购买BTC，抵扣资产充足时，filled-fees为空，filled-points不为空，表示扣除了抵扣资产作为手续费，扣除单位需参考fee-deduct-currency字段

Q7: 撮合结果中match-id和trade-id有什么区别？

A: match-id表示订单在撮合中的顺序号，trade-id表示成交时的序号， 一个match-id可能有多个trade-id（成交时），也可能没有trade-id(创建订单、撤销订单)

Q8: 为什么基于当前盘口买一或者卖一价格进行下单触发了下单限价错误？

A: 当前有基于最新成交价上下一定幅度的限价保护，对流动性不好的币，基于盘口数据下单可能会触发限价保护。建议基于ws推送的成交价+盘口数据信息进行下单

账户充提相关

Q1：为什么创建提币时返回api-not-support-temp-addr错误？

A：因安全考虑，API创建提币时仅支持已在提币地址列表中的地址，暂不支持使用API添加地址至提币地址列表中，需在网页端或APP端添加地址后才可在API中进行提币操作。

Q2：为什么USDT提币时返回Invaild-Address错误？

A：USDT币种为典型的一币多链币种， 创建提币订单时应填写chain参数对应地址类型。以下表格展示了链和chain参数的对应关系：

链 chain 参数
ERC20 （默认） usdterc20
OMNI usdt
TRX trc20usdt

如果chain参数为空，则默认的链为ERC20，或者也可以显示将参数赋值为usdterc20。

如果要提币到OMNI或者TRX，则chain参数应该填写usdt或者trc20usdt。chain参数可使用值请参考 GET /v2/reference/currencies 接口。

Q3：创建提币时fee字段应该怎么填？

A：请参考 GET /v2/reference/currencies接口返回值，返回信息中withdrawFeeType为提币手续费类型，根据类型选择对应字段设置提币手续费。

提币手续费类型包含：

Q4：如何查看我的提币额度？

A：请参考/v2/account/withdraw/quota接口返回值，返回信息中包含您查询币种的单次、当日、当前、总提币额度以及剩余额度的信息。

备注：若您有大额提币需求，且提币数额超出相关限额，可联系官方客服进行沟通。

基础信息

简介

基础信息Rest接口提供了市场状态、交易对信息、币种信息、币链信息、服务器时间戳等公共参考信息。

获取当前市场状态

此节点返回当前最新市场状态。
状态枚举值包括: 1 - 正常（可下单可撤单），2 - 挂起（不可下单不可撤单），3 - 仅撤单（不可下单可撤单）。
挂起原因枚举值包括: 2 - 紧急维护，3 - 计划维护。

curl "https://api.bitv.com/v2/market-status"

HTTP 请求

请求参数

此接口不接受任何参数。

Responds:

{
    "code": 200,
    "message": "success",
    "data": {
        "marketStatus": 1
    }
}

返回字段

名称 类型 是否必需 描述
code integer TRUE 状态码
message string FALSE 错误描述（如有）
data object TRUE
{ marketStatus integer TRUE 市场状态（1=normal, 2=halted, 3=cancel-only）
haltStartTime long FALSE 市场暂停开始时间（unix time in millisecond），仅对marketStatus=halted或cancel-only有效
haltEndTime long FALSE 市场暂停预计结束时间（unix time in millisecond），仅对marketStatus=halted或cancel-only有效；如在marketStatus=halted或cancel-only时未返回此字段，意味着市场暂停结束时间暂时无法预计
haltReason integer FALSE 市场暂停原因（2=emergency-maintenance, 3=scheduled-maintenance），仅对marketStatus=halted或cancel-only有效
affectedSymbols } string FALSE 市场暂停影响的交易对列表，以逗号分隔，如影响所有交易对返回"all"，仅对marketStatus=halted或cancel-only有效

获取所有交易对

此接口返回所有支持的交易对。

curl "https://api.bitv.com/v1/common/symbols"

HTTP 请求

请求参数

此接口不接受任何参数。

Responds:

{
    "status": "ok",
    "data": [
        {
            "base-currency": "btc",
            "quote-currency": "usdt",
            "price-precision": 2,
            "amount-precision": 6,
            "symbol-partition": "main",
            "symbol": "btcusdt",
            "state": "online",
            "value-precision": 8,
            "min-order-amt": 0.0001,
            "max-order-amt": 1000,
            "min-order-value": 5,
            "limit-order-min-order-amt": 0.0001,
            "limit-order-max-order-amt": 1000,
            "sell-market-min-order-amt": 0.0001,
            "sell-market-max-order-amt": 100,
            "buy-market-max-order-value": 1000000,
            "leverage-ratio": 5,
            "super-margin-leverage-ratio": 3,
            "funding-leverage-ratio": 3,
            "api-trading": "enabled"
        },
    ......
    ]
}

返回字段

字段名称 是否必须 数据类型 描述
base-currency true string 交易对中的基础币种
quote-currency true string 交易对中的报价币种
price-precision true integer 交易对报价的精度（小数点后位数）
amount-precision true integer 交易对基础币种计数精度（小数点后位数）
symbol-partition true string 交易区，可能值: [main，innovation]
symbol true string 交易对
state true string 交易对状态；可能值: [online，offline,suspend] online - 已上线；offline - 交易对已下线，不可交易；suspend -- 交易暂停；pre-online - 即将上线
value-precision true integer 交易对交易金额的精度（小数点后位数）
min-order-amt true float 交易对限价单最小下单量 ，以基础币种为单位（即将废弃）
max-order-amt true float 交易对限价单最大下单量 ，以基础币种为单位（即将废弃）
limit-order-min-order-amt true float 交易对限价单最小下单量 ，以基础币种为单位（NEW）
limit-order-max-order-amt true float 交易对限价单最大下单量 ，以基础币种为单位（NEW）
sell-market-min-order-amt true float 交易对市价卖单最小下单量，以基础币种为单位（NEW）
sell-market-max-order-amt true float 交易对市价卖单最大下单量，以基础币种为单位（NEW）
buy-market-max-order-value true float 交易对市价买单最大下单金额，以计价币种为单位（NEW）
min-order-value true float 交易对限价单和市价买单最小下单金额 ，以计价币种为单位
max-order-value false float 交易对限价单和市价买单最大下单金额 ，以折算后的USDT为单位（NEW）
api-trading true string API交易使能标记（有效值：enabled, disabled）

获取所有币种

此接口返回所有支持的币种。

curl "https://api.bitv.com/v1/common/currencys"

HTTP 请求

请求参数

此接口不接受任何参数。

Response:

  "data": [
    "usdt",
    "eth",
    "etc"
  ]

返回字段

APIv2 币链参考信息

此节点用于查询各币种及其所在区块链的静态参考信息（公共数据）

HTTP 请求

curl "https://api.bitv.com/v2/reference/currencies?currency=usdt"

请求参数

字段名称 是否必需 类型 字段描述 取值范围
currency false string 币种 btc, ltc, bch, eth, etc ...(取值参考GET /v1/common/currencys)
authorizedUser false boolean 已认证用户 true or false (如不填，缺省为true)

Response:

{
    "code":200,
    "data":[
        {
            "chains":[
                {
                    "chain":"trc20usdt",
                    "displayName":"",
                    "baseChain": "TRX",
                    "baseChainProtocol": "TRC20",
                    "isDynamic": false,
                    "depositStatus":"allowed",
                    "maxTransactFeeWithdraw":"1.00000000",
                    "maxWithdrawAmt":"280000.00000000",
                    "minDepositAmt":"100",
                    "minTransactFeeWithdraw":"0.10000000",
                    "minWithdrawAmt":"0.01",
                    "numOfConfirmations":999,
                    "numOfFastConfirmations":999,
                    "withdrawFeeType":"circulated",
                    "withdrawPrecision":5,
                    "withdrawQuotaPerDay":"280000.00000000",
                    "withdrawQuotaPerYear":"2800000.00000000",
                    "withdrawQuotaTotal":"2800000.00000000",
                    "withdrawStatus":"allowed"
                },
                {
                    "chain":"usdt",
                    "displayName":"",
                    "baseChain": "BTC",
                    "baseChainProtocol": "OMNI",
                    "isDynamic": false,
                    "depositStatus":"allowed",
                    "maxWithdrawAmt":"19000.00000000",
                    "minDepositAmt":"0.0001",
                    "minWithdrawAmt":"2",
                    "numOfConfirmations":30,
                    "numOfFastConfirmations":15,
                    "transactFeeRateWithdraw":"0.00100000",
                    "withdrawFeeType":"ratio",
                    "withdrawPrecision":7,
                    "withdrawQuotaPerDay":"90000.00000000",
                    "withdrawQuotaPerYear":"111000.00000000",
                    "withdrawQuotaTotal":"1110000.00000000",
                    "withdrawStatus":"allowed"
                },
                {
                    "chain":"usdterc20",
                    "displayName":"",
                    "baseChain": "ETH",
                    "baseChainProtocol": "ERC20",
                    "isDynamic": false,
                    "depositStatus":"allowed",
                    "maxWithdrawAmt":"18000.00000000",
                    "minDepositAmt":"100",
                    "minWithdrawAmt":"1",
                    "numOfConfirmations":999,
                    "numOfFastConfirmations":999,
                    "transactFeeWithdraw":"0.10000000",
                    "withdrawFeeType":"fixed",
                    "withdrawPrecision":6,
                    "withdrawQuotaPerDay":"180000.00000000",
                    "withdrawQuotaPerYear":"200000.00000000",
                    "withdrawQuotaTotal":"300000.00000000",
                    "withdrawStatus":"allowed"
                }
            ],
            "currency":"usdt",
            "instStatus":"normal"
        }
        ]
}

响应数据

字段名称 是否必需 数据类型 字段描述 取值范围
code true int 状态码
message false string 错误描述（如有）
data true object
{ currency true string 币种
{ chains true object
chain true string 链名称
displayName true string 链显示名称
baseChain false string 底层链名称
baseChainProtocol false string 底层链协议
isDynamic false boolean 是否动态手续费（仅对固定类型有效，withdrawFeeType=fixed） true,false
numOfConfirmations true int 安全上账所需确认次数（达到确认次数后允许提币）
numOfFastConfirmations true int 快速上账所需确认次数（达到确认次数后允许交易但不允许提币）
minDepositAmt true string 单次最小充币金额
depositStatus true string 充币状态 allowed,prohibited
minWithdrawAmt true string 单次最小提币金额
maxWithdrawAmt true string 单次最大提币金额
withdrawQuotaPerDay true string 当日提币额度（新加坡时区）
withdrawQuotaPerYear true string 当年提币额度
withdrawQuotaTotal true string 总提币额度
withdrawPrecision true int 提币精度
withdrawFeeType true string 提币手续费类型（特定币种在特定链上的提币手续费类型唯一） fixed,circulated,ratio
transactFeeWithdraw false string 单次提币手续费（仅对固定类型有效，withdrawFeeType=fixed）
minTransactFeeWithdraw false string 最小单次提币手续费（仅对区间类型和有下限的比例类型有效，withdrawFeeType=circulated or ratio）
maxTransactFeeWithdraw false string 最大单次提币手续费（仅对区间类型和有上限的比例类型有效，withdrawFeeType=circulated or ratio）
transactFeeRateWithdraw false string 单次提币手续费率（仅对比例类型有效，withdrawFeeType=ratio）
withdrawStatus} true string 提币状态 allowed,prohibited
instStatus } true string 币种状态 normal,delisted

状态码

状态码 错误信息 错误场景描述
200 success 请求成功
500 error 系统错误
2002 invalid field value in "field name" 非法字段取值

获取当前系统时间戳

此接口返回当前的系统时间戳，即从 UTC 1970年1月1日0时0分0秒0毫秒到现在的总毫秒数。

curl "https://api.bitv.com/v1/common/timestamp"

HTTP 请求

请求参数

此接口不接受任何参数。

Response:

  "data": 1494900087029

行情数据

简介

行情数据接口提供了多种K线、深度以及最新成交记录等行情数据。

以下是行情数据接口返回的错误码、错误消息以及说明。

错误码 错误消息 说明
invalid-parameter invalid symbol 无效的交易对
invalid-parameter invalid period 请求K线，period参数错误
invalid-parameter invalid depth 深度depth参数错误
invalid-parameter invalid type 深度type 参数错误
invalid-parameter invalid size size参数错误
invalid-parameter invalid size,valid range: [1, 2000] size参数错误
invalid-parameter request timeout 请求超时

K 线数据（蜡烛图）

此接口返回历史K线数据。

curl "https://api.bitv.com/market/history/kline?period=1day&size=200&symbol=btcusdt"

HTTP 请求

请求参数

参数 数据类型 是否必须 默认值 描述 取值范围
symbol string true NA 交易对 btcusdt, ethbtc等
period string true NA 返回数据时间粒度，也就是每根蜡烛的时间区间 1min, 5min, 15min, 30min, 60min, 4hour, 1day, 1mon, 1week, 1year
size integer false 150 返回 K 线数据条数 [1, 2000]

Response:

[
  {
    "id": 1499184000,
    "amount": 37593.0266,
    "count": 0,
    "open": 1935.2000,
    "close": 1879.0000,
    "low": 1856.0000,
    "high": 1940.0000,
    "vol": 71031537.97866500
  }
]

响应数据

字段名称 数据类型 描述
id long 调整为新加坡时间的时间戳，单位秒，并以此作为此K线柱的id
amount float 以基础币种计量的交易量
count integer 交易次数
open float 本阶段开盘价
close float 本阶段收盘价
low float 本阶段最低价
high float 本阶段最高价
vol float 以报价币种计量的交易量

聚合行情（Ticker）

此接口获取ticker信息同时提供最近24小时的交易聚合信息。

curl "https://api.bitv.com/market/detail/merged?symbol=ethusdt"

HTTP 请求

请求参数

参数 数据类型 是否必须 默认值 描述 取值范围
symbol string true NA 交易对 btcusdt, ethbtc...（取值参考GET /v1/common/symbols）

Response:

{
  "id":1499225271,
  "ts":1499225271000,
  "close":1885.0000,
  "open":1960.0000,
  "high":1985.0000,
  "low":1856.0000,
  "amount":81486.2926,
  "count":42122,
  "vol":157052744.85708200,
  "ask":[1885.0000,21.8804],
  "bid":[1884.0000,1.6702]
}

响应数据

字段名称 数据类型 描述
id long NA
amount float 以基础币种计量的交易量（以滚动24小时计）
count integer 交易次数（以滚动24小时计）
open float 本阶段开盘价（以滚动24小时计）
close float 本阶段最新价（以滚动24小时计）
low float 本阶段最低价（以滚动24小时计）
high float 本阶段最高价（以滚动24小时计）
vol float 以报价币种计量的交易量（以滚动24小时计）
bid object 当前的最高买价 [price, size]
ask object 当前的最低卖价 [price, size]

所有交易对的最新 Tickers

获得所有交易对的 tickers。

curl "https://api.bitv.com/market/tickers"

HTTP 请求

请求参数

此接口不接受任何参数。

Response:

[  
    {  
        "open":0.044297,      // 开盘价
        "close":0.042178,     // 收盘价
        "low":0.040110,       // 最低价
        "high":0.045255,      // 最高价
        "amount":12880.8510,  
        "count":12838,
        "vol":563.0388715740,
        "symbol":"ethbtc",
        "bid":0.007545,
        "bidSize":0.008,
        "ask":0.008088,
        "askSize":0.009
    },
    {  
        "open":0.008545,
        "close":0.008656,
        "low":0.008088,
        "high":0.009388,
        "amount":88056.1860,
        "count":16077,
        "vol":771.7975953754,
        "symbol":"ltcbtc",
        "bid":0.007545,
        "bidSize":0.008,
        "ask":0.008088,
        "askSize":0.009
    }
]

响应数据

核心响应数据为一个对象列，每个对象包含下面的字段

字段名称 数据类型 描述
amount float 以基础币种计量的交易量（以滚动24小时计）
count integer 交易笔数（以滚动24小时计）
open float 开盘价（以新加坡时间自然日计）
close float 最新价（以新加坡时间自然日计）
low float 最低价（以新加坡时间自然日计）
high float 最高价（以新加坡时间自然日计）
vol float 以报价币种计量的交易量（以滚动24小时计）
symbol string 交易对，例如btcusdt, ethbtc
bid float 买一价
bidSize float 买一量
ask float 卖一价
askSize float 卖一量

市场深度数据

此接口返回指定交易对的当前市场深度数据。

curl "https://api.bitv.com/market/depth?symbol=btcusdt&type=step2"

HTTP 请求

请求参数

参数 数据类型 必须 默认值 描述 取值范围
symbol string true NA 交易对 btcusdt, ethbtc...（取值参考GET /v1/common/symbols）
depth integer false 20 返回深度的数量 5，10，20
type string true step0 深度的价格聚合度，具体说明见下方 step0，step1，step2，step3，step4，step5

参数type的各值说明

取值 说明
step0 无聚合
step1 聚合度为报价精度*10
step2 聚合度为报价精度*100
step3 聚合度为报价精度*500
step4 聚合度为报价精度*1000

Response:

{
    "version": 31615842081,
    "ts": 1489464585407,
    "bids": [
      [7964, 0.0678], // [price, size]
      [7963, 0.9162],
      [7961, 0.1],
      [7960, 12.8898],
      [7958, 1.2],
      ...
    ],
    "asks": [
      [7979, 0.0736],
      [7980, 1.0292],
      [7981, 5.5652],
      [7986, 0.2416],
      [7990, 1.9970],
      ...
    ]
  }

响应数据

字段名称 数据类型 描述
ts integer 调整为新加坡时间的时间戳，单位毫秒
version integer 内部字段
bids object 当前的所有买单 [price, size]
asks object 当前的所有卖单 [price, size]

最近市场成交记录

此接口返回指定交易对最新的一个交易记录。

curl "https://api.bitv.com/market/trade?symbol=ethusdt"

HTTP 请求

请求参数

参数 数据类型 是否必须 默认值 描述
symbol string true NA btcusdt, ethbtc...（取值参考GET /v1/common/symbols）

Response:

{
    "id": 600848670,
    "ts": 1489464451000,
    "data": [
      {
        "id": 600848670,
        "trade-id": 102043494568,
        "price": 7962.62,
        "amount": 0.0122,
        "direction": "buy",
        "ts": 1489464451000
      }
    ]
}

响应数据

字段名称 数据类型 描述
id integer 唯一交易id（将被废弃）
trade-id integer 唯一成交ID（NEW）
amount float 以基础币种为单位的交易量
price float 以报价币种为单位的成交价格
ts integer 调整为新加坡时间的时间戳，单位毫秒
direction string 交易方向：“buy” 或 “sell”, “buy” 即买，“sell” 即卖

获得近期交易记录

此接口返回指定交易对近期的所有交易记录。

curl "https://api.bitv.com/market/history/trade?symbol=ethusdt&size=2"

HTTP 请求

请求参数

参数 数据类型 是否必须 默认值 描述
symbol string true NA btcusdt, ethbtc...（取值参考GET /v1/common/symbols）
size integer false 1 返回的交易记录数量，最大值2000

Response:

[  
   {  
      "id":31618787514,
      "ts":1544390317905,
      "data":[  
         {  
            "amount":9.000000000000000000,
            "ts":1544390317905,
            "trade-id": 102043483472,
            "id":3161878751418918529341,
            "price":94.690000000000000000,
            "direction":"sell"
         },
         {  
            "amount":73.771000000000000000,
            "ts":1544390317905,
            "trade-id": 102043483473
            "id":3161878751418918532514,
            "price":94.660000000000000000,
            "direction":"sell"
         }
      ]
   },
   {  
      "id":31618776989,
      "ts":1544390311353,
      "data":[  
         {  
            "amount":1.000000000000000000,
            "ts":1544390311353,
            "trade-id": 102043494568,
            "id":3161877698918918522622,
            "price":94.710000000000000000,
            "direction":"buy"
         }
      ]
   }
]

响应数据

参数 数据类型 描述
id integer 唯一交易id（将被废弃）
trade-id integer 唯一成交ID（NEW）
amount float 以基础币种为单位的交易量
price float 以报价币种为单位的成交价格
ts integer 调整为新加坡时间的时间戳，单位毫秒
direction string 交易方向：“buy” 或 “sell”, “buy” 即买，“sell” 即卖

最近24小时行情数据

此接口返回最近24小时的行情数据汇总。

curl "https://api.bitv.com/market/detail?symbol=ethusdt"

HTTP 请求

请求参数

参数 数据类型 是否必须 默认值 描述
symbol string true NA btcusdt, ethbtc...（取值参考GET /v1/common/symbols）

Response:

{  
   "amount":613071.438479561,
   "open":86.21,
   "close":94.35,
   "high":98.7,
   "id":31619471534,
   "count":138909,
   "low":84.63,
   "version":31619471534,
   "vol":5.6617373443873316E7
}

响应数据

字段名称 数据类型 描述
id integer 响应id
amount float 以基础币种计量的交易量（以滚动24小时计）
count integer 交易次数（以滚动24小时计）
open float 本阶段开盘价（以滚动24小时计）
close float 本阶段收盘价（以滚动24小时计）
low float 本阶段最低价（以滚动24小时计）
high float 本阶段最高价（以滚动24小时计）
vol float 以报价币种计量的交易量（以滚动24小时计）
version integer 内部数据

账户相关

简介

账户相关接口提供了账户、余额、历史等查询以及资产划转等功能。

以下是账户相关接口返回的错误码、错误消息以及说明。

错误码 错误消息 说明
500 system error 调用内部服务异常
1002 forbidden 禁止操作，如用户入参中accountId与UID不一致
2002 "invalid field value in currency" currency不符合正则规则^[a-z0-9]{2,10}$
2002 "invalid field value in transactTypes" 变动类型transactTypes不是“transfer”
2002 "invalid field value in sort" 分页请求参数不是合法的"asc或desc"
2002 "value in fromId is not found in record” 未找到fromId
2002 "invalid field value in accountId" 查询参数中accountId为空
2002 "value in startTime exceeded valid range" 入参查询时间大于当前时间，或者距离当前时间超过180天
2002 "value in endTime exceeded valid range") 查询结束时间小于开始时间，或者查询时间跨度大于10天

账户信息

API Key 权限：读取
限频值（NEW）：100次/2s

查询当前用户的所有账户 ID account-id 及其相关信息

HTTP 请求

请求参数

无

Response:

{
  "data": [
    {
      "id": 100001,
      "type": "spot",
      "subtype": "",
      "state": "working"
    }
  ]
}

响应数据

参数名称 是否必须 数据类型 描述 取值范围
id true long account-id
state true string 账户状态 working：正常, lock：账户被锁定
type true string 账户类型 spot：现货账户

账户余额

API Key 权限：读取
限频值（NEW）：100次/2s

查询指定账户的余额，支持以下账户：

spot：现货账户

HTTP 请求

请求参数

参数名称 是否必须 类型 描述 默认值 取值范围
account-id true string account-id，填在 path 中，取值参考 GET /v1/account/accounts

Response:

{
  "data": {
    "id": 100009,
    "type": "spot",
    "state": "working",
    "list": [
      {
        "currency": "usdt",
        "type": "trade",
        "balance": "5007.4362872650"
      },
      {
        "currency": "usdt",
        "type": "frozen",
        "balance": "348.1199920000"
      }
    ]
  }
}

响应数据

参数名称 是否必须 数据类型 描述 取值范围
id true long 账户 ID
state true string 账户状态 working：正常 lock：账户被锁定
type true string 账户类型 spot：现货账户
list false Array

list字段说明

参数名称 是否必须 数据类型 描述 取值范围
balance true string 余额
currency true string 币种
type true string 类型 trade: 交易余额，frozen: 冻结余额

获取账户资产估值

API Key 权限：读取

限频值（NEW）：100次/2s

按照BTC或法币计价单位，获取指定账户的总资产估值。

HTTP 请求

请求参数

参数 是否必填 数据类型 描述 默认值 取值范围
accountType true string 账户类型 NA spot：现货账户
valuationCurrency false string 资产估值法币，即资产按哪个法币为单位进行估值。 BTC 可选法币有：BTC、USD（大小写敏感）
subUid false long 子用户的 UID，若不填，则返回API key所属用户的账户资产估值 NA

Responds:

{
    "code": 200,
    "data": {
        "balance": "34.75",
        "timestamp": 1594901254363
    },
    "ok": true
}

返回字段

参数 是否必须 数据类型 说明
balance true string 按照某一个法币为单位的总资产估值
timestamp true long 数据返回时间，为 UNIX 时间戳（毫秒级）

资产划转

API Key 权限：交易

该节点为母用户和子用户进行资产划转的通用接口。

仅母用户支持的功能包括：
1、母用户币币账户与子用户币币账户间的划转；
2、不同子用户币币账户间划转；

仅子用户支持的功能包括：
1、子用户币币账户向母用户下的其他子用户币币账户划转，此权限默认关闭，需母用户授权。授权接口为 POST /v2/sub-user/transferability；
2、子用户币币账户向母用户币币账户划转；

其他划转功能将逐步上线，敬请期待。

HTTP 请求

请求参数

参数 是否必填 数据类型 说明 取值范围
from-user true long 转出用户uid 母用户uid,子用户uid
from-account-type true string 转出账户类型 spot
from-account true long 转出账户id
to-user true long 转入用户uid 母用户uid,子用户uid
to-account-type true string 转入账户类型 spot
to-account true long 转入账户id
currency true string 币种，即btc, ltc, bch, eth, etc ... 取值参考GET /v1/common/currencys
amount true string 划转金额

Response:

{
    "status": "ok",
    "data": {
        "transact-id": 220521190,
        "transact-time": 1590662591832
    }
}

响应数据

参数 是否必须 数据类型 说明 取值范围
status true string 状态 "ok" or "error"
data true list
{ transact-id true int 交易流水号
transact-time } true long 交易时间

账户流水

API Key 权限：读取
限频值（NEW）：5次/2s

该节点基于用户账户ID返回账户流水。

HTTP Request

请求参数

参数名称 是否必需 数据类型 描述 缺省值 取值范围
account-id true string 账户编号,取值参考 GET /v1/account/accounts
currency false string 币种,即btc, ltc, bch, eth, etc ...(取值参考GET /v1/common/currencys)
transact-types false string 变动类型，可多选，以逗号分隔 all trade (交易), transact-fee（交易手续费）, fee-deduction（手续费抵扣）, transfer（划转）, deposit（充币），withdraw（提币）, withdraw-fee（提币手续费）, other-types（其他）,rebate（交易返佣）
start-time false long 远点时间 unix time in millisecond. 以transact-time为key进行检索. 查询窗口最大为1小时. 窗口平移范围为最近30天. ((end-time) – 1hour) [((end-time) – 1hour), (end-time)]
end-time false long 近点时间unix time in millisecond. 以transact-time为key进行检索. 查询窗口最大为1小时. 窗口平移范围为最近30天. current-time [(current-time) – 29days,(current-time)]
sort false string 检索方向 asc asc or desc
size false int 最大条目数量 100 [1,500]
from-id false long 起始编号（仅在下页查询时有效）

Response:

{
    "status": "ok",
    "data": [
        {
            "account-id": 5260185,
            "currency": "btc",
            "transact-amt": "0.002393000000000000",
            "transact-type": "transfer",
            "record-id": 89373333576,
            "avail-balance": "0.002393000000000000",
            "acct-balance": "0.002393000000000000",
            "transact-time": 1571393524526
        },
        {
            "account-id": 5260185,
            "currency": "btc",
            "transact-amt": "-0.002393000000000000",
            "transact-type": "transfer",
            "record-id": 89373382631,
            "avail-balance": "0E-18",
            "acct-balance": "0E-18",
            "transact-time": 1571393578496
        }
    ]
}

响应数据

字段名称 数据类型 描述 取值范围
status string 状态码
data object
{ account-id long 账户编号
currency string 币种
transact-amt string 变动金额（入账为正 or 出账为负）
transact-type string 变动类型
avail-balance string 可用余额
acct-balance string 账户余额
transact-time long 交易时间（数据库记录时间）
record-id } long 数据库记录编号（全局唯一）
next-id long 下页起始编号（仅在查询结果需要分页返回时包含此字段）

财务流水

API Key 权限：读取

该节点基于用户账户ID返回财务流水。
一期上线暂时仅支持划转流水的查询（“transactType” = “transfer”）。
通过“startTime”/“endTime”框定的查询窗口最大为10天，意即，通过单次查询可检索的范围最大为10天。
该查询窗口可在最近180天范围内平移，意即，通过多次平移窗口查询，最多可检索到过往180天的记录。

HTTP Request

请求参数

参数名称 数据类型 是否必需 描述
accountId string TRUE 账户编号
currency string FALSE 币种 （缺省值所有币种）
transactTypes string FALSE 变动类型，可多填 （缺省值all） 枚举值： transfer
startTime long FALSE 远点时间（取值范围及缺省值见注1）
endTime long FALSE 近点时间（取值范围及缺省值见注2）
sort string FALSE 检索方向（asc 由远及近, desc 由近及远，缺省值desc）
limit int FALSE 单页最大返回条目数量 [1,500] （缺省值100）
fromId long FALSE 起始编号（仅在下页查询时有效，见注3）

注1：
startTime取值范围：[(endTime - 10天), endTime], unix time in millisecond
startTime缺省值：(endTime - 10天)

注2：
endTime取值范围：[(当前时间 - 180天), 当前时间], unix time in millisecond
endTime缺省值：当前时间

Response:

{
"code": 200,
"message": "success",
"data": [
    {
        "accountId": 5260185,
        "currency": "btc",
        "transactAmt": 1.000000000000000000,
        "transactType": "transfer",
        "transferType": "margin-transfer-out",
        "transactId": 0,
        "transactTime": 1585573286913,
        "transferer": 5463409,
        "transferee": 5260185
    },
    {
        "accountId": 5260185,
        "currency": "btc",
        "transactAmt": -1.000000000000000000,
        "transactType": "transfer",
        "transferType": "margin-transfer-in",
        "transactId": 0,
        "transactTime": 1585573281160,
        "transferer": 5260185,
        "transferee": 5463409
    }
]
}

响应数据

字段名称 数据类型 是否必需 描述 取值范围
code integer TRUE 状态码
message string FALSE 错误描述（如有）
data object TRUE 按用户请求参数sort中定义的顺序排列
{ accountId integer TRUE 账户编号
currency string TRUE 币种
transactAmt number TRUE 变动金额（入账为正 or 出账为负）
transactType string TRUE 变动类型 transfer（划转）
transferType string FALSE 划转类型（仅对transactType=transfer有效） master-transfer-in（转入到母用户）, master-transfer-out（从母用户转出）, sub-transfer-in（转入到子用户）, sub-transfer-out（从子用户转出）
transactId integer TRUE 交易流水号
transactTime integer TRUE 交易时间
transferer integer FALSE 付款方账户ID
transferee } integer FALSE 收款方账户ID
nextId integer FALSE 下页起始编号（仅在查询结果需要分页返回时包含此字段，见注3。）

注3：
仅当用户请求查询的时间范围内的数据条目超出单页限制（由“limit“字段设定）时，服务器才返回”nextId“字段。用户收到服务器返回的”nextId“后 –
1） 须知晓后续仍有数据未能在本页返回；
2） 如需继续查询下页数据，应再次请求查询并将服务器返回的“nextId”作为“fromId“，其它请求参数不变。
3） 作为数据库记录ID，“nextId”和“fromId”除了用来翻页查询外，无其它业务含义。

钱包（充提相关）

简介

充提相关接口提供了充币地址、提币地址、提币额度、充提记录等查询，以及提币、取消提币等功能。

以下是充提相关接口返回的返回码、返回消息以及说明。

返回码 返回消息 说明
200 success 请求成功
500 error 系统错误
1002 unauthorized 未授权
1003 invalid signature 验签失败
2002 invalid field value in "field name" 非法字段取值
2003 missing mandatory field "field name" 强制字段缺失

充币地址查询

此节点用于查询特定币种（IOTA除外）在其所在区块链中的充币地址，母子用户均可用

API Key 权限：读取
限频值（NEW）：20次/2s

curl "https://api.bitv.com/v2/account/deposit/address?currency=btc"

HTTP 请求

请求参数

字段名称 是否必需 类型 字段描述 取值范围
currency true string 币种 btc, ltc, bch, eth, etc ...(取值参考GET /v1/common/currencys)

Response:

{
    "code": 200,
    "data": [
        {
            "currency": "btc",
            "address": "1PSRjPg53cX7hMRYAXGJnL8mqHtzmQgPUs",
            "addressTag": "",
            "chain": "btc"
        }
    ]
}

响应数据

字段名称 是否必需 数据类型 字段描述 取值范围
code true int 状态码
message false string 错误描述（如有）
data true object
{currency true string 币种
address true string 充币地址
addressTag true string 充币地址标签
chain } true string 链名称

状态码

状态码 错误信息 错误场景描述
200 success 请求成功
500 error 系统错误
1002 unauthorized 未授权
1003 invalid signature 验签失败
2002 invalid field value in "field name" 非法字段取值
2003 missing mandatory field "field name" 强制字段缺失

提币额度查询

此节点用于查询各币种提币额度，限母用户可用

API Key 权限：读取
限频值（NEW）：20次/2s

curl "https://api.bitv.com/v2/account/withdraw/quota?currency=btc"

HTTP 请求

请求参数

字段名称 是否必需 类型 字段描述 取值范围
currency true string 币种 btc, ltc, bch, eth, etc ...(取值参考GET /v1/common/currencys)

Response:

{
    "code": 200,
    "data": 
        {
            "currency": "btc",
            "chains": [
                {
                    "chain": "btc",
                    "maxWithdrawAmt": "200.00000000",
                    "withdrawQuotaPerDay": "200.00000000",
                    "remainWithdrawQuotaPerDay": "200.000000000000000000",
                    "withdrawQuotaPerYear": "700000.00000000",
                    "remainWithdrawQuotaPerYear": "700000.000000000000000000",
                    "withdrawQuotaTotal": "7000000.00000000",
                    "remainWithdrawQuotaTotal": "7000000.000000000000000000"
                }
        }
    ]
}

响应数据

字段名称 是否必需 数据类型 字段描述 取值范围
code true int 状态码
message false string 错误描述（如有）
data true object
currency true string 币种
chains true object
{ chain true string 链名称
maxWithdrawAmt true string 单次最大提币金额
withdrawQuotaPerDay true string 当日提币额度
remainWithdrawQuotaPerDay true string 当日提币剩余额度
withdrawQuotaPerYear true string 当年提币额度
remainWithdrawQuotaPerYear true string 当年提币剩余额度
withdrawQuotaTotal true string 总提币额度
remainWithdrawQuotaTotal } true string 总提币剩余额度

状态码

状态码 错误信息 错误场景描述
200 success 请求成功
500 error 系统错误
1002 unauthorized 未授权
1003 invalid signature 验签失败
2002 invalid field value in "field name" 非法字段取值

提币地址查询

API Key 权限：读取

该节点用于查询API key可用的提币地址，限母用户可用。

HTTP 请求

请求参数

参数名称 是否必须 类型 描述 默认值 取值范围
currency true string 币种 btc, ltc, bch, eth, etc ...(取值参考GET /v1/common/currencys)
chain false string 链名称 如不填，返回所有链的提币地址
note false string 地址备注 如不填，返回所有备注的提币地址
limit false int 单页最大返回条目数量 100 [1,500]
fromId false long 起始编号（提币地址ID，仅在下页查询时有效，详细见备注） NA

Response:

{
    "code": 200,
    "data": [
        {
            "currency": "usdt",
            "chain": "usdt",
            "note": "币安",
            "addressTag": "",
            "address": "15PrEcqTJRn4haLeby3gJJebtyf4KgWmSd"
        }
    ]
}

响应数据

参数名称 是否必须 数据类型 描述 取值范围
code true int 状态码
message false string 错误描述（如有）
data true object
{ currency true string 币种
chain true string 链名称
note true string 地址备注
addressTag false string 地址标签，如有
address } true string 地址
nextId false long 下页起始编号（提币地址ID，仅在查询结果需要分页返回时，包含此字段，详细见备注）

备注：
仅当用户请求查询的数据条目超出单页限制（由“limit“字段设定）时，服务器才返回”nextId“字段。用户收到服务器返回的”nextId“后 –
1）须知晓后续仍有数据未能在本页返回；
2）如需继续查询下页数据，应再次请求查询并将服务器返回的“nextId”作为“fromId“，其它请求参数不变。
3）作为数据库记录ID，“nextId”和“fromId”除了用来翻页查询外，无其它业务含义。

虚拟币提币

此节点用于将现货账户的数字币提取到区块链地址（已存在于提币地址列表）而不需要多重（短信、邮件）验证，限母用户可用

API Key 权限：提币
限频值（NEW）：20次/2s

HTTP 请求

Request:

{
  "address": "0xde709f2102306220921060314715629080e2fb77",
  "amount": "0.05",
  "currency": "eth",
  "fee": "0.01"
}

请求参数

参数名称 是否必须 类型 描述 取值范围
address true string 提币地址 仅支持在官网上相应币种地址列表中的地址
amount true string 提币数量
currency true string 资产类型 btc, ltc, bch, eth, etc ...(取值参考GET /v1/common/currencys)
fee true string 转账手续费
chain false string 取值参考GET /v2/reference/currencies,例如提USDT至OMNI时须设置此参数为"usdt"，提USDT至TRX时须设置此参数为"trc20usdt"，其他币种提币无须设置此参数
addr-tag false string 虚拟币共享地址tag，适用于xrp，xem，bts，steem，eos，xmr 格式, "123"类的整数字符串

Response:

{
  "data": 700
}

响应数据

参数名称 是否必须 数据类型 描述 取值范围
data false long 提币 ID

取消提币

此节点用于取消已提交的提币请求，限母用户可用

API Key 权限：提币
限频值（NEW）：20次/2s

HTTP 请求

请求参数

参数名称 是否必须 类型 描述 默认值 取值范围
withdraw-id true long 提币 ID，填在 path 中

Response:

{
  "data": 700
}

响应数据

参数名称 是否必须 数据类型 描述 取值范围
data false long 提币 ID

充提记录

此节点用于查询充提记录，母子用户均可用

API Key 权限：读取
限频值（NEW）：20次/2s

HTTP 请求

请求参数

参数名称 是否必须 类型 描述 默认值 取值范围
currency false string 币种 btc, ltc, bch, eth, etc ...(取值参考GET /v1/common/currencys)
type true string 充值或提币 deposit 或 withdraw,子用户仅可用deposit
from false string 查询起始 ID 缺省时，默认值direct相关。当direct为‘prev’时，from 为1 ，从旧到新升序返回；当direct为’next‘时，from为最新的一条记录的ID，从新到旧降序返回
size false string 查询记录大小 100 1-500
direct false string 返回记录排序方向 缺省时，默认为“prev” （升序） “prev” （升序）or “next” （降序）

Response:

{
  "data":
    [
      {
        "id": 1171,
        "type": "deposit",
        "currency": "xrp",
        "tx-hash": "ed03094b84eafbe4bc16e7ef766ee959885ee5bcb265872baaa9c64e1cf86c2b",
        "amount": 7.457467,
        "address": "rae93V8d2mdoUQHwBDBdM4NHCMehRJAsbm",
        "address-tag": "100040",
        "fee": 0,
        "state": "safe",
        "created-at": 1510912472199,
        "updated-at": 1511145876575
      },
      ...
    ]
}

响应数据

参数名称 是否必须 数据类型 描述 取值范围
id true long 充币订单id
type true string 类型 'deposit', 'withdraw', 子用户仅有deposit
currency true string 币种
tx-hash true string 交易哈希
chain true string 链名称
amount true float 个数
address true string 目的地址
address-tag true string 地址标签
fee true float 手续费
state true string 状态 状态参见下表
error-code false string 提币失败错误码，仅type为”withdraw“，且state为”reject“、”wallet-reject“和”failed“时有。
error-msg false string 提币失败错误描述，仅type为”withdraw“，且state为”reject“、”wallet-reject“和”failed“时有。
created-at true long 发起时间
updated-at true long 最后更新时间
状态 描述
unknown 状态未知
confirming 确认中
confirmed 已确认
safe 已完成
orphan 待确认
状态 描述
verifying 待验证
failed 验证失败
submitted 已提交
reexamine 审核中
canceled 已撤销
pass 审批通过
reject 审批拒绝
pre-transfer 处理中
wallet-transfer 已汇出
wallet-reject 钱包拒绝
confirmed 区块已确认
confirm-error 区块确认错误
repealed 已撤销

子用户管理

简介

子用户管理接口了子用户的创建、查询、权限设置、转账，子用户API Key的创建、修改、查询、删除，子用户充提地址、余额的查询等功能。

以下是子用户相关接口返回的返回码、返回消息以及说明。

错误码 返回消息 说明
1002 "forbidden" 禁止操作，如该账户不允许创建子用户
1003 "unauthorized” 未认证
2002 invalid field value 参数错误
2014 number of sub account in the request exceeded valid range 子账户数量达到限制
2014 number of api key in the request exceeded valid range API Key数量超过限制
2016 invalid request while value specified in sub user states 冻结/解冻失败

子用户创建

此接口用于母用户进行子用户创建，单次最多50个

API Key 权限：交易

HTTP 请求

Request:

{
"userList":
  [
    {
      "userName":"test123",
      "note":"123"
    },
    {
      "userName":"test456",
      "note":"123"
    }
  ]
}

请求参数

参数名称 是否必须 类型 描述 默认值 取值范围
userList true object
[{ userName true string 子用户名，子用户身份的重要标识，要求平台内唯一 NA 6至20位字母和数字的组合，可为纯字母；若字母和数字的组合，需以字母开头；字母不区分大小写；
note }] false string 子用户备注，无唯一性要求 NA 最多20位字符，字符类型不限

Response:

{
    "code": 200,
    "data": [
        {
    "userName": "test123",
    "note": "123",
    "uid": 123
      },
        {
    "userName": "test456",
    "note": "123",
    "errCode": "2002",
    "errMessage": "value in user name duplicated with existing record"
      }
    ]
}

响应数据

参数名称 是否必须 数据类型 描述 取值范围
code true int 状态码
message false string 错误描述（如有）
data true object
[{ userName true string 子用户名
note false string 子用户备注（仅对有备注的子用户有效）
uid false long 子用户UID（仅对创建成功的子用户有效）
errCode false string 创建失败错误码（仅对创建失败的子用户有效）
errMessage }] false string 创建失败错误原因（仅对创建失败的子用户有效）

获取子用户列表

母用户通过此接口可获取所有子用户的UID列表及各用户状态

API Key 权限：读取

HTTP 请求

请求参数

参数名称 是否必须 类型 描述 默认值 取值范围
fromId FALSE long 查询起始编号（仅对翻页查询有效）

Response:

{
    "code": 200,
    "data": [
        {
            "uid": 63628520,
            "userState": "normal"
        },
        {
            "uid": 132208121,
            "userState": "normal"
        }
    ]
}

响应数据

参数名称 是否必须 数据类型 描述 取值范围
code TRUE int 状态码
message FALSE string 错误描述（如有）
data TRUE object
{ uid TRUE long 子用户UID
userState } TRUE string 子用户状态 lock, normal
nextId FALSE long 下页查询起始编号（仅在存在下页数据时返回）

冻结/解冻子用户

API Key 权限：交易
限频值（NEW）：20次/2s

此接口用于母用户对其下一个子用户进行冻结和解冻操作

HTTP 请求

请求参数

参数 是否必填 数据类型 长度 说明 取值范围
subUid true long - 子用户的UID -
action true string - 操作类型 lock(冻结)，unlock(解冻)

Response:

{
  "code": 200,
    "data": {
     "subUid": 12902150,
     "userState":"lock"}
}

响应数据

参数 是否必填 数据类型 长度 说明 取值范围
subUid true long - 子用户UID -
userState true string - 子用户状态 lock(已冻结)，normal(正常)

获取特定子用户的用户状态

母用户通过此接口可获取特定子用户的用户状态

API Key 权限：读取

HTTP 请求

请求参数

参数名称 是否必须 类型 描述 默认值 取值范围
subUid TRUE long 子用户UID

Response:

{
    "code": 200,
    "data": {
        "uid": 132208121,
        "userState": "normal"
    }
}

响应数据

参数名称 是否必须 数据类型 描述 取值范围
code TRUE int 状态码
message FALSE string 错误描述（如有）
data TRUE object
{ uid TRUE long 子用户UID
userState } TRUE string 子用户状态 lock, normal

设置子用户交易权限

API Key 权限：交易

此接口用于母用户批量设置子用户的交易权限。 子用户的现货交易权限默认开通无须设置。

HTTP 请求

请求参数

参数 是否必填 数据类型 长度 说明 取值范围
subUids true string - 子用户UID列表（支持多填，最多50个，逗号分隔） -
accountType true string - 账户类型 isolated-margin,cross-margin
activation true string - 账户激活状态 activated,deactivated

Response:

{
    "code": 200,
    "data": [
        {
            "subUid": "132208121",
            "accountType": "isolated-margin",
            "activation": "activated"
        }
    ]
}

响应数据

参数 是否必填 数据类型 长度 说明 取值范围
code true int - 状态码
message false string - 错误描述（如有）
data true object
{subUid true string - 子用户UID -
accountType true string - 账户类型 isolated-margin,cross-margin
activation true string - 账户激活状态 activated,deactivated
errCode false int - 请求被拒错误码（仅在设置该subUid市场准入权限错误时返回）
errMessage} false string - 请求被拒错误消息（仅在设置该subUid市场准入权限错误时返回）

设置子用户资产转出权限

API Key 权限：交易

此接口用于母用户批量设置子用户的资产转出权限。 子用户的资金转出权限包括：

HTTP 请求

请求参数

参数 是否必填 数据类型 长度 说明 取值范围
subUids true string - 子用户UID列表（支持多填，最多50个，逗号分隔） -
accountType false string - 账户类型（如不填，缺省值spot） spot
transferrable true bool - 可划转权限 true,false

Response:

{
    "code": 200,
    "data": [
        {
            "accountType": "spot",
            "transferrable": true,
            "subUid": 13220823
        }
    ]
}

响应数据

参数 是否必填 数据类型 长度 说明 取值范围
code true int - 状态码
message false string - 错误描述（如有）
data true object
{subUid true long - 子用户UID -
accountType true string - 账户类型 spot
transferrable true bool - 可划转权限 true,false
errCode false int - 请求被拒错误码（仅在设置该subUid市场准入权限错误时返回）
errMessage} false string - 请求被拒错误消息（仅在设置该subUid市场准入权限错误时返回）

获取特定子用户的账户列表

母用户通过此接口可获取特定子用户的Account ID列表及各账户状态

API Key 权限：读取

HTTP 请求

请求参数

参数名称 是否必须 类型 描述 默认值 取值范围
subUid TRUE long 子用户UID

Response:

{
    "code": 200,
    "data": {
        "uid": 132208121,
        "list": [
            {
                "accountType": "isolated-margin",
                "activation": "activated"
            },
            {
                "accountType": "cross-margin",
                "activation": "deactivated"
            },
            {
                "accountType": "spot",
                "activation": "activated",
                "transferrable": true,
                "accountIds": [
                    {
                        "accountId": 12255180,
                        "accountStatus": "normal"
                    }
                ]
            }
        ]
    }
}

响应数据

参数名称 是否必须 数据类型 描述 取值范围
code TRUE int 状态码
message FALSE string 错误描述（如有）
data TRUE object
{ uid TRUE long 子用户UID
list TRUE object
{ accountType TRUE string 账户类型 spot, futures,swap
activation TRUE string 账户激活状态 activated, deactivated
transferrable FALSE bool 可划转权限（仅对accountType=spot有效） true, false
accountIds FALSE object
{ accountId TRUE string 账户ID
subType FALSE string 账户子类型（仅对accountType=isolated-margin有效）
accountStatus }}} TRUE string 账户状态 normal, locked

子用户API key创建

此接口用于母用户创建子用户的API key

API Key 权限：交易

HTTP 请求

请求参数

参数名称 是否必须 类型 描述 默认值 取值范围
otpToken true string 母用户的谷歌验证码，母用户须在官网页面启用GA二次验证 NA 6个字符，纯数字
subUid true long 子用户UID NA
note ture string API key备注 NA 最多255位字符，字符类型不限
permission true string API key权限 NA 取值范围：readOnly、trade，其中readOnly必传，trade选传，两个间用半角逗号分隔。
ipAddresses false string API key绑定的IPv4/IPv6主机地址或IPv4网络地址 NA 最多绑定20个，多个IP地址用半角逗号分隔，如：192.168.1.1,202.106.96.0/24。如果未绑定任何IP地址，API key有效期仅为90天。

Response:

{
    "code": 200,
    "data": {
        "accessKey": "2b55df29-vf25treb80-1535713d-8aea2",
        "secretKey": "c405c550-6fa0583b-fb4bc38e-d317e",
        "note": "62924133",
        "permission": "trade,readOnly",
        "ipAddresses": "1.1.1.1,1.1.1.2"
    }
}

响应数据

参数名称 是否必须 数据类型 描述 取值范围
code true int 状态码
message false string 错误描述（如有）
data true object
{ note true string API key备注
accessKey true string access key
secretKey true string secret key
permission true string API key权限
ipAddresses } false string API key绑定的IP地址

母子用户API key信息查询

此接口用于母用户查询自身的API key信息，以及母用户查询子用户的API key信息

API Key 权限：读取

HTTP 请求

请求参数

参数名称 是否必须 类型 描述 默认值 取值范围
uid true long 母用户UID，子用户UID NA
accessKey false string API key的access key，若缺省，则返回UID对应用户的所有API key NA

Response:

{
    "code": 200,
    "message": "success",
    "data": [
        {
            "accessKey": "4ba5cdf2-4a92c5da-718ba144-dbuqg6hkte",
            "status": "normal",
            "note": "62924133",
            "permission": "readOnly,trade",
            "ipAddresses": "1.1.1.1,1.1.1.2",
            "validDays": -1,
            "createTime": 1591348751000,
            "updateTime": 1591348751000
        }
    ]
}

响应数据

参数名称 是否必须 数据类型 描述 取值范围
code true int 状态码
message false string 错误描述（如有）
data true object
[{ accessKey true string access key
note true string API key备注
permission true string API key权限
ipAddresses false string API key绑定的IP地址
validDays true int API key剩余有效天数 若为-1，则表示永久有效
status true string API key当前状态 normal(正常)，expired(已过期)
createTime true long API key创建时间
updateTime }] true long API key最近一次修改时间

修改子用户API key

此接口用于母用户修改子用户的API key

API Key 权限：交易

HTTP 请求

请求参数

参数名称 是否必须 类型 描述 默认值 取值范围
subUid true long 子用户的uid NA
accessKey true string 子用户API key的access key NA
note false string API key备注 NA 最多255位字符
permission false string API key权限 NA 取值范围：readOnly、trade，其中readOnly必传，trade选传，两个间用半角逗号分隔。
ipAddresses false string API key绑定的IP地址 NA IPv4/IPv6主机地址或IPv4网络地址，最多绑定20个，多个IP地址用半角逗号分隔，如：192.168.1.1,202.106.96.0/24。如果未绑定任何IP地址，API key有效期仅为90天。

Response:

{
    "code": 200,
    "data": {
        "note": "test",
        "permission": "readOnly",
        "ipAddresses": "1.1.1.3"
    }
}

响应数据

参数名称 是否必须 数据类型 描述 取值范围
code true int 状态码
message false string 错误描述（如有）
data true object
{ note false string API key备注
permission false string API key权限
ipAddresses } false string API key绑定的IP地址

删除子用户API key

此接口用于母用户删除子用户的API key

API Key 权限：交易

HTTP 请求

请求参数

参数名称 是否必须 类型 描述 默认值 取值范围
subUid true long 子用户的uid NA
accessKey true string 子用户API key的access key NA

Response:

{
    "code": 200,
    "data": null
}

响应数据

参数名称 是否必须 数据类型 描述 取值范围
code true int 状态码
message false string 错误描述（如有）

资产划转（母子用户之间）

API Key 权限：交易
限频值（NEW）：2次/2s

母用户执行母子用户之间的划转

HTTP 请求

请求参数

参数 是否必填 数据类型 说明 取值范围
sub-uid true long 子用户uid -
currency true string 币种，即btc, ltc, bch, eth, etc ...(取值参考GET /v1/common/currencys) -
amount true decimal 划转金额 -
type true string 划转类型 master-transfer-in（子用户划转给母用户虚拟币）/ master-transfer-out （母用户划转给子用户虚拟币）

Response:

{
  "data":123456,
  "status":"ok"
}

响应数据

参数 是否必填 数据类型 长度 说明 取值范围
data true int - 划转订单id -
status true - 状态 "OK" or "Error"

错误码

error_code 说明 类型
account-transfer-balance-insufficient-error 账户余额不足 string
base-operation-forbidden 禁止操作（母子用户关系错误时报） string

子用户充币地址查询

此节点用于母用户查询子用户特定币种（IOTA除外）在其所在区块链中的充币地址，限母用户可用

API Key 权限：读取

HTTP 请求

请求参数

字段名称 是否必需 类型 描述 默认值 取值范围
subUid true long 子用户UID NA 限填1个
currency true string 币种 NA btc, ltc, bch, eth, etc ...(取值参考GET /v1/common/currencys)

Response:

{
    "code": 200,
    "data": [
        {
            "currency": "btc",
            "address": "1PSRjPg53cX7hMRYAXGJnL8mqHtzmQgPUs",
            "addressTag": "",
            "chain": "btc"
        }
    ]
}

响应数据

字段名称 是否必需 数据类型 字段描述 取值范围
code true int 状态码
message false string 错误描述（如有）
data true object
{ currency true string 币种
address true string 充币地址
addressTag true string 充币地址标签
chain } true string 链名称

子用户充币记录查询

此节点用于母用户查询子用户充值记录，限母用户可用

API Key 权限：读取

HTTP 请求

请求参数

参数名称 数据类型 是否必需 描述
subUid long TRUE 子用户UID，限填1个
currency string FALSE 币种，缺省值所有币种
startTime long FALSE 远点时间，以createTime进行检索，取值范围及缺省值见注1
endTime long FALSE 近点时间，以createTime进行检索，取值范围及缺省值见注2
sort string FALSE 检索方向，asc 由远及近, desc 由近及远，缺省值desc
limit int FALSE 单页最大返回条目数量 [1,500] （缺省值100）
fromId long FALSE 起始充币订单ID，仅在下页查询时有效见注3

注1：
startTime取值范围：[(endTime - 30天), endTime]
startTime缺省值：(endTime - 30天)

注2：
endTime取值范围：不限
endTime缺省值：当前时间

注3：
仅当用户请求查询的时间范围内的数据条目超出单页限制（由“limit“字段设定）时，服务器才返回”nextId“字段。用户收到服务器返回的”nextId“后 –
1）须知晓后续仍有数据未能在本页返回；
2）如需继续查询下页数据，应再次请求查询并将服务器返回的“nextId”作为“fromId“，其它请求参数不变。
3）作为数据库记录ID，“nextId”和“fromId”除了用来翻页查询外，无其它业务含义。

Response:

{
    "code": 200,
    "data": [
        {
            "id": 33419472,
            "currency": "ltc",
            "chain": "ltc",
            "amount": 0.001000000000000000,
            "address": "LUuuPs5C5Ph3cZz76ZLN1AMLSstqG5PbAz",
            "state": "safe",
            "txHash": "847601d249861da56022323514870ddb96456ec9579526233d53e690264605a7",
            "addressTag": "",
            "createTime": 1587033225787,
            "updateTime": 1587033716616
        }
    ]
}

响应数据

参数名称 是否必须 数据类型 描述 取值范围
code true int 状态码
message false string 错误描述（如有）
data true object
{ id true long 充币订单id
currency true string 币种
txHash true string 交易哈希
chain true string 链名称
amount true bigdecimal 个数
address true string 地址
addressTag true string 地址标签
state true string 状态 状态参见下表
createTime true long 发起时间
updateTime } true long 最后更新时间
nextId false long 下页起始编号（充币订单ID，仅在查询结果需要分页返回时，包含此字段）
状态 描述
unknown 状态未知
confirming 确认中
confirmed 已确认
safe 已完成
orphan 待确认

子用户余额（汇总）

API Key 权限：读取
限频值（NEW）：2次/2s

母用户查询其下所有子用户的各币种汇总余额

HTTP 请求

请求参数

无

Response:

{
  "status": "ok",
  "data": [
      {
        "currency": "eos",
        "type": "spot",
        "balance": "1954559.809500000000000000"
      },
      {
        "currency": "btc",
        "type": "spot",
        "balance": "0.000000000000000000"
      },
      {
        "currency": "usdt",
        "type": "spot",
        "balance": "2925209.411300000000000000"
      },
      ...
   ]
}

响应数据

参数 是否必填 数据类型 长度 说明 取值范围
status true - 状态 "OK" or "Error"
data true list - -
参数 是否必填 数据类型 长度 说明 取值范围
currency 是 string - 币种 -
type 是 string - 账户类型 spot: 现货账户
balance 是 string - 账户余额（可用余额和冻结余额的总和） -

子用户余额

API Key 权限：读取
限频值（NEW）：20次/2s

母用户查询子用户各币种账户余额

HTTP 请求

请求参数

参数 是否必填 数据类型 长度 说明 取值范围
sub-uid true long - 子用户的 UID -

Response:

{
  "status": "ok",
    "data": [
    {
      "id": 9910049,
      "type": "spot",
      "list": 
      [
        {
          "currency": "btc",
          "type": "trade",
          "balance": "1.00"
        },
        {
          "currency": "eth",
          "type": "trade",
          "balance": "1934.00"
        }
      ]
    },
    {
      "id": 9910050,
      "type": "point",
      "list": []
    }
    ]
}

响应数据

参数 是否必填 数据类型 长度 说明 取值范围
id - long - 子用户 UID -
type - string - 账户类型 spot：现货账户
list - object - - -
参数 是否必填 数据类型 长度 说明 取值范围
currency 是 string - 币种 -
type 是 string - 账户类型 trade: 交易账户, frozen: 冻结账户
balance 是 decimal - 账户余额 -

现货交易

简介

现货交易接口提供了下单、撤单、订单查询、成交查询、手续费率查询等功能。

以下是交易相关接口返回的返回码以及说明。

返回码 说明
base-argument-unsupported 某参数不支持，请检查参数
base-system-error 系统错误，如果是撤单：缓存中查不到订单状态，该订单无法撤单；如果是下单：订单入缓存失败，请再次尝试
login-required url中没有Signature参数或找不到此用户（key与账户id不对应等情况）
parameter-required 止盈止损订单缺少参数 stop-price或operator
base-record-invalid 暂时未找到数据，请稍后重试
order-amount-over-limit 订单数量超出限额
base-symbol-trade-disabled 该交易对被禁止交易
base-operation-forbidden 用户不在白名单内或该币种不允许OTC交易等禁止行为
account-get-accounts-inexistent-error 该账户在该用户下不存在
account-account-id-inexistent 该账户不存在
order-disabled 交易对暂停，无法下单
cancel-disabled 交易对暂停，无法撤单
order-invalid-price 下单价格非法（如市价单不能有价格，或限价单价格超过市场价10%）
order-accountbalance-error 账户余额不足
order-limitorder-price-min-error 卖出价格不能低于指定价格
order-limitorder-price-max-error 买入价格不能高于指定价格
order-limitorder-amount-min-error 下单数量不能低于指定数量
order-limitorder-amount-max-error 下单数量不能高于指定数量
order-etp-nav-price-min-error 下单价格不能低于净值的指定比率
order-etp-nav-price-max-error 下单价格不能高于净值等指定比率
order-orderprice-precision-error 交易价格精度错误
order-orderamount-precision-error 交易数额精度错误
order-value-min-error 订单交易额不能低于指定额度
order-marketorder-amount-min-error 卖出数量不能低于指定数量
order-marketorder-amount-buy-max-error 市价单买入额度不能高于指定额度
order-marketorder-amount-sell-max-error 市价单卖出数量不能高于指定数量
order-holding-limit-failed 下单超出该币种的持仓限额
order-type-invalid 订单类型非法
order-orderstate-error 订单状态错误
order-date-limit-error 查询时间不能超过系统限制
order-source-invalid 订单来源非法
order-update-error 更新数据错误
order-user-cancel-forbidden 订单类型为IOC 不允许撤单
order-price-greater-than-limit 下单价格高于开盘前下单限制价格，请重新下单
order-price-less-than-limit 下单价格低于开盘前下单限制价格，请重新下单
order-stop-order-hit-trigger 止盈止损单下单被当前价触发
market-orders-not-support-during-limit-price-trading 限时下单不支持市价单
price-exceeds-the-protective-price-during-limit-price-trading 限价时间内价格超出保护价
invalid-client-order-id client order id 已重复
invalid-interval 查询起止窗口设置错误
invalid-start-date 查询起始日期含非法取值
invalid-end-date 查询起始日期含非法取值
invalid-start-time 查询起始时间含非法取值
invalid-end-time 查询起始时间含非法取值
validation-constraints-required 指定的必填参数缺失
not-found 撤单时订单不存在
base-not-found 撤单时无效clientorderid撤单过多，一个小时后再重试

下单

API Key 权限：交易 限频值；100次/2s

发送一个新订单以进行撮合。

HTTP 请求

Request:

{
  "account-id": "100009",
  "amount": "10.1",
  "price": "100.1",
  "source": "api",
  "symbol": "ethusdt",
  "type": "buy-limit",
  "client-order-id": "a0001"
}

请求参数

参数名称 数据类型 是否必需 默认值 描述
account-id string true NA 账户 ID，取值参考 GET /v1/account/accounts。现货交易使用 ‘spot’ 账户的 account-id
symbol string true NA 交易对,即btcusdt, ethbtc...（取值参考GET /v1/common/symbols）
type string true NA 订单类型，包括buy-market, sell-market, buy-limit, sell-limit, buy-ioc, sell-ioc, buy-limit-maker, sell-limit-maker（说明见下文）, buy-stop-limit, sell-stop-limit
amount string true NA 订单交易量（市价买单为订单交易额）
price string false NA 订单价格（对市价单无效）
source string false spot-api 现货交易填写“spot-api”
client-order-id string false NA 用户自编订单号（最大长度64个字符，须在24小时内保持唯一性）
stop-price string false NA 止盈止损订单触发价格
operator string false NA 止盈止损订单触发价运算符 gte – greater than and equal (>=), lte – less than and equal (<=)

buy-limit-maker

当“下单价格”>=“市场最低卖出价”，订单提交后，系统将拒绝接受此订单；

当“下单价格”<“市场最低卖出价”，提交成功后，此订单将被系统接受。

sell-limit-maker

当“下单价格”<=“市场最高买入价”，订单提交后，系统将拒绝接受此订单；

当“下单价格”>“市场最高买入价”，提交成功后，此订单将被系统接受。

Response:

{  
  "data": "59378"
}

响应数据

返回的主数据对象是一个对应下单单号的字符串。

如client order ID（在24小时内）被复用，节点将返回错误消息invalid.client.order.id。

批量下单

API Key 权限：交易
限频值（NEW）：50次/2s

一个批量最多10张订单

HTTP 请求

Request:

[
    {
    "account-id": "123456",
    "price": "7801",
    "amount": "0.001",
    "symbol": "btcusdt",
    "type": "sell-limit",
    "client-order-id": "c1"
    },
    {
    "account-id": "123456",
    "price": "7802",
    "amount": "0.001",
    "symbol": "btcusdt",
    "type": "sell-limit",
    "client-order-id": "d2"
    }
]

请求参数

参数名称 数据类型 是否必需 默认值 描述
[{ account-id string true NA 账户 ID，取值参考 GET /v1/account/accounts。现货交易使用 ‘spot’ 账户的 account-id；
symbol string true NA 交易对,即btcusdt, ethbtc...（取值参考GET /v1/common/symbols）
type string true NA 订单类型，包括buy-market, sell-market, buy-limit, sell-limit, buy-ioc, sell-ioc, buy-limit-maker, sell-limit-maker（说明见下文）, buy-stop-limit, sell-stop-limit
amount string true NA 订单交易量（市价买单为订单交易额）
price string false NA 订单价格（对市价单无效）
source string false spot-api 现货交易填写“spot-api”
client-order-id string false NA 用户自编订单号（最大长度64个字符，须在24小时内保持唯一性）
stop-price string false NA 止盈止损订单触发价格
operator }] string false NA 止盈止损订单触发价运算符 gte – greater than and equal (>=), lte – less than and equal (<=)

buy-limit-maker

当“下单价格”>=“市场最低卖出价”，订单提交后，系统将拒绝接受此订单；

当“下单价格”<“市场最低卖出价”，提交成功后，此订单将被系统接受。

sell-limit-maker

当“下单价格”<=“市场最高买入价”，订单提交后，系统将拒绝接受此订单；

当“下单价格”>“市场最高买入价”，提交成功后，此订单将被系统接受。

Response:

{
    "status": "ok",
    "data": [
        {
            "order-id": 61713400772,
            "client-order-id": "c1"
        },
        {
            "order-id": 61713400940,
            "client-order-id": "d2"
        }
    ]
}

响应数据

字段名称 数据类型 描述
[{ order-id integer 订单编号
client-order-id string 用户自编订单号（如有）
err-code string 订单被拒错误码（仅对被拒订单有效）
err-msg }] string 订单被拒错误信息（仅对被拒订单有效）

如client order ID（在24小时内）被复用，节点返回先前订单的order ID及client order ID。

撤销订单

API Key 权限：交易
限频值（NEW）：100次/2s

此接口发送一个撤销订单的请求。

HTTP 请求

请求参数

参数名称 是否必须 类型 描述 默认值 取值范围
order-id true string 订单ID，填在path中

Success response:

{  
  "data": "59378"
}

响应数据

返回的主数据对象是一个对应下单单号的字符串。

错误码

Failure response:

{
  "status": "error",
  "err-code": "order-orderstate-error",
  "err-msg": "订单状态错误",
  "order-state":-1 // 当前订单状态
}

返回字段列表中，order-state的可能取值包括 -

order-state Description
-1 order was already closed in the long past (order state = canceled, partial-canceled, filled, partial-filled)
5 partial-canceled
6 filled
7 canceled
10 cancelling

撤销订单（基于client order ID）

API Key 权限：交易
限频值（NEW）：100次/2s

此接口发送一个撤销订单的请求。

HTTP 请求

Request:

{
  "client-order-id": "a0001"
}

请求参数

参数名称 是否必须 类型 描述 默认值 取值范围
client-order-id true string 用户自编订单号

Response:

{  
  "data": "10"
}

响应数据

字段名称 数据类型 描述
data integer 撤单状态码
Status Code Description
-1 order was already closed in the long past (order state = canceled, partial-canceled, filled, partial-filled)
0 client-order-id not found
5 partial-canceled
6 filled
7 canceled
10 cancelling

查询当前未成交订单

API Key 权限：读取
限频值（NEW）：50次/2s

查询已提交但是仍未完全成交或未被撤销的订单。

HTTP 请求

Request:

{
   "account-id": "100009",
   "symbol": "ethusdt",
   "side": "buy"
}

请求参数

参数名称 数据类型 是否必需 默认值 描述
account-id string true NA 账户 ID，取值参考 GET /v1/account/accounts。现货交易使用‘spot’账户的 account-id
symbol string ture NA 交易对,即btcusdt, ethbtc...（取值参考GET /v1/common/symbols）
side string false both 指定只返回某一个方向的订单，可能的值有: buy, sell. 默认两个方向都返回。
from string false 查询起始 ID
direct string false (如字段'from'已设定，此字段'direct'为必填) 查询方向，prev 向前；next 向后
size int false 100 返回订单的数量，最大值500。

Response:

{  
  "data": [
    {
      "id": 5454937,
      "symbol": "ethusdt",
      "account-id": 30925,
      "amount": "1.000000000000000000",
      "price": "0.453000000000000000",
      "created-at": 1530604762277,
      "type": "sell-limit",
      "filled-amount": "0.0",
      "filled-cash-amount": "0.0",
      "filled-fees": "0.0",
      "source": "web",
      "state": "submitted"
    }
  ]
}

响应数据

字段名称 数据类型 描述
id integer 订单id，无大小顺序，可作为下一次翻页查询请求的from字段
client-order-id string 用户自编订单号（所有open订单可返回client-order-id）
symbol string 交易对, 例如btcusdt, ethbtc
price string limit order的交易价格
created-at int 订单创建的调整为新加坡时间的时间戳，单位毫秒
type string 订单类型
filled-amount string 订单中已成交部分的数量
filled-cash-amount string 订单中已成交部分的总价格
filled-fees string 已交交易手续费总额
source string 现货交易填写“api”
state string 订单状态，包括submitted, partial-filled, cancelling, created
stop-price string 止盈止损订单触发价格
operator string 止盈止损订单触发价运算符

批量撤销订单（open orders）

API Key 权限：交易
限频值（NEW）：50次/2s

此接口发送批量撤销订单的请求。

HTTP 请求

请求参数

参数名称 是否必须 类型 描述 默认值 取值范围
account-id false string 账户ID，取值参考 GET /v1/account/accounts
symbol false string 交易代码列表（最多10 个symbols，多个交易代码间以逗号分隔），btcusdt, ethbtc...（取值参考/v1/common/symbols） all
side false string 主动交易方向 “buy”或“sell”，缺省将返回所有符合条件尚未成交订单
size false int 所需返回记录数 100 [0,100]

Response:

{
  "status": "ok",
  "data": {
    "success-count": 2,
    "failed-count": 0,
    "next-id": 5454600
  }
}

响应数据

参数名称 是否必须 数据类型 描述 取值范围
success-count true int 成功取消的订单数
failed-count true int 取消失败的订单数
next-id true long 下一个符合取消条件的订单号

批量撤销订单

API Key 权限：交易
限频值（NEW）：50次/2s

此接口同时为多个订单（基于id）发送取消请求。

HTTP 请求

Request:

{
  "client-order-ids": [
   "5983466", "5722939", "5721027", "5719487"
  ]
}

请求参数

参数名称 是否必须 类型 描述 默认值 取值范围
order-ids false string[] 订单编号列表（order-ids和client-order-ids必须且只能选一个填写，不超过50张订单） 单次不超过50个订单
client-order-ids false string[] 用户自编订单号列表（order-ids和client-order-ids必须且只能选一个填写，不超过50张订单） 单次不超过50个订单

Response:

{
    "status": "ok",
    "data": {
        "success": [
            "5983466"            
        ],
        "failed": [
            {
              "err-msg": "Incorrect order state",
              "order-state": 7,
              "order-id": "",
              "err-code": "order-orderstate-error",
              "client-order-id": "first"
            },
            {
              "err-msg": "Incorrect order state",
              "order-state": 7,
              "order-id": "",
              "err-code": "order-orderstate-error",
              "client-order-id": "second"
            },
            {
              "err-msg": "The record is not found.",
              "order-id": "",
              "err-code": "base-not-found",
              "client-order-id": "third"
            }
          ]
    }
}

响应数据

字段名称 数据类型 描述
{ success string[] 撤单成功订单列表（可为order-id列表或client-order-id列表，以用户请求为准）
failed } string[] 撤单失败订单列表（可为order-id列表或client-order-id列表，以用户请求为准）

撤单失败订单列表 -

字段名称 数据类型 描述
[{ order-id string 订单编号（如用户创建订单时包含order-id，返回中也须包含此字段）
client-order-id string 用户自编订单号（如用户创建订单时包含client-order-id，返回中也须包含此字段）
err-code string 订单被拒错误码（仅对被拒订单有效）
err-msg string 订单被拒错误信息（仅对被拒订单有效）
order-state }] string 当前订单状态（若有）

返回字段列表中，order-state的可能取值包括 -

order-state Description
-1 order was already closed in the long past (order state = canceled, partial-canceled, filled, partial-filled)
5 partial-canceled
6 filled
7 canceled
10 cancelling

查询订单详情

API Key 权限：读取
限频值（NEW）：50次/2s

此接口返回指定订单的最新状态和详情。通过API创建的订单，撤销超过2小时后无法查询。

HTTP 请求

请求参数

参数名称 是否必须 类型 描述 默认值 取值范围
order-id true string 订单ID，填在path中

Response:

{  
  "data": 
  {
    "id": 59378,
    "symbol": "ethusdt",
    "account-id": 100009,
    "amount": "10.1000000000",
    "price": "100.1000000000",
    "created-at": 1494901162595,
    "type": "buy-limit",
    "field-amount": "10.1000000000",
    "field-cash-amount": "1011.0100000000",
    "field-fees": "0.0202000000",
    "finished-at": 1494901400468,
    "user-id": 1000,
    "source": "api",
    "state": "filled",
    "canceled-at": 0
  }
}

响应数据

字段名称 是否必须 数据类型 描述 取值范围
account-id true long 账户 ID
amount true string 订单数量
canceled-at false long 订单撤销时间
created-at true long 订单创建时间
field-amount true string 已成交数量
field-cash-amount true string 已成交总金额
field-fees true string 已成交手续费（买入为币，卖出为钱）
finished-at false long 订单变为终结态的时间，不是成交时间，包含“已撤单”状态
id true long 订单ID
client-order-id false string 用户自编订单号（所有open订单可返回client-order-id（如有）；仅7天内（基于订单创建时间）的closed订单（state <> canceled）可返回client-order-id（如有）；仅24小时内（基于订单创建时间）的closed订单（state = canceled）可返回client-order-id（如有））
price true string 订单价格
source true string 订单来源 api
state true string 订单状态 submitted 已提交, partial-filled 部分成交, partial-canceled 部分成交撤销, filled 完全成交, canceled 已撤销， created
symbol true string 交易对 btcusdt, ethbtc, rcneth ...
type true string 订单类型 buy-market：市价买, sell-market：市价卖, buy-limit：限价买, sell-limit：限价卖, buy-ioc：IOC买单, sell-ioc：IOC卖单， buy-limit-maker, sell-limit-maker, buy-stop-limit，sell-stop-limit
stop-price false string 止盈止损订单触发价格
operator false string 止盈止损订单触发价运算符 gte,lte

查询订单详情（基于client order ID）

API Key 权限：读取
限频值（NEW）：50次/2s

此接口返回指定用户自编订单号（24小时内）的订单最新状态和详情。通过API创建的订单，撤销超过2小时后无法查询。

HTTP 请求

请求参数

参数名称 是否必须 类型 描述 默认值 取值范围
clientOrderId true string 用户自编订单号

Response:

{  
  "data": 
  {
    "id": 59378,
    "symbol": "ethusdt",
    "account-id": 100009,
    "amount": "10.1000000000",
    "price": "100.1000000000",
    "created-at": 1494901162595,
    "type": "buy-limit",
    "field-amount": "10.1000000000",
    "field-cash-amount": "1011.0100000000",
    "field-fees": "0.0202000000",
    "finished-at": 1494901400468,
    "user-id": 1000,
    "source": "api",
    "state": "filled",
    "canceled-at": 0
  }
}

响应数据

字段名称 是否必须 数据类型 描述 取值范围
account-id true long 账户 ID
amount true string 订单数量
canceled-at false long 订单撤销时间
created-at true long 订单创建时间
field-amount true string 已成交数量
field-cash-amount true string 已成交总金额
field-fees true string 已成交手续费（买入为币，卖出为钱）
finished-at false long 订单变为终结态的时间，不是成交时间，包含“已撤单”状态
id true long 订单ID
client-order-id false string 用户自编订单号（仅24小时内（基于订单创建时间）的订单可被查询.）
price true string 订单价格
source true string 订单来源 api
state true string 订单状态 submitted 已提交, partial-filled 部分成交, partial-canceled 部分成交撤销, filled 完全成交, canceled 已撤销，created
symbol true string 交易对 btcusdt, ethbtc, rcneth ...
type true string 订单类型 buy-market：市价买, sell-market：市价卖, buy-limit：限价买, sell-limit：限价卖, buy-ioc：IOC买单, sell-ioc：IOC卖单， buy-limit-maker, sell-limit-maker, buy-stop-limit，sell-stop-limit
stop-price false string 止盈止损订单触发价格
operator false string 止盈止损订单触发价运算符 gte,lte

如client order ID不存在，返回如下错误信息 { "status": "error", "err-code": "base-record-invalid", "err-msg": "record invalid", "data": null }

成交明细

API Key 权限：读取
限频值（NEW）：50次/2s

此接口返回指定订单的成交明细。

HTTP 请求

请求参数

参数名称 是否必须 类型 描述 默认值 取值范围
order-id true string 订单ID，填在path中

Response:

{  
  "data": [
    {
      "id": 29553,
      "order-id": 59378,
      "match-id": 59335,
      "trade-id": 100282808529,
      "symbol": "ethusdt",
      "type": "buy-limit",
      "source": "api",
      "price": "100.1000000000",
      "filled-amount": "9.1155000000",
      "filled-fees": "0.0182310000",
      "created-at": 1494901400435,
      "role": "maker",
      "filled-points": "0.0",
      "fee-deduct-currency": ""
    }
    ...
  ]
}

响应数据

字段名称 是否必须 数据类型 描述 取值范围
created-at true long 成交时间戳timestamp
filled-amount true string 成交数量
filled-fees true string 交易手续费（正值）或交易返佣金（负值）
fee-currency true string 交易手续费或交易返佣币种（买单的交易手续费币种为基础币种，卖单的交易手续费币种为计价币种；买单的交易返佣币种为计价币种，卖单的交易返佣币种为基础币种）
id true long 订单成交记录ID
match-id true long 撮合ID，订单在撮合中执行的顺序ID
order-id true long 订单ID，成交所属订单的ID
trade-id false integer Unique trade ID (NEW)唯一成交编号，成交时产生的唯一编号ID
price true string 成交价格
source true string 订单来源 api
symbol true string 交易对 btcusdt, ethbtc, rcneth ...
type true string 订单类型 buy-market：市价买, sell-market：市价卖, buy-limit：限价买, sell-limit：限价卖, buy-ioc：IOC买单, sell-ioc：IOC卖单， buy-limit-maker, sell-limit-maker, buy-stop-limit，sell-stop-limit
role true string 成交角色 maker,taker
filled-points true string 抵扣数量
fee-deduct-currency true string 抵扣类型 如果为空，代表扣除的手续费是原币；代表抵扣手续费的是抵扣资产
fee-deduct-state true string 抵扣状态 抵扣中：ongoing，抵扣完成：done

注：

搜索历史订单

API Key 权限：读取
限频值（NEW）：50次/2s

此接口基于搜索条件查询历史订单。通过API创建的订单，撤销超过2小时后无法查询。

用户可选择以“时间范围”查询历史订单，以替代原先的以“日期范围“查询方式。

建议用户以“时间范围“查询历史订单。

HTTP 请求

Request:

{
   "account-id": "100009",
   "amount": "10.1",
   "price": "100.1",
   "source": "api",
   "symbol": "ethusdt",
   "type": "buy-limit"
}

请求参数

参数名称 是否必须 类型 描述 默认值 取值范围
symbol true string 交易对 btcusdt, ethbtc...（取值参考GET /v1/common/symbols）
types false string 查询的订单类型组合，使用逗号分割 buy-market：市价买, sell-market：市价卖, buy-limit：限价买, sell-limit：限价卖, buy-ioc：IOC买单, sell-ioc：IOC卖单， buy-limit-maker, sell-limit-maker, buy-stop-limit，sell-stop-limit
start-time false long 查询开始时间, 时间格式UTC time in millisecond。 以订单生成时间进行查询 -48h 查询结束时间的前48小时 取值范围 [((end-time) – 48h), (end-time)] ，查询窗口最大为48小时，窗口平移范围为最近180天，已完全撤销的历史订单的查询窗口平移范围只有最近2小时(state="canceled")
end-time false long 查询结束时间, 时间格式UTC time in millisecond。 以订单生成时间进行查询 present 取值范围 [(present-179d), present] ，查询窗口最大为48小时，窗口平移范围为最近180天，已完全撤销的历史订单的查询窗口平移范围只有最近2小时(state="canceled")
start-date false string 查询开始日期, 日期格式yyyy-mm-dd。 以订单生成时间进行查询 -1d 查询结束日期的前1天 取值范围 [((end-date) – 1), (end-date)] ，查询窗口最大为2天，窗口平移范围为最近180天，已完全撤销的历史订单的查询窗口平移范围只有最近2小时(state="canceled")
end-date false string 查询结束日期, 日期格式yyyy-mm-dd。 以订单生成时间进行查询 today 取值范围 [(today-179), today] ，查询窗口最大为2天，窗口平移范围为最近180天，已完全撤销的历史订单的查询窗口平移范围只有最近2小时(state="canceled")
states true string 查询的订单状态组合，使用','分割 submitted 已提交, partial-filled 部分成交, partial-canceled 部分成交撤销, filled 完全成交, canceled 已撤销，created
from false string 查询起始 ID 如果是向后查询，则赋值为上一次查询结果中得到的最后一条id ；如果是向前查询，则赋值为上一次查询结果中得到的第一条id
direct false string 查询方向 prev 向前；next 向后
size false string 查询记录大小 100 [1, 100]

Response:

{  
  "data": [
    {
      "id": 59378,
      "symbol": "ethusdt",
      "account-id": 100009,
      "amount": "10.1000000000",
      "price": "100.1000000000",
      "created-at": 1494901162595,
      "type": "buy-limit",
      "field-amount": "10.1000000000",
      "field-cash-amount": "1011.0100000000",
      "field-fees": "0.0202000000",
      "finished-at": 1494901400468,
      "user-id": 1000,
      "source": "api",
      "state": "filled",
      "canceled-at": 0
    }
    ...
  ]
}

响应数据

参数名称 是否必须 数据类型 描述 取值范围
account-id true long 账户 ID
amount true string 订单数量
canceled-at false long 接到撤单申请的时间
created-at true long 订单创建时间
field-amount true string 已成交数量
field-cash-amount true string 已成交总金额
field-fees true string 已成交手续费（买入为基础币，卖出为计价币）
finished-at false long 最后成交时间
id true long 订单ID，无大小顺序，可作为下一次翻页查询请求的from字段
client-order-id false string 用户自编订单号（所有open订单可返回client-order-id（如有）；仅7天内（基于订单创建时间）的closed订单（state <> canceled）可返回client-order-id（如有）；仅24小时内（基于订单创建时间）的closed订单（state = canceled）可被查询）
price true string 订单价格
source true string 订单来源 api
state true string 订单状态 submitted 已提交, partial-filled 部分成交, partial-canceled 部分成交撤销, filled 完全成交, canceled 已撤销，created
symbol true string 交易对 btcusdt, ethbtc, rcneth ...
type true string 订单类型 submit-cancel：已提交撤单申请 ,buy-market：市价买, sell-market：市价卖, buy-limit：限价买, sell-limit：限价卖, buy-ioc：IOC买单, sell-ioc：IOC卖单， buy-limit-maker, sell-limit-maker, buy-stop-limit，sell-stop-limit
stop-price false string 止盈止损订单触发价格
operator false string 止盈止损订单触发价运算符 gte,lte

start-date, end-date相关错误码

错误码 对应错误场景
invalid_interval start date小于end date; 或者 start date 与end date之间的时间间隔大于2天
invalid_start_date start date是一个180天之前的日期；或者start date是一个未来的日期
invalid_end_date end date 是一个180天之前的日期；或者end date是一个未来的日期

搜索最近48小时内历史订单

API Key 权限：读取
限频值（NEW）：20次/2s

此接口基于搜索条件查询最近48小时内历史订单。通过API创建的订单，撤销超过2小时后无法查询。

HTTP 请求

Request:

{
   "symbol": "btcusdt",
   "start-time": "1556417645419",
   "end-time": "1556533539282",
   "direct": "prev",
   "size": "10"
}

请求参数

参数名称 是否必须 类型 描述 默认值 取值范围
symbol false string 交易对 all btcusdt, ethbtc...（取值参考GET /v1/common/symbols）
start-time false long 查询起始时间（含） 48小时前的时刻 UTC time in millisecond
end-time false long 查询结束时间（含） 查询时刻 UTC time in millisecond
direct false string 订单查询方向（注：仅在检索出的总条目数量超出size字段限定时起作用；如果检索出的总条目数量在size 字段限定内，direct 字段不起作用。） next prev 向前, next 向后
size false int 每次返回条目数量 100 [10,1000]

Response:

{
    "status": "ok",
    "data": [
        {
            "id": 31215214553,
            "symbol": "btcusdt",
            "account-id": 4717043,
            "amount": "1.000000000000000000",
            "price": "1.000000000000000000",
            "created-at": 1556533539282,
            "type": "buy-limit",
            "field-amount": "0.0",
            "field-cash-amount": "0.0",
            "field-fees": "0.0",
            "finished-at": 1556533568953,
            "source": "web",
            "state": "canceled",
            "canceled-at": 1556533568911
        }
    ]
}

响应数据

参数名称 是否必须 数据类型 描述 取值范围
{account-id true long 账户 ID
amount true string 订单数量
canceled-at false long 接到撤单申请的时间
created-at true long 订单创建时间
field-amount true string 已成交数量
field-cash-amount true string 已成交总金额
field-fees true string 已成交手续费（买入为基础币，卖出为计价币）
finished-at false long 最后成交时间
id true long 订单ID，无大小顺序
client-order-id false string 用户自编订单号（仅48小时内（基于订单创建时间）的closed订单（state <> canceled）可返回client-order-id（如有）；仅24小时内（基于订单创建时间）的closed订单（state = canceled）可被查询）
price true string 订单价格
source true string 订单来源 api
state true string 订单状态 partial-canceled 部分成交撤销, filled 完全成交, canceled 已撤销
symbol true string 交易对 btcusdt, ethbtc, rcneth ...
stop-price false string 止盈止损订单触发价格
operator false string 止盈止损订单触发价运算符 gte,lte
type} true string 订单类型 buy-market：市价买, sell-market：市价卖, buy-limit：限价买, sell-limit：限价卖, buy-ioc：IOC买单, sell-ioc：IOC卖单, buy-limit-maker, sell-limit-maker, buy-limit-maker, sell-limit-maker
next-time false long 下一查询起始时间（当请求字段”direct”为”prev”时有效）, 下一查询结束时间（当请求字段”direct”为”next”时有效）。注：仅在检索出的总条目数量超出size字段限定时，此返回字段存在。 UTC time in millisecond

当前和历史成交

API Key 权限：读取
限频值（NEW）：20次/2s

此接口基于搜索条件查询当前和历史成交记录。

HTTP 请求

请求参数

参数名称 是否必须 类型 描述 默认值 取值范围
symbol true string 交易对 N/A btcusdt, ethbtc...（取值参考GET /v1/common/symbols）
types false string 查询的订单类型组合，使用','分割 all buy-market：市价买, sell-market：市价卖, buy-limit：限价买, sell-limit：限价卖, buy-ioc：IOC买单, sell-ioc：IOC卖单, buy-limit-maker, sell-limit-maker, buy-stop-limit, sell-stop-limit
start-date false string 查询开始日期（新加坡时区）日期格式yyyy-mm-dd -1d 查询结束日期的前1天 取值范围 [((end-date) – 1), (end-date)] ，查询窗口最大为2天，窗口平移范围为最近61天。
end-date false string 查询结束日期（新加坡时区）, 日期格式yyyy-mm-dd today 取值范围 [(today-60), today] ，查询窗口最大为2天，窗口平移范围为最近61天
from false string 查询起始 ID N/A 如果是向后查询，则赋值为上一次查询结果中得到的最后一条id（不是trade-id） ；如果是向前查询，则赋值为上一次查询结果中得到的第一条id（不是trade-id）
direct false string 查询方向 next prev 向前；next 向后
size false string 查询记录大小 100 [1，500]

Response:

{  
  "data": [
    {
      "id": 29553,
      "order-id": 59378,
      "match-id": 59335,
      "symbol": "ethusdt",
      "type": "buy-limit",
      "source": "api",
      "price": "100.1000000000",
      "filled-amount": "9.1155000000",
      "filled-fees": "0.0182310000",
      "created-at": 1494901400435,
      "trade-id": 100282808529,
      "role": taker,
      "filled-points": "0.0",
      "fee-deduct-currency": ""
    }
    ...
  ]
}

响应数据

参数名称 是否必须 数据类型 描述 取值范围
created-at true long 成交时间戳timestamp
filled-amount true string 成交数量
filled-fees true string 交易手续费（正值）或交易返佣（负值）
fee-currency true string 交易手续费或交易返佣币种（买单的交易手续费币种为基础币种，卖单的交易手续费币种为计价币种；买单的交易返佣币种为计价币种，卖单的交易返佣币种为基础币种）
id true long 订单成交记录 ID，无大小顺序，可作为下一次翻页查询请求的from字段
match-id true long 撮合 ID
order-id true long 订单 ID
trade-id false integer 唯一成交编号
price true string 成交价格
source true string 订单来源 api
symbol true string 交易对 btcusdt, ethbtc, rcneth ...
type true string 订单类型 buy-market：市价买, sell-market：市价卖, buy-limit：限价买, sell-limit：限价卖, buy-ioc：IOC买单, sell-ioc：IOC卖单， buy-limit-maker, sell-limit-maker, buy-stop-limit，sell-stop-limit
role true string 成交角色 maker,taker
filled-points true string 抵扣数量
fee-deduct-currency true string 抵扣类型
fee-deduct-state true string 抵扣状态 抵扣中：ongoing，抵扣完成：done

注：

start-date, end-date相关错误码

错误码 对应错误场景
invalid_interval start date小于end date; 或者 start date 与end date之间的时间间隔大于2天
invalid_start_date start date是一个61天之前的日期；或者start date是一个未来的日期
invalid_end_date end date 是一个61天之前的日期；或者end date是一个未来的日期

获取用户当前手续费率

Api用户查询交易对费率，一次限制最多查10个交易对，子用户的费率和母用户保持一致

API Key 权限：读取

curl "https://api.bitv.com/v2/reference/transact-fee-rate?symbols=btcusdt,ethusdt,ltcusdt"

HTTP 请求

请求参数

参数 数据类型 是否必须 默认值 描述 取值范围
symbols string true NA 交易对，可多填，逗号分隔 btcusdt, ethbtc...（取值参考GET /v1/common/symbols）>

Response:

{
  "code": "200",
  "data": [
     {
        "symbol": "btcusdt",
        "makerFeeRate":"0.002",
        "takerFeeRate":"0.002",
        "actualMakerRate": "0.002",
        "actualTakerRate":"0.002
     },
     {
        "symbol": "ethusdt",
        "makerFeeRate":"0.002",
        "takerFeeRate":"0.002",
        "actualMakerRate": "0.002",
        "actualTakerRate":"0.002
    },
     {
        "symbol": "ltcusdt",
        "makerFeeRate":"0.002",
        "takerFeeRate":"0.002",
        "actualMakerRate": "0.002",
        "actualTakerRate":"0.002
    }
  ]
}

响应数据

字段名称 数据类型 描述
code integer 状态码
message string 错误描述（如有）
data object
{ symbol string 交易代码
makerFeeRate string 基础费率 - 被动方，如适用交易手续费返佣，返回返佣费率（负值）
takerFeeRate string 基础费率 - 主动方
actualMakerRate string 抵扣后费率 - 被动方，如不适用抵扣或未启用抵扣，返回基础费率；如适用交易手续费返佣，返回返佣费率（负值）
actualTakerRate } string 抵扣后费率 – 主动方，如不适用抵扣或未启用抵扣，返回基础费率

注：

Websocket行情数据

简介

接入URL

行情请求地址

wss://api.bitv.com/ws

数据压缩

WebSocket 行情接口返回的所有数据都进行了 GZIP 压缩，需要 client 在收到数据之后解压。

心跳消息

{"ping": 1492420473027}

当用户的Websocket客户端连接到Websocket服务器后，服务器会定期（当前设为5秒）向其发送ping消息并包含一整数值。

{"pong": 1492420473027}

当用户的Websocket客户端接收到此心跳消息后，应返回pong消息并包含同一整数值。

订阅主题

Sub request:

{
  "sub": "market.btcusdt.kline.1min",
  "id": "id1"
}

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

{ "sub": "topic to sub", "id": "id generate by client" }

Sub response:

{
  "id": "id1",
  "status": "ok",
  "subbed": "market.btcusdt.kline.1min",
  "ts": 1489474081631
}

成功订阅后，Websocket客户端将收到确认。

之后, 一旦所订阅的主题有更新，Websocket客户端将收到服务器推送的更新消息（push）。

取消订阅

UnSub request:

{
  "unsub": "market.btcusdt.trade.detail",
  "id": "id4"
}

取消订阅的格式如下：

{ "unsub": "topic to unsub", "id": "id generate by client" }

UnSub response:

{
  "id": "id4",
  "status": "ok",
  "unsubbed": "market.btcusdt.trade.detail",
  "ts": 1494326028889
}

取消订阅成功确认。

请求数据

Websocket服务器同时支持一次性请求数据（pull）。

一次性请求的格式如下：

{ "req": "topic to req", "id": "id generate by client" }

一次性返回数据的具体格式参见各个主题。

限频

数据请求（req）限频规则

单个连接每两次请求不能小于100ms。

错误码

以下是WebSocket行情接口的错误码、错误消息和说明。

错误码 错误消息 说明
bad-request invalid topic topic错误
bad-request invalid symbol symbol错误
bad-request symbol trade not open now 该交易对未到开始交易时间
bad-request 429 too many request req 请求太频繁
bad-request unsub with not subbed topic 未订阅该主题
bad-request not json string 发送的请求不是JSON格式
1008 header required correct cloud-exchange exchangeCode 参数错误
bad-request request timeout 请求超时

K线数据

主题订阅

一旦K线数据产生，Websocket服务器将通过此订阅主题接口推送至客户端：

market.$symbol$.kline.$period$

订阅请求

{
  "sub": "market.ethbtc.kline.1min",
  "id": "id1"
}

参数

参数 数据类型 是否必需 描述 取值范围
symbol string true 交易代码 btcusdt, ethbtc...等
period string true K线周期 1min, 5min, 15min, 30min, 60min, 4hour, 1day, 1mon, 1week, 1year

Response

{
  "id": "id1",
  "status": "ok",
  "subbed": "market.ethbtc.kline.1min",
  "ts": 1489474081631 //system response time
}

Update example

{
  "ch": "market.ethbtc.kline.1min",
  "ts": 1489474082831, //system update time
  "tick": {
    "id": 1489464480,
    "amount": 0.0,
    "count": 0,
    "open": 7962.62,
    "close": 7962.62,
    "low": 7962.62,
    "high": 7962.62,
    "vol": 0.0
  }
}

数据更新字段列表

字段 数据类型 描述
id integer unix时间，同时作为K线ID
amount float 成交量
count integer 成交笔数
open float 开盘价
close float 收盘价（当K线为最晚的一根时，是最新成交价）
low float 最低价
high float 最高价
vol float 成交额, 即 sum(每一笔成交价 * 该笔的成交量)

数据请求

用请求方式一次性获取K线数据需要额外提供以下参数： （每次最多返回300条）

{
  "req": "market.$symbol.kline.$period",
  "id": "id generated by client",
  "from": "from time in epoch seconds",
  "to": "to time in epoch seconds"
}
参数 数据类型 是否必需 缺省值 描述 取值范围
from integer false 1501174800(2017-07-28T00:00:00+08:00) 起始时间 (epoch time in second) [1501174800, 2556115200]
to integer false 2556115200(2050-01-01T00:00:00+08:00) 结束时间 (epoch time in second) [1501174800, 2556115200] or ($from, 2556115200] if "from" is set

市场深度行情数据

此主题发送最新市场深度快照。快照频率为每秒1次。

主题订阅

market.$symbol.depth.$type

Subscribe request

{
  "sub": "market.btcusdt.depth.step0",
  "id": "id1"
}

参数

参数 数据类型 是否必需 缺省值 描述 取值范围
symbol string true NA 交易代码 btcusdt, ethbtc...（取值参考GET /v1/common/symbols）
type string true step0 合并深度类型 step0, step1, step2, step3, step4, step5

"type" 合并深度类型

Value Description
step0 不合并深度
step1 Aggregation level = precision*10
step2 Aggregation level = precision*100
step3 Aggregation level = precision*1000
step4 Aggregation level = precision*10000
step5 Aggregation level = precision*100000

当type值为‘step0’时，默认深度为150档; 当type值为‘step1’,‘step2’,‘step3’,‘step4’,‘step5’时，默认深度为20档。

Response

{
  "id": "id1",
  "status": "ok",
  "subbed": "market.btcusdt.depth.step0",
  "ts": 1489474081631 //system response time
}

Update example

{
  "ch": "market.htusdt.depth.step0",
  "ts": 1572362902027, //system update time
  "tick": {
    "bids": [
      [3.7721, 344.86],// [price, size]
      [3.7709, 46.66] 
    ],
    "asks": [
      [3.7745, 15.44],
      [3.7746, 70.52]
    ],
    "version": 100434317651,
    "ts": 1572362902012 //quote time
  }
}

数据更新字段列表

字段 数据类型 描述
bids object 当前的所有买单 [price, size]
asks object 当前的所有卖单 [price, size]
version integer 内部字段
ts integer 新加坡时间的时间戳，单位毫秒

数据请求

支持数据请求方式一次性获取市场深度数据：

{
  "req": "market.btcusdt.depth.step0",
  "id": "id10"
}

市场深度MBP行情数据（增量推送）

用户可订阅此频道以接收最新深度行情Market By Price (MBP) 的增量数据推送；同时，该频道支持用户以req方式请求获取全量数据。

MBP增量推送及MBP全量REQ请求地址

wss://api.bitv.com/feed

建议下游数据处理方式：
1） 订阅增量数据并开始缓存；
2） 请求全量数据（同等档位数）并根据该全量消息的seqNum与缓存增量数据中的prevSeqNum对齐；
3） 开始连续增量数据接收与计算，构建并持续更新MBP订单簿；
4） 每条增量数据的prevSeqNum须与前一条增量数据的seqNum一致，否则意味着存在增量数据丢失，须重新获取全量数据并对齐；
5） 如果收到增量数据包含新增price档位，须将该price档位插入MBP订单簿中适当位置；
6） 如果收到增量数据包含已有price档位，但size不同，须替换MBP订单簿中该price档位的size；
7） 如果收到增量数据某price档位的size为0值，须将该price档位从MBP订单簿中删除；
8） 如果收到单条增量数据中包含两个及以上price档位的更新，这些price档位须在MBP订单簿中被同时更新。

当前仅支持5档/20档MBP逐笔增量以及150档MBP快照增量的推送，二者的区别为 -
1） 深度不同；
2） 5档/20档为逐笔增量MBP行情，150档为100毫秒定时快照增量MBP行情；
3） 当5档/20档订单簿仅发生单边行情变化时，增量推送仅包含单边行情更新，比如，推送消息中包含数组asks，但不含数组bids；

{
    "ch": "market.btcusdt.mbp.5",
    "ts": 1573199608679,
    "tick": {
        "seqNum": 100020146795,
        "prevSeqNum": 100020146794,
        "asks": [
            [645.140000000000000000, 26.755973959140651643]
        ]
    }
}

当150档订单簿仅发生单边行情变化时，增量推送包含双边行情更新，但其中一边行情为空，比如，推送消息中包含数组asks更新的同时，也包含bids空数组；

{
    "ch":"market.btcusdt.mbp.150",
    "ts":1573199608679,
    "tick":{
        "seqNum":100020146795,
        "prevSeqNum":100020146794,
        "bids":[ ],
        "asks":[
            [645.14,26.75597395914065]
        ]
    }
}

未来，150档增量推送的数据行为将与5档/20档增量保持一致，即，单边深度行情变更时，推送消息中将不包含另一边行情深度行情；
4） 当150档订单簿在100毫秒时间间隔内未发生变化时，增量推送包含bids和asks空数组；

{
    "ch":"market.zecusdt.mbp.150",
    "ts":1585074391470,
    "tick":{
        "seqNum":100772868478,
        "prevSeqNum":100772868476,
        "bids":[  ],
        "asks":[  ]
    }
}

而5档/20档MBP逐笔增量，在订单簿未发生变化时，不推送数据；
未来，150档增量推送的数据行为将与5档增量保持一致，即，在订单簿未发生变化时，不再推送空消息；
5）5档/20档逐笔增量行情仅支持部分交易对（btcusdt,ethusdt,xrpusdt,eosusdt,ltcusdt,etcusdt,adausdt,dashusdt,bsvusdt），150档快照增量支持全部交易对。

REQ频道支持5档/20档/150档全量数据的获取。

订阅增量推送

market.$symbol.mbp.$levels

Sub request

{
  "sub": "market.btcusdt.mbp.5",
  "id": "id1"
}

请求全量数据

market.$symbol.mbp.$levels

Req request

{
  "req": "market.btcusdt.mbp.5",
  "id": "id2"
}

参数

参数 数据类型 是否必需 缺省值 描述 取值范围
symbol string true NA 交易代码（不支持通配符）
levels integer true NA 深度档位（取值：5, 20, 150） 当前仅支持5档，20档，或150档深度

Response (增量订阅)

{
  "id": "id1",
  "status": "ok",
  "subbed": "market.btcusdt.mbp.5",
  "ts": 1489474081631 //system response time
}

Incremental Update (增量订阅)

{
    "ch": "market.btcusdt.mbp.5",
    "ts": 1573199608679, //system update time
  "tick": {
           "seqNum": 100020146795,
            "prevSeqNum": 100020146794,
           "asks": [
                 [645.140000000000000000, 26.755973959140651643] // [price, size]
           ]
      }
}

Response (全量请求)

{
    "id": "id2",
    "rep": "market.btcusdt.mbp.150",
    "status": "ok",
    "data": {
        "seqNum": 100020142010,
        "bids": [
            [618.37, 71.594], // [price, size]
            [423.33, 77.726],
            [223.18, 47.997],
            [219.34, 24.82],
            [210.34, 94.463]
    ],
        "asks": [
            [650.59, 14.909733438479636],
            [650.63, 97.996],
            [650.77, 97.465],
            [651.23, 83.973],
            [651.42, 34.465]
        ]
    }
}

数据更新字段列表

字段 数据类型 描述
seqNum integer 消息序列号
prevSeqNum integer 上一消息序列号
bids object 买盘，按price降序排列，["price","size"]
asks object 卖盘，按price升序排列，["price","size"]

市场深度MBP行情数据（全量推送）

用户可订阅此频道以接收最新深度行情Market By Price (MBP) 的全量数据推送。推送频率为大约100毫秒一次。

订阅增量推送

market.$symbol.mbp.refresh.$levels

Sub request

{
"sub": "market.btcusdt.mbp.refresh.20",
"id": "id1"
}

参数

参数 数据类型 是否必需 缺省值 描述 取值范围
symbol string true NA 交易代码（不支持通配符）
levels integer true NA 深度档位 5,10,20

Response

{
"id": "id1",
"status": "ok",
"subbed": "market.btcusdt.mbp.refresh.20",
"ts": 1489474081631 //system response time
}

Refresh Update

{
"ch": "market.btcusdt.mbp.refresh.20",
"ts": 1573199608679, //system update time
"tick": {

        "seqNum": 100020142010,
        "bids": [
            [618.37, 71.594], // [price, size]
            [423.33, 77.726],
            [223.18, 47.997],
            [219.34, 24.82],
            [210.34, 94.463], ... // 省略余下15档
        ],
        "asks": [
            [650.59, 14.909733438479636],
            [650.63, 97.996],
            [650.77, 97.465],
            [651.23, 83.973],
            [651.42, 34.465], ... // 省略余下15档
        ]
}
}

数据更新字段列表

字段 数据类型 描述
seqNum integer 消息序列号
bids object 买盘，按price降序排列，["price","size"]
asks object 卖盘，按price升序排列，["price","size"]

买一卖一逐笔行情

当买一价、买一量、卖一价、卖一量，其中任一数据发生变化时，此主题推送逐笔更新。

主题订阅

market.$symbol.bbo

Subscribe request

{
  "sub": "market.btcusdt.bbo",
  "id": "id1"
}

参数

参数 数据类型 是否必需 缺省值 描述 取值范围
symbol string true NA 交易代码 btcusdt, ethbtc...（取值参考GET /v1/common/symbols）

Response

{
  "id": "id1",
  "status": "ok",
  "subbed": "market.btcusdt.bbo",
  "ts": 1489474081631 //system response time
}

Update example

{
  "ch": "market.btcusdt.bbo",
  "ts": 1489474082831, //system update time
  "tick": {
    "symbol": "btcusdt",
    "quoteTime": "1489474082811",
    "bid": "10008.31",
    "bidSize": "0.01",
    "ask": "10009.54",
    "askSize": "0.3",
    "seqId":"10242474683"
  }
}

数据更新字段列表

字段 数据类型 描述
symbol string 交易代码
quoteTime long 盘口更新时间
bid float 买一价
bidSize float 买一量
ask float 卖一价
askSize float 卖一量
seqId int 消息序号

成交明细

主题订阅

此主题提供市场最新成交逐笔明细。

market.$symbol.trade.detail

Subscribe request

{
  "sub": "market.btcusdt.trade.detail",
  "id": "id1"
}

参数

参数 数据类型 是否必需 缺省值 描述 取值范围
symbol string true NA 交易代码 btcusdt, ethbtc...（取值参考GET /v1/common/symbols）

Response

{
  "id": "id1",
  "status": "ok",
  "subbed": "market.btcusdt.trade.detail",
  "ts": 1489474081631 //system response time
}

Update example

{
  "ch": "market.btcusdt.trade.detail",
  "ts": 1489474082831, //system update time
  "tick": {
        "id": 14650745135,
        "ts": 1533265950234, //trade time
        "data": [
            {
                "amount": 0.0099,
                "ts": 1533265950234, //trade time
                "id": 146507451359183894799,
                "tradeId": 102043494568,
                "price": 401.74,
                "direction": "buy"
            }
            // more Trade Detail data here
        ]
  }
}

数据更新字段列表

字段 数据类型 描述
id integer 唯一成交ID（将被废弃）
tradeId integer 唯一成交ID（NEW）
amount float 成交量（买或卖一方）
price float 成交价
ts integer 成交时间 (UNIX epoch time in millisecond)
direction string 成交主动方 (taker的订单方向) : 'buy' or 'sell'

数据请求

支持数据请求方式一次性获取成交明细数据（仅能获取最多最近300个成交记录）：

{
  "req": "market.btcusdt.trade.detail",
  "id": "id11"
}

市场概要

主题订阅

此主题提供24小时内最新市场概要快照。快照频率不超过每秒10次。

market.$symbol.detail

Subscribe request

{
  "sub": "market.btcusdt.detail",
  "id": "id1"
}

参数

参数 数据类型 是否必需 缺省值 描述 取值范围
symbol string true NA 交易代码 btcusdt, ethbtc...等

Response

{
  "id": "id1",
  "status": "ok",
  "subbed": "market.btcusdt.detail",
  "ts": 1489474081631 //system response time
}

Update example

{
  "ch": "market.btcusdt.detail",
  "ts": 1494496390001, //system update time
  "tick": {
    "amount": 12224.2922,
    "open":   9790.52,
    "close":  10195.00,
    "high":   10300.00,
    "id":     1494496390,
    "count":  15195,
    "low":    9657.00,
    "vol":    121906001.754751
  }
}

数据更新字段列表

字段 数据类型 描述
id integer unix时间，同时作为消息ID
amount float 24小时成交量
count integer 24小时成交笔数
open float 24小时开盘价
close float 最新价
low float 24小时最低价
high float 24小时最高价
vol float 24小时成交额

数据请求

支持数据请求方式一次性获取市场概要数据：

{
  "req": "market.btcusdt.detail",
  "id": "id11"
}

Websocket资产及订单

简介

接入URL

Websocket资产及订单

wss://api.bitv.com/ws/v2

数据压缩

数据未进行 GZIP 压缩。

心跳消息

当用户的Websocket客户端连接到WebSocket服务器后，服务器会定期（当前设为20秒）向其发送Ping消息并包含一整数值如下：

{
    "action": "ping",
    "data": {
        "ts": 1575537778295
    }
}

当用户的Websocket客户端接收到此心跳信息后，应返回Pong消息并包含同一整数值：

{
    "action": "pong",
    "data": {
          "ts": 1575537778295 // 使用Ping消息中的ts值
    }
}

action的有效取值

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

限频

此版本对用户采取了多维度的限频策略，具体策略如下：

鉴权

鉴权请求格式如下：

{
    "action": "req", 
    "ch": "auth",
    "params": { 
        "authType":"api",
        "accessKey": "e2xxxxxx-99xxxxxx-84xxxxxx-7xxxx",
        "signatureMethod": "HmacSHA256",
        "signatureVersion": "2.1",
        "timestamp": "2019-09-01T18:16:16",
        "signature": "4F65x5A2bLyMWVQj3Aqp+B4w+ivaA7n5Oi2SuYtCJ9o="
    }
}

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

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

参数说明

字段 是否必需 数据类型 描述
action true string Websocket数据操作类型，鉴权固定值为req
ch true string 请求主题，鉴权固定值为auth
authType true string 鉴权类型，鉴权固定值为api。注意，该参数不在签名计算中。
accessKey true string 您申请的API Key中的AccessKey
signatureMethod true string 签名方法，用户计算签名寄语哈希的协议，固定值为HmacSHA256
signatureVersion true string 签名协议版本，固定值为2.1
timestamp true string 时间戳，您发出请求的时间（UTC时间）在查询请求中包含此值有助于防止第三方截取您的请求。如：2017-05-11T16:22:06。再次强调是 (UTC 时区)
signature true string 签名, 计算得出的值，用于确保签名有效和未被篡改

签名步骤

签名步骤,您可以在【快速入门-签名认证】部分进行查看。

注：JSON请求中的数据不需要URL编码。

订阅主题

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

{
    "action": "sub",
    "ch": "accounts.update"
}

订阅成功Websocket客户端会接收到如下消息：

{
    "action": "sub",
    "code": 200,
    "ch": "accounts.update#0",
    "data": {}
}

请求数据

成功建立Websocket服务器的连接后，Websocket客户端发送如下请求用以获取一次性数据：

{
    "action": "req", 
    "ch": "topic",
}

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

{
    "action": "req",
    "ch": "topic",
    "code": 200,
    "data": {} // 请求数据体
}

错误码

以下是WebSocket资产和订单接口的错误码、错误消息和说明。

错误码 错误消息 说明
200 正确 正确返回
100 超时关闭 超时关闭
400 Bad Request 请求错误
404 Not Found 找不到服务
429 Too Many Requests 超过单机服务最大连接数或者超过单IP最大连接数
500 系统异常 系统错误
2000 invalid.ip 无效的ip
2001 nvalid.json 无效的请求json
2001 invalid.authType 验签方式错误
2001 invalid.action 无效的订阅事件
2001 invalid.symbol 无效的交易对
2001 invalid.ch 无效的订阅
2001 invalid.exchange 无效的交易所code
2001 missing.param.auth 缺少验签参数
2002 invalid.auth.state 认证未通过
2002 auth.fail 验签失败
2003 query.account.list.error 查询账户列表失败
4000 too.many.request 客户端上行请求限频
4000 too.many.connection 同一个key的建联数量

订阅订单更新

API Key 权限：读取

订单的更新推送由任一以下事件触发：

不同事件类型所推送的消息中，字段列表略有不同。开发者可以采取以下两种方式设计返回的数据结构：

订阅主题

orders#${symbol}

订阅参数

Subscribe request

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

Response

{
    "action": "sub",
    "code": 200,
    "ch": "orders#btcusdt",
    "data": {}
}
参数 数据类型 描述
symbol string 交易代码（支持通配符 * ）

数据更新字段列表

Update example

{
    "action":"push",
    "ch":"orders#btcusdt",
    "data":
    {
        "orderSide":"buy",
        "lastActTime":1583853365586,
        "clientOrderId":"abc123",
        "orderStatus":"rejected",
        "symbol":"btcusdt",
        "eventType":"trigger",
        "errCode": 2002,
        "errMessage":"invalid.client.order.id (NT)"
    }
}

当计划委托/追踪委托触发失败后 –

字段 数据类型 描述
eventType string 事件类型，有效值：trigger（本事件仅对计划委托/追踪委托有效）
symbol string 交易代码
clientOrderId string 用户自编订单号
orderSide string 订单方向，有效值：buy,sell
orderStatus string 订单状态，有效值：rejected
errCode int 订单触发失败错误码
errMessage string 订单触发失败错误消息
lastActTime long 订单触发失败时间

Update example

{
    "action":"push",
    "ch":"orders#btcusdt",
    "data":
    {
        "orderSide":"buy",
        "lastActTime":1583853365586,
        "clientOrderId":"abc123",
        "orderStatus":"canceled",
        "symbol":"btcusdt",
        "eventType":"deletion"
    }
}

当计划委托/追踪委托在触发前被撤销后 –

字段 数据类型 描述
eventType string 事件类型，有效值：deletion（本事件仅对计划委托/追踪委托有效）
symbol string 交易代码
clientOrderId string 用户自编订单号
orderSide string 订单方向，有效值：buy,sell
orderStatus string 订单状态，有效值：canceled
lastActTime long 订单撤销时间

Update example

{
    "action":"push",
    "ch":"orders#btcusdt",
    "data":
    {
        "orderSize":"2.000000000000000000",
        "orderCreateTime":1583853365586,
        "accountId":992701,
        "orderPrice":"77.000000000000000000",
        "type":"sell-limit",
        "orderId":27163533,
        "clientOrderId":"abc123",
        "orderStatus":"submitted",
        "symbol":"btcusdt",
        "eventType":"creation"
    }
}

当订单挂单后 –

字段 数据类型 描述
eventType string 事件类型，有效值：creation
symbol string 交易代码
accountId long 账户ID
orderId long 订单ID
clientOrderId string 用户自编订单号（如有）
orderPrice string 订单价格
orderSize string 订单数量（对市价买单无效）
orderValue string 订单金额（仅对市价买单有效）
type string 订单类型，有效值：buy-market, sell-market, buy-limit, sell-limit, buy-limit-maker, sell-limit-maker, buy-ioc, sell-ioc
orderStatus string 订单状态，有效值：submitted
orderCreateTime long 订单创建时间

注：

Update example

{
    "action":"push",
    "ch":"orders#btcusdt",
    "data":
    {
        "tradePrice":"76.000000000000000000",
        "tradeVolume":"1.013157894736842100",
        "tradeId":301,
        "tradeTime":1583854188883,
        "aggressor":true,
        "remainAmt":"0.000000000000000400000000000000000000",
        "orderId":27163536,
        "type":"sell-limit",
        "clientOrderId":"abc123",
        "orderStatus":"filled",
        "symbol":"btcusdt",
        "eventType":"trade"
    }
}

当订单成交后 –

字段 数据类型 描述
eventType string 事件类型，有效值：trade
symbol string 交易代码
tradePrice string 成交价
tradeVolume string 成交量
orderId long 订单ID
type string 订单类型，有效值：buy-market, sell-market, buy-limit, sell-limit, buy-limit-maker, sell-limit-maker, buy-ioc, sell-ioc
clientOrderId string 用户自编订单号（如有）
tradeId long 成交ID
tradeTime long 成交时间
aggressor bool 是否交易主动方，有效值： true (taker), false (maker)
orderStatus string 订单状态，有效值：partial-filled, filled
remainAmt string 未成交数量（市价买单为未成交金额）

注：

Update example

{
    "action":"push",
    "ch":"orders#btcusdt",
    "data":
    {
        "lastActTime":1583853475406,
        "remainAmt":"2.000000000000000000",
        "orderId":27163533,
        "type":"sell-limit",
        "clientOrderId":"abc123",
        "orderStatus":"canceled",
        "symbol":"btcusdt",
        "eventType":"cancellation"
    }
}

当订单被撤销后 –

字段 数据类型 描述
eventType string 事件类型，有效值：cancellation
symbol string 交易代码
orderId long 订单ID
type string 订单类型，有效值：buy-market, sell-market, buy-limit, sell-limit, buy-limit-maker, sell-limit-maker, buy-ioc, sell-ioc
clientOrderId string 用户自编订单号（如有）
orderStatus string 订单状态，有效值：partial-canceled, canceled
remainAmt string 未成交数量（市价买单为未成交金额）
lastActTime long 订单最近更新时间

注：

订阅清算后成交及撤单更新

API Key 权限：读取

仅当用户订单成交或撤销时推送。其中，订单成交为逐笔推送，如一张 taker 订单同时与多张 maker 订单成交，该接口将推送逐笔更新。但用户收到的这几笔成交消息的次序，有可能与实际的成交次序不完全一致。另外，如果一张订单的成交及撤销几乎同时发生，例如 IOC 订单成交后剩余部分被自动撤销，用户可能会先收到撤单推送，再收到成交推送。

如用户需要获取依次更新的订单推送，建议订阅另一频道 orders#${symbol}。

订阅主题

trade.clearing#${symbol}#${mode}

订阅参数

参数 数据类型 是否必需 描述
symbol string TRUE 交易代码（支持通配符 * ）
mode int FALSE 推送模式（0 - 仅在订单成交时推送；1 - 在订单成交、撤销时均推送；缺省值：0）

注：
可选订阅参数 mode，如不填或填0，仅推送成交事件；如填1，推送成交及撤销事件。

Subscribe request

{
    "action": "sub",
    "ch": "trade.clearing#btcusdt#0"
}

Response

{
    "action": "sub",
    "code": 200,
    "ch": "trade.clearing#btcusdt#0",
    "data": {}
}

Update example

{
    "ch": "trade.clearing#btcusdt#0",
    "data": {
         "eventType": "trade",
         "symbol": "btcusdt",
         "orderId": 99998888,
         "tradePrice": "9999.99",
         "tradeVolume": "0.96",
         "orderSide": "buy",
         "aggressor": true,
         "tradeId": 919219323232,
         "tradeTime": 998787897878,
         "transactFee": "19.88",
         "feeDeduct ": "0",
         "feeDeductType": "",
         "feeCurrency": "btc",
         "accountId": 9912791,
         "source": "spot-api",
         "orderPrice": "10000",
         "orderSize": "1",
         "clientOrderId": "a001",
         "orderCreateTime": 998787897878,
         "orderStatus": "partial-filled"
    }
}

数据更新字段列表（当订单成交后）

字段 数据类型 描述
eventType string 事件类型（trade）
symbol string 交易代码
orderId long 订单ID
tradePrice string 成交价
tradeVolume string 成交量
orderSide string 订单方向，有效值： buy, sell
orderType string 订单类型，有效值： buy-market, sell-market,buy-limit,sell-limit,buy-ioc,sell-ioc,buy-limit-maker,sell-limit-maker,buy-stop-limit,sell-stop-limit
aggressor bool 是否交易主动方，有效值： true, false
tradeId long 交易ID
tradeTime long 成交时间，unix time in millisecond
transactFee string 交易手续费（正值）或交易手续费返佣（负值）
feeCurrency string 交易手续费或交易手续费返佣币种（买单的交易手续费币种为基础币种，卖单的交易手续费币种为计价币种；买单的交易手续费返佣币种为计价币种，卖单的交易手续费返佣币种为基础币种）
feeDeduct string 交易手续费抵扣
feeDeductType string 交易手续费抵扣类型，有效值： ht, point
accountId long 账户编号
source string 订单来源
orderPrice string 订单价格 （市价单无此字段）
orderSize string 订单数量（市价买单无此字段）
orderValue string 订单金额（仅市价买单有此字段）
clientOrderId string 用户自编订单号
stopPrice string 订单触发价（仅止盈止损订单有此字段）
operator string 订单触发方向（仅止盈止损订单有此字段）
orderCreateTime long 订单创建时间
orderStatus string 订单状态，有效值：filled, partial-filled

注：

数据更新字段列表（当订单撤销后）

字段 数据类型 描述
eventType string 事件类型（cancellation）
symbol string 交易代码
orderId long 订单ID
orderSide string 订单方向，有效值： buy, sell
orderType string 订单类型，有效值： buy-market, sell-market,buy-limit,sell-limit,buy-ioc,sell-ioc,buy-limit-maker,sell-limit-maker,buy-stop-limit,sell-stop-limit
accountId long 账户编号
source string 订单来源
orderPrice string 订单价格 （市价单无此字段）
orderSize string 订单数量（市价买单无此字段）
orderValue string 订单金额（仅市价买单有此字段）
clientOrderId string 用户自编订单号
stopPrice string 订单触发价（仅止盈止损订单有此字段）
operator string 订单触发方向（仅止盈止损订单有此字段）
orderCreateTime long 订单创建时间
remainAmt string 未成交量（对于市价买单，该字段定义为未成交额）
orderStatus string 订单状态，有效值：canceled, partial-canceled

订阅账户变更

API Key 权限：读取

订阅账户下的订单更新。

订阅主题

accounts.update#${mode}

用户可选择以下任一账户变更推送的触发方式

1、仅在账户余额发生变动时推送；

2、在账户余额发生变动或可用余额发生变动时均推送，且分别推送。

订阅参数

参数 数据类型 描述
mode integer 推送方式，有效值：0, 1，默认值：0

订阅示例
1、不填mode：
accounts.update
仅当账户余额变动时推送；
2、填写mode=0：
accounts.update#0
仅当账户余额变动时推送；
3、填写mode=1：
accounts.update#1
在账户余额发生变动或可用余额发生变动时均推送且分别推送。

注：无论用户采用哪种模式订阅，在订阅成功后，服务器将首先推送当前各账户的账户余额与可用余额，然后再推送后续的账户更新。在首推各账户初始值时，消息中的changeType和changeTime的值为null。

Subscribe request

{
    "action": "sub",
    "ch": "accounts.update"
}

Response

{
    "action": "sub",
    "code": 200,
    "ch": "accounts.update#0",
    "data": {}
}

Update example

accounts.update#0：
{
    "action": "push",
    "ch": "accounts.update#0",
    "data": {
        "currency": "btc",
        "accountId": 123456,
        "balance": "23.111",
        "changeType": "transfer",
            "accountType":"trade",
        "changeTime": 1568601800000
    }
}

accounts.update#1：
{
    "action": "push",
    "ch": "accounts.update#1",
    "data": {
        "currency": "btc",
        "accountId": 33385,
        "available": "2028.699426619837209087",
        "changeType": "order.match",
                "accountType":"trade",
        "changeTime": 1574393385167
    }
}
{
    "action": "push",
    "ch": "accounts.update#1",
    "data": {
        "currency": "btc",
        "accountId": 33385,
        "balance": "2065.100267619837209301",
        "changeType": "order.match",
            "accountType":"trade",
        "changeTime": 1574393385122
    }
}

数据更新字段列表

字段 数据类型 描述
currency string 币种
accountId long 账户ID
balance string 账户余额（仅当账户余额发生变动时推送）
available string 可用余额（仅当可用余额发生变动时推送）
changeType string 余额变动类型，有效值：order-place(订单创建)，order-match(订单成交)，order-refund(订单成交退款)，order-cancel(订单撤销)，order-fee-refund(抵扣交易手续费)
accountType string 账户类型，有效值：trade, frozen, loan, interest
changeTime long 余额变动时间，unix time in millisecond

注：
账户更新推送的是到账金额，多笔成交产生的多笔交易返佣可能会合并到帐。






json