Ws

快速入门

Restful API

公共接口

用户接口

订单接口

WebSocket API

WebSocket接入说明

公共接口

用户接口

订单接口

WebSocket API说明

• 本篇所列出的 wss 接口的 base URL：wss://openapi.bitunix.com:443/ws-api/v1
• 除非特别说明，时间戳均为毫秒级时间戳
• 所有字段名称和值都大小写敏感
• websocket连接有效期为24小时，请注意处理断开场景下的重连问题

请求格式

WebSocket API请求必须在text帧中以Json格式传输，一个text帧消息代表一次请求，示例：

{
  "id": "2d812f20c9e1030f5551eab0e039f613",
  "method": "market.last_price",
  "params": {
    "symbol": "BTC",
    "nonce" "17832",
    "timestamp": "1724285700000",
    "apiKey": "9a25209b66004da404d9ddcb48d1e11f",
    "sign": "477eda21f570dd4e2f7392b729254d12bc2d403d1150d0b6cfdb52191267550c"
  }
}

字段说明

名称	类型	必须	备注
id	int/string/null	Y	请求ID，用于匹配对应请求的响应
method	string	Y	请求方法
params	object	Y	请求参数

• id 字段可以是任意字符串、数字、时间戳等，用于标识请求，响应中会原样返回
• method 字段为请求方法
• params 字段为请求参数，根据不同的请求方法，参数不同，顺序不限

响应格式

WebSocket API响应在text帧中以Json格式返回，一个text帧消息代表一次响应。 * 成功响应示例：

{
"id": "2d812f20c9e1030f5551eab0e039f613",
"code": "0",
"msg": "success",
"data": "10000.00"
}

• 失败响应示例：

{
"id": "2d812f20c9e1030f5551eab0e039f613",
"code": "1",
"msg": "invalid symbol",
"data": null
}

字段说明

名称	类型	必须	备注
id	int/string/null	Y	请求ID
code	string	Y	响应码，成功为"0"，其他响应码均为错误码
msg	string	Y	响应描述
data	object	N	返回数据，根据不同的请求方法，数据不同，可能为空

身份验证

WebSocket API请求需要进行身份验证，在所有的请求参数中需要包含以下字段：

名称	类型	必须	备注
apiKey	string	Y	API Key
timestamp	string	Y	时间戳
nonce	string	Y	随机字符串
sign	string	Y	签名字符串，参见签名

连接测试

WebSocket API连接测试，可以通过以下方式进行测试：

{
  "id": "2d812f20c9e1030f5551eab0e039f613",
  "method": "ping",
  "params": {
    "nonce": "17832",
    "timestamp": "1724285700000",
    "apiKey": "9a25209b66004da404d9ddcb48d1e11f",
    "sign": "--signature here--"
    }
}