Skip to main content
GET
WebSocket stream of Chainlink crypto prices

Authorizations

Authorization
string
header
required

Raw database-backed API key.

Query Parameters

symbols
string

Comma-separated btc, eth, sol, xrp, doge, and bnb; omit for all or use none for no initial subscription.

variants
string

Comma-separated spot, twap_30s, and twap_60s; omit for all. Cannot be combined with symbols=none.

api_key
string

API key for browser WebSocket handshakes. The Authorization header takes precedence and this value is redacted from logs.

Response

WebSocket established; subsequent text frames use the schema below.

A WebSocket text frame. Fields not applicable to its type are omitted.

type
enum<string>
required
Available options:
welcome,
snapshot,
price,
heartbeat,
subscribed,
unsubscribed,
subscription_snapshot,
error,
pong
server_time
string<date-time>
sequence
integer<int64>
subscriptions
object[]
added
object[]
removed
object[]
prices
object[]
missing
object[]
source
object
supported
object
limits
object
code
string
message
string
feed_id
string
symbol
string
asset
string
quote
string
variant
string
twap_window_seconds
integer
price
string
valid_from_ms
integer<int64>
observed_at_ms
integer<int64>
received_at_ms
integer<int64>