AsyncAPI channel · CryptoCompare
· CryptoCompare Streaming API
/
The root WebSocket channel multiplexes every subscription and every
control envelope. Clients publish `SubAdd`/`SubRemove` action messages
and subscribe to the union of welcome, lifecycle, heartbeat, error,
and data envelopes the server emits.
Send a SubAdd or SubRemove action to manage subscriptions.
subscribe
serverEvents
Receive welcome, lifecycle, heartbeat, error, and data envelopes.
Messages
SubAdd
Add one or more subscriptions to the current socket.
Content-Type: application/json
SubRemove
Remove one or more subscriptions from the current socket.
Content-Type: application/json
StreamerWelcome
First frame sent after a successful socket upgrade.
Content-Type: application/json
SubscribeComplete
Subscription done and first payload sent.
Content-Type: application/json
LoadComplete
All subscriptions done and all payloads sent.
Content-Type: application/json
UnsubscribeComplete
Subscription removal done.
Content-Type: application/json
UnsubscribeAllComplete
All subscription removals done.
Content-Type: application/json
Heartbeat
Liveness ping sent by the server every 30-60 seconds.
Content-Type: application/json
Unauthorized
API key missing, invalid, or lacks access to a requested channel.
Content-Type: application/json
RateLimit
Socket open / subscription rate-limit notice.
Content-Type: application/json
ServerError
Invalid JSON, invalid subscription, or forced disconnect notices.
Content-Type: application/json
Trade
A single trade reported by an exchange.
Content-Type: application/json
Ticker
Per-exchange ticker snapshot and delta.
Content-Type: application/json
AggregateIndex
CryptoCompare CCCAGG (or other index family) update.
Content-Type: application/json
OrderbookL2Update
Single-position delta to a level-2 order book.
Content-Type: application/json
OrderbookL2Snapshot
Full level-2 order book snapshot at subscribe time.
Content-Type: application/json
FullVolume
Rolling 24-hour total volume across all markets for a base.
Content-Type: application/json
TopTierFullVolume
Rolling 24-hour total volume across top tier exchanges (AA/A/B).
Content-Type: application/json
OHLCCandles
Streaming minute / hour / day OHLCV candle updates.
Content-Type: application/json
TopOfBook
Best bid / best ask updates for a market.
Content-Type: application/json
About AsyncAPI
The AsyncAPI specification describes event-driven APIs the way OpenAPI describes request/response APIs. A channel is the named pipe — a webhook URL, a Kafka topic, a WebSocket route, an MQTT subject — that producers and consumers publish or subscribe to. Each channel carries one or more messages with structured payloads, and an operation declares whether a given party sends or receives on that channel.
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.