WebSocket API 基本用法

链接

现货 WebSocket API

wss://stream.bittap.com/endpoint?format=JSON

请求格式

所有发送到 WebSocket API 的请求都必须是 JSON 格式，并包含以下字段：

• id: 请求的唯一标识符，用于将响应与请求对应起来。
• method: 要调用的方法名称，SUBSCRIBE/UNSUBSCRIBE。
• params: (可选) 方法的参数，一个 JSON 数组对象。

请求示例

{
  "id": "187d3cb2-942d-484c-8271-4e2141bbadb1",
  "method": "SUBSCRIBE",
  "params": ["s_trade@BTCUSDT"]
}

请求鉴权类型

每个方法都有一个鉴权类型，指示所需的 API 密钥权限，显示在方法名称旁边（例如，下新订单 (TRADE)）。 如果未指定，则鉴权类型为 NONE 。

除了为 NONE 外，所有具有鉴权类型的方法均视为 SIGNED 请求（即包含 signature ），listenKey 管理 除外。 具有鉴权类型的方法需要提供有效的 API 密钥并验证通过。

API 密钥可在您的 BitTap 账户的 API 管理 页面创建。 API 密钥和密钥对均为敏感信息，切勿与他人分享。 如果发现账户有异常活动，请立即撤销所有密钥并联系 BitTap 支持。

API 密钥可配置为仅允许访问某些鉴权类型。 例如，您可以拥有具有 TRADE 权限的 API 密钥用于交易， 同时使用具有 USER_DATA 权限的另一个 API 密钥来监控订单状态。 默认情况下，API 密钥无法进行 TRADE ，您需要先在 API 管理中启用交易权限。

常用请求信息

测试连通性

{
  "id": "922bcc6e-9de8-440d-9e84-7c80933a8d0d",
  "method": "PING"
}

测试能否联通 WebSocket API。

注意: 您也可以使用常规 WebSocket ping 帧来测试连通性， WebSocket API 将尽快以 pong 帧响应。 ping 请求和 time 是在应用程序中测试请求-响应处理的安全方法。

参数: NONE

数据源: 缓存

响应:

{
  "id": "922bcc6e-9de8-440d-9e84-7c80933a8d0d",
  "type": "ACK"
}

检查服务器时间

{
  "id": "187d3cb2-942d-484c-8271-4e2141bbadb1",
  "method": "time"
}

测试与 WebSocket API 的连通性并获取当前服务器时间。

参数: NONE

数据源: 缓存

响应:

{
  "id": "187d3cb2-942d-484c-8271-4e2141bbadb1",
  "status": 200,
  "result": {
    "serverTime": 1656400526260
  }
}

订阅一个信息流

请求示例

{
  "method": "SUBSCRIBE",
  "params": [
    "s_trade@BTCUSDT",
    "s_depth30@BTCUSDT_0.01"
  ],
  "id": 1
}

响应示例

{
  "code": 0, // 0代表成功 非0代表失败
  "msg":"", // 失败原因 成功时值为null
  "topic": ["", ""], // 订阅失败的topic
  "id": 1
}