Getting Started

Connection URL

When connecting, append your API Key to the base URL:

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

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

Connecting and Subscribing

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

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

⚠️

Connection management

When a network problem occurs, the system automatically closes the connection. Handle reconnection in your code, and resend your subscribe messages after reconnecting. The connection URL contains your API Key, so open the connection on your server, not directly from a web page.

Available Channels

WebSocket channels require an API plan of Standard and above; for details, see API Plans and Permissions.

Response Example

When data arrives, the message contains the channel name channel and the data array data. Taking liquidation orders as an example:

{
    "channel": "liquidation_orders",
    "data": [
        {
            "base_asset": "BTC",
            "exchange": "Binance",
            "price": 56738.00,
            "side": 2,
            "symbol": "BTCUSDT",
            "time": 1725416318379,
            "volume_usd": 3858.18400
        }
    ]
}

For the fields in each channel's data, see the corresponding channel page.

Subscription Permission Rejections

An insufficient plan may produce a text message in the following format; do not assume every message is JSON:

<full subscription argument> need upgrade plan

The prefix is the full subscription argument and may include conditions after @. Match it to the original subscription rather than only the bare channel name. This rejection affects that subscription only and does not itself close the connection. Keep other successful subscriptions and avoid retrying the same unauthorized subscription indefinitely. Handle authentication failures, network interruptions and connection closure separately.

FAQ

Related Docs