API Reference
Pricing
API Reference

基础介绍

基础地址

wss://open-ws.coinglass.com/ws-api

连接方式

要建立连接,请使用以下地址并附带您的 API Key:

wss://open-ws.coinglass.com/ws-api?cg-api-key={your_api_key}

连接管理

  • 如果发生网络问题,系统将自动断开连接。
  • 为了保持连接的稳定性,建议每 20 秒发送一次 'ping' 消息,并预期收到 'pong' 响应。

订阅

如需订阅某个频道,请发送以下消息:

{
    "method": "subscribe",
    "channels": ["liquidationOrders"]
}

取消订阅

如需取消订阅某个频道,请发送以下消息:

{
    "method": "unsubscribe",
    "channels": ["liquidationOrders"]
}

响应示例

当收到数据时,响应格式如下所示:

{
    "channel": "liquidationOrders",
    "data": [
        {
            "baseAsset": "BTC",
            "exName": "Binance",
            "price": 56738.00,
            "side": 2,
            "symbol": "BTCUSDT",
            "time": 1725416318379,
            "volUsd": 3858.18400
        }
    ]
}

该格式可确保在使用 WebSocket API 交互时的清晰性与易用性。