WebSocket 流

连接超时

- 服务器在 60 秒不活动后关闭 WebSocket 连接（连接保持）

- 不活动定义为客户端没有发送请求

连接保持

为了保持 WebSocket 连接处于活动状态，您需要

- 每 50 秒发送一次定期请求

- 正确处理应用程序逻辑中的潜在断开连接

授权

介绍

在签署任何 WebSocket 请求之前，您必须在 Cryptomus 个人帐户中创建一个 API 密钥

提供了创建 API 密钥的详细说明这里

获取用于连接的一次性令牌

在连接到 WebSocket 服务器之前，您需要获取一次性身份验证令牌

您可以通过发送相应的请求

令牌有效期为 5 分钟或直到第一次成功连接

连接到 WebSocket 服务器

1. 获得一次性身份验证令牌

2. 建立连接时在查询参数token中指定token

连接 URL 示例: wss://api-ws.cryptomus.com/ws?token=b0b1cacd26993392ecf072155bd1686c96e380ad12cefa564aa6665c85c77334

该令牌只能使用一次。对于每个新连接，都需要请求新的令牌

令牌验证成功后，将建立连接，您可以订阅可用的频道

获取 WebSocket 连接的一次性身份验证令牌

允许生成用于连接 WebSocket 服务器的一次性身份验证令牌。该令牌有效期至首次成功连接或过期（5 分钟）。

GET

/v2/user-api/exchange/account/web-socket/token

复制

授权标头

可以获得所需授权标头的完整信息这里

{ "token": "168b34a3a12370740ff1654f0d0c4726ff1bba8c4675edc0d7553f15e5a2a094" }

复制

可能的代码

200：订单创建成功

404：未找到用户或资源

500：服务器内部错误

深度尺度的符号

要求

GET

https://exchange-ws.cryptomus.com/api/v2/symbol-scales?symbol={symbol}

复制


1{
2  "status": "success",
3  "message": "success",
4  "data": [
5    {
6      "scale": "0.01",
7      "index": 0 // index
8    },
9    ...
10  ]
11}

复制

市场清单

要求

GET

https://api-app.cryptomus.com/v1/exchange/market

复制


1{
2  "result": [
3    {
4      "id": "01HSBPVS17CT2GN2FV34K3AMP9",
5      "symbol": "BTC_USDT",
6      "baseCurrency": "BTC",
7      "quoteCurrency": "USDT",
8      "baseMinSize": "0.0000100000000000",
9      "quoteMinSize": "0.1000000000000000",
10      "baseMaxSize": "10000000000.0000000000000000",
11      "quoteMaxSize": "99999999.0000000000000000",
12      "basePrec": "8",
13      "quotePrec": "6",
14      "baseCurrencyFullName": "Bitcoin",
15      "quoteCurrencyFullName": "Tether USD"
16    },
17    ...
18  ]
19}

复制

示例实现

Node.js


1const WebSocket = require('ws');
2
3class CryptomusWebSocket {
4    constructor(token) {
5        this.token = token;
6        this.socket = new WebSocket('wss://api-ws.cryptomus.com/ws?token=${this.token}');
7        this.setupConnection();
8    }
9
10    setupConnection() {
11        this.socket.on('open', () => {
12            console.log('Connected to Cryptomus WebSocket');
13            this.startPing();
14        });
15
16        this.socket.on('message', (data) => {
17            console.log('Received:', data.toString());
18        });
19    }
20
21    ping() {
22        if (this.socket.readyState === WebSocket.OPEN) {
23            this.socket.send(JSON.stringify({
24                id: 0,
25                method: "ping",
26                params: []
27            }));
28        }
29    }
30
31    startPing() {
32        setInterval(() => {
33            this.ping();
34        }, 50 * 1000); // Every 50 seconds
35    }
36}
37
38// Usage
39const token = "your_auth_token_here";
40const client = new CryptomusWebSocket(token);
41

复制

Python


1import asyncio
2import websockets
3import json
4
5class CryptomusWebSocket:
6    def __init__(self, token):
7        self.token = token
8        self.socket = None
9    
10    async def connect(self):
11        self.socket = await websockets.connect(f"wss://api-ws.cryptomus.com/ws?token={self.token}")
12        print('Connected to Cryptomus WebSocket')
13    
14    async def ping(self):
15        await self.socket.send(json.dumps({
16            "id": 0,
17            "method": "ping",
18            "params": []
19        }))
20    
21    async def start_ping(self):
22        while True:
23            await asyncio.sleep(50)  # Every 50 seconds
24            await self.ping()
25    
26    async def listen(self):
27        async for message in self.socket:
28            print(f"Received: {message}")
29    
30    async def run(self):
31        await self.connect()
32        
33        # Start ping task
34        ping_task = asyncio.create_task(self.start_ping())
35        
36        # Listen for messages
37        await self.listen()
38
39# Usage
40token = "your_auth_token_here"
41client = CryptomusWebSocket(token)
42asyncio.run(client.run())
43

复制

所有端点都以 Unix 时间戳格式返回时间

请求消息结构

姓名	参数类型	定义
id	Integer	应该是唯一的，以处理对您的请求的响应
method	String	请求名称
params	Array	在此处传递方法的参数

参数类型

Integer

定义

应该是唯一的，以处理对您的请求的响应

参数类型

String

定义

请求名称

参数类型

Array

定义

在此处传递方法的参数

如果发送了无效的 JSON，WebSocket 连接将被终止

消息和请求类型

- 请求（“ping”、“candles_request”等）

- 订阅（`candles_subscribe`、`lastprice_subscribe` 等）。重新订阅相同数据类型将被取消。

响应消息

姓名	参数类型	定义
id	Integer	请求标识符
data	Null	如果请求失败。如果成功，则每个方法的响应结构如下所示
error	Null	如果成功。如果出现错误
message	String
code	Integer	错误代码

参数类型

Integer

定义

请求标识符

参数类型

Null

定义

如果请求失败。如果成功，则每个方法的响应结构如下所示

参数类型

Null

定义

如果成功。如果出现错误

参数类型

Integer

定义

错误代码

代码：1. 消息：无效的消息格式

代码：2. 消息：其他错误

响应消息类型

- 查询结果

- 订阅状态（成功/失败）

- 更新事件

乒乓球

平


1{    
2  "id": 0,   
3  "method": "ping",   
4  "params": []
5} 
6

复制

响应乒乓


1{
2  "id": 0,
3  "method": "pong",
4  "data": null,
5  "error": null
6}         
7

复制

订阅示例

要求


1{    
2  "id": 0,    
3  "method": "trade_subscribe",    
4  "params": [  
5      "BTC_USDT"    
6  ]
7}            
8

复制


1{    
2  "id": 0,    
3  "method": "trade_subscribe",  
4  "data": {       
5	  "status": "success"    
6  },    
7  "error": null  
8} 
9

复制

更新事件


1{    
2  "id": 0,    
3  "method": "trade_update",    
4  "data": [], // See structure for each method below  
5  "error": null
6}  
7

复制

深度

事件


1{
2  "id": 0,
3  "method": "depth_update",
4  "data": {
5    "symbol": "BTC_USDT",
6    "timestamp": 1750952911,
7    "full_reload": false, // If false, it is a partial update, if true, it is a fully updated orderbook.
8    "scale_index": 0,
9    "asks": [
10      [
11        "107043.93", // price
12        "0.304313" // value
13      ]
14    ],
15    "bids": [
16      [
17        "106976.11",
18        "0" // for partial update - finished orders will be 0
19      ]
20    ]
21  },
22  "error": null
23} 
24

复制

取消订阅

要求


1{    
2  "id": 0,   
3  "method": "depth_unsubscribe",   
4  "params": [  
5    "BTC_USDT:0", // market:scale_index     
6    "ETH_USDT:1",      
7    ...    
8  ]
9}  
10

复制

取消订阅所有活动 depth_unsubscribe


1{    
2  "id": 0,   
3  "method": "depth_unsubscribe",   
4  "params": [  
5    "all" // This also works for other events    
6  ]
7}  
8

复制


1{    
2  "id": 0,    
3  "data": {      
4    "status": "success"    
5  },    
6  "error": null  
7}  
8

复制

股票代码

事件


1{
2  "id": 0,
3  "method": "ticker_update",
4  "data": {
5    "symbol": "BTC_USDT",
6    "timestamp": 1750953144,
7    "price": "107090.35",
8    "open": "107042.21",
9    "high": "108248.15",
10    "low": "106573.19",
11    "volume": "1531.027982",
12    "quote_volume": "164564314.80174687",
13    "price_change": "0.04"
14  },
15  "error": null
16} 
17

复制

取消订阅

要求


1{    
2  "id": 0,   
3  "method": "ticker_unsubscribe",   
4  "params": [  
5    "BTC_USDT",      // Market 
6    "ETH_USDT",       
7    ...    
8  ]
9} 
10

复制

取消订阅所有活动 ticker_unsubscribe


1{    
2  "id": 0,   
3  "method": "ticker_unsubscribe",   
4  "params": [  
5    "all" // This also works for other events    
6  ]
7} 
8

复制


1{    
2  "id": 0,    
3  "data": {      
4    "status": "success"    
5  },    
6  "error": null  
7}  
8

复制

交易

事件


1{
2  "id": 0,
3  "method": "trade_update",
4  "data": {
5    "symbol": "BTC_USDT",
6    "timestamp": 1750953177,
7    "trades": [
8      {
9        "price": 107100.01,
10        "quantity": 0.000254,
11        "timestamp": 1750953177,
12        "direction": "buy"
13      },
14      ...
15    ]
16  },
17  "error": null
18}
19

复制

取消订阅

要求


1{    
2  "id": 0,   
3  "method": "trade_unsubscribe",   
4  "params": [  
5    "BTC_USDT",    // Market   
6    "ETH_USDT",       
7    ...    
8  ]
9}  
10

复制

取消订阅所有活动 trade_unsubscribe


1{    
2  "id": 0,   
3  "method": "trade_unsubscribe",   
4  "params": [  
5    "all" // This also works for other events    
6  ]
7}  
8

复制


1{    
2  "id": 0,    
3  "data": {      
4    "status": "success"    
5  },    
6  "error": null  
7}  
8

复制

订单

订阅所有活动 order_subscribe


1{    
2  "id": 0,  
3  "method": "order_subscribe",    
4  "params": [      
5    "all" // This also works for other events    
6  ]
7}  
8

复制


1{    
2  "id": 0,    
3  "method": "order_subscribe",  
4  "data": {      
5    "status": "success"    
6  },    
7  "error": null 
8} 
9

复制

活动

订单已创建


1{
2  "id": "1",
3  "method": "order_update",
4  "data": {
5    "type": "created",
6    "info": {
7      "id": "01JYET5DQ772MPYHHE417FQF1J",
8      "symbol": "TRX_USDT",
9      "orderType": "limit",
10      "direction": "sell",
11      "price": "0.2200000000000000",
12      "quantity": "50.0000000000000000",
13      "value": "11.0000000000000000",
14      "filledQuantity": "0.0000000000000000",
15      "filledValue": "0.0000000000000000",
16      "clientOid": null,
17      "createTs": 1750696376
18    }
19  },    
20  "error": null 
21}
22

复制

订单已更新


1{
2  "id": "3",
3  "method": "order_update",
4  "data": {
5    "type": "updated",
6    "info": {
7      "id": "01JYET5DQ772MPYHHE417FQF1J",
8      "symbol": "TRX_USDT",
9      "orderType": "limit",
10      "direction": "sell",
11      "price": "0.2200000000000000",
12      "quantity": "50.0000000000000000",
13      "value": "11.0000000000000000",
14      "filledQuantity": "20.0000000000000000",
15      "filledValue": "4.4000000000000000",
16      "clientOid": null,
17      "createTs": 1750696376,
18      "updateTs": 1750696487,
19    }
20  },    
21  "error": null 
22}
23

复制

订单完成


1{
2  "id": "3",
3  "method": "order_update",
4  "data": {
5    "type": "finished",
6    "info": {
7      "id": "01JYET5DQ772MPYHHE417FQF1J",
8      "symbol": "TRX_USDT",
9      "orderType": "limit",
10      "direction": "sell",
11      "price": "0.2200000000000000",
12      "quantity": "50.0000000000000000",
13      "value": "11.0000000000000000",
14      "filledQuantity": "50.0000000000000000",
15      "filledValue": "11.0000000000000000",
16      "clientOid": null,
17      "createTs": 1750696376,
18      "finishTs": 1750696417,
19      "state": "completed""internalState": "filled"
20    }
21  },    
22  "error": null 
23}
24

复制

取消订阅更新

来自特定市场


1{    
2  "id": 0,   
3  "method": "order_unsubscribe",   
4  "params": [  
5    "BTC_USDT",   // Market    
6    "ETH_USDT",       
7    ...    
8  ]
9} 
10

复制

来自所有市场


1{    
2  "id": 0,   
3  "method": "order_unsubscribe",   
4  "params": [  
5    "all" // Optional, will also work if an empty array is passed in    
6  ]
7}  
8

复制


1{    
2  "id": 0,    
3  "data": {      
4    "status": "success"    
5  },    
6  "error": null   
7} 
8

复制

余额

订阅所有活动 balance_subscribe


1{    
2  "id": 0,  
3  "method": "balance_subscribe",    
4  "params": [       
5    "all" // This also works for other events    
6  ]
7}  
8

复制


1{    
2  "id": 0,    
3  "method": "balance_subscribe",  
4  "data": {      
5    "status": "success"    
6  },    
7  "error": null   
8}  
9

复制

活动


1{
2  "id": "4",
3  "method": "balance_update",
4  "data": {
5    "info": {
6      "walletId": "01J7E836F6K5KCX5DP2W0F6FAG",
7      "currencyCode": "USDT",
8      "amount": "50.0000000000000000",
9      "oldBalance": "40000.0000000000000000",
10      "newBalance": "39950.00000000"
11    }
12  },    
13  "error": null 
14}
15

复制

取消订阅事件

来自特定货币

基准货币来自 market-list


1{    
2  "id": 0,   
3  "method": "balance_unsubscribe",   
4  "params": [  
5    "BTC",       // BaseCurrency from market list
6    "ETH",       
7    ...    
8  ]
9}     
10

复制

来自所有货币


1{    
2  "id": 0,   
3  "method": "balance_unsubscribe",   
4  "params": [  
5    "all" // Optional, will also work if an empty array is passed in    
6  ]
7}   
8

复制


1{    
2  "id": 0,    
3  "data": {      
4    "status": "success"    
5  },    
6  "error": null   
7}  
8

复制

优惠信息

订阅所有活动 deal_subscribe


1{    
2  "id": 0,  
3  "method": "deal_subscribe",    
4  "params": [       
5    "all" // This also works for other events    
6  ]
7}  
8

复制


1{    
2  "id": 0,    
3  "data": {      
4    "status": "success"    
5  },    
6  "error": null  
7}
8

复制

活动


1{
2  "id": "4",
3  "method": "deal_update",
4  "data": {
5    "info": {
6      "dealId": "01JYH50V5VWPP3QTYGM6CPZ0AR",
7      "symbol": "TRX_USDT",
8      "dealState": "completed",
9      "transactionId": "01JYH50V5YM8M3943KJ9HY2VXM",
10      "filledPrice": "0.2726960000000000",
11      "filledQuantity": "100.0000000000000000",
12      "filledValue": "27.2696000000000000",
13      "fee": "1.0907840000000000",
14      "feeCurrency": "USDT",
15      "tradeRole": "taker",
16      "committedAt": 1750774869
17    }
18  },    
19  "error": null 
20}
21

复制

取消订阅更新

来自特定市场


1{    
2  "id": 0,   
3  "method": "deal_unsubscribe",   
4  "params": [  
5    "BTC_USDT",   // Market
6    "TRX_USDT,       
7    ...    
8  ]
9} 
10

复制

来自所有市场


1{    
2  "id": 0,   
3  "method": "deal_unsubscribe",   
4  "params": [  
5    "all" // Optional, will also work if an empty array is passed in    
6  ]
7} 
8

复制


1{    
2  "id": 0,    
3  "data": {      
4    "status": "success"    
5  },    
6  "error": null   
7} 
8

复制

WebSocket 流

连接超时

连接保持

授权

介绍

获取用于连接的一次性令牌

连接到 WebSocket 服务器

获取 WebSocket 连接的一次性身份验证令牌

授权标头

回复

深度尺度的符号

要求

回复

市场清单

要求

回复

示例实现

请求消息结构

消息和请求类型

响应消息

响应消息类型

乒乓球

平

响应乒乓

订阅示例

要求

回复

更新事件

最新价格

订阅

订阅所有活动 lastprice_subscribe

回复

事件

取消订阅

要求

取消订阅所有活动 lastprice_unsubscribe

回复

深度

订阅

订阅所有活动 depth_subscribe

回复

事件

取消订阅

要求

取消订阅所有活动 depth_unsubscribe

回复

股票代码

订阅

订阅所有活动 ticker_subscribe

回复

事件

取消订阅

要求

取消订阅所有活动 ticker_unsubscribe

回复

交易

订阅

订阅所有活动 trade_subscribe

回复

事件

取消订阅

要求

取消订阅所有活动 trade_unsubscribe

回复

订单

订阅

订阅所有活动 order_subscribe

回复

活动

订单已创建

订单已更新

订单完成

取消订阅更新

来自特定市场

来自所有市场

回复

余额

订阅

订阅所有活动 balance_subscribe

回复