訂閱WebSocket

警告

請注意，目前copytrading只支持正向永續，以下接口僅適用於 正向永續

訂閱地址:
測試網:

• 公有頻道: wss://stream-testnet.bybit.com/contract/usdt/public/v3
• 私有頻道: wss://stream-testnet.bybit.com/realtime_private

主網:

• 公有頻道: wss://stream.bybit.com/contract/usdt/public/v3
• 私有頻道: wss://stream.bybit.com/realtime_private

信息

公有頻道不需要鑒權. 以下內容僅適用於私有頻道的訂閱

構建連接時，創建鑒權請求。

注意: 如果您正在使用pybit, bybit-api或者其他第三方庫, 您可以忽略此項-因為鑒權已經內建。

{
    "op": "auth",
    "args": [
        "api_key",
        1662350400000, //過期時間應當大於當前時間戳
        "singature"
    ]
}

# 基於: https://github.com/bybit-exchange/pybit/blob/master/pybit/_http_manager.py

import hmac
import json
import time
import websocket

api_key = ""
api_secret = ""

# 生成expires
expires = int((time.time() + 1) * 1000)

# 生成簽名
signature = str(hmac.new(
    bytes(api_secret, "utf-8"),
    bytes(f"GET/realtime{expires}", "utf-8"), digestmod="sha256"
).hexdigest())

ws = websocket.WebSocketApp(
    url=url,
    ...
)

# 發送鑒權請求
ws.send(
    json.dumps({
        "op": "auth",
        "args": [api_key, expires, signature]
    })
)

鑒權成功的響應示例

{
    "success": true,
    "ret_msg": "",
    "conn_id": "16c79bf6-267d-4e06-a0c1-3ca4ed3a293d",
    "request": {
        "op": "auth",
        "args": [
            "OZUDHROKUZZNVZWHKN",
            "1673261297304",
            "63ae5f1064130d8e931b5d937500461b87c00b2a939284e455fe8ea1e27387f6"
        ]
    }
}

信息

簽名生成的示例可以參考這裡。

警告

由於網絡的複雜性，您可能隨時遇到斷連。請參考以下建議確保您能即時接收到推送：

1. 通過發送心跳
2. 遇到斷連時，立即重新連接

IP限頻

• 不要嘗試頻繁地構建連接與斷開連接；
• 不要在5分鐘內構建超過500個連接。

如何發送心跳

發送ping的示例

ws.send('{"op":"ping"}');

接收到pong的響應示例

// 公共頻道的Pong示例
{
    "success": true,
    "ret_msg": "pong",
    "conn_id": "13271fcb-53ed-4e80-948e-2bdbe3a6587d",
    "req_id": "",
    "op": "ping"
}

// 私有頻道的Pong示例
{
    "success": true,
    "ret_msg": "pong",
    "conn_id": "16c79bf6-267d-4e06-a0c1-3ca4ed3a293d",
    "request": {
        "op": "ping",
        "args": null
    }
}

警告

為了維持連接，我們推薦您每20秒發送一次心跳。

如何訂閱topic

理解Websocket裡的args

通過傳入args來訂閱指定topic

{
    "req_id": "test", // 可選
    "op": "subscribe",
    "args": [
        "orderbook.1.BTCUSDT"
    ]
}

通過","來訂閱同一個topic下的多個交易對

// 示例: 訂閱trade下的BTCUSDT和ETHUSDT
{
    "req_id": "test", // 可選
    "op": "subscribe",
    "args": [
        "publicTrade.BTCUSDT",
        "publicTrade.ETHUSDT"
    ]
}

訂閱多個topic

ws.send('{"op": "subscribe", "args": ["orderbook.1.BTCUSDT","publicTrade.BTCUSDT","orderbook.1.ETHUSDT]}')

理解如何取消訂閱

您可以通過發送請求來動態地停止訂閱

ws.send('{"op": "unsubscribe", "args": ["publicTrade.BTCUSDT"]}');

{
    "op": "unsubscribe",
    "args": [
        "publicTrade.BTCUSDT"
    ]
}

理解訂閱的響應

訂閱成功後的響應示例

// 公共頻道的訂閱響應
{
    "success": true,
    "ret_msg": "",
    "conn_id": "322b49ce-d6a5-494a-9019-f1d51cd541ae",
    "req_id": "",
    "op": "subscribe"
}

// 私有頻道的訂閱響應
{
    "success": true,
    "ret_msg": "",
    "conn_id": "16c79bf6-267d-4e06-a0c1-3ca4ed3a293d",
    "request": {
        "op": "subscribe",
        "args": [
            "copyTradePosition",
            "copyTradeOrder",
            "copyTradeExecution"
        ]
    }
}

訂閱成功後，您將收到結果信息。可以根據響應判斷訂閱是否成功。