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": "lastprice_subscribe",  
4  "data": {       
5    "status": "success"    
6  },    
7  "error": null  
8}   
9

複製

事件


1{
2  "id": 0,
3  "method": "lastprice_update",
4  "data": {
5    "symbol": "BTC_USDT",
6    "timestamp": 1750953362,
7    "price": "107152.55"
8  },
9  "error": null
10}
11

複製

取消訂閱

要求


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

複製

取消訂閱所有活動 lastprice_unsubscribe


1{    
2  "id": 0,   
3  "method": "lastprice_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}

複製

深度

回覆


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

複製

事件


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_subscribe",  
4  "data": {       
5    "status": "success"    
6  },    
7  "error": null  
8}  
9

複製

事件


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_subscribe",  
4  "data": {       
5    "status": "success"    
6  },    
7  "error": null  
8}  
9

複製

事件


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

回覆