WebSocket API

Ticker Channel

Top-of-book snapshot and updates for a market

Channel name: ticker

Subscription

{ "op": "sub", "channel": "ticker", "params": { "market": "BTC-PERP" } }

params.market is required.

Message Types

Snapshot

{
  "channel": "ticker",
  "filter": "BTC-PERP",
  "type": "snapshot",
  "data": {
    "bid": { "px": "50000.00", "sz": "1.5" },
    "ask": { "px": "50001.00", "sz": "1.2" }
  },
  "gsn": 12345,
  "ts": "1234567890000000000"
}

Update

Updates follow the same structure as snapshot messages.

Fields

FieldTypeDescription
filterstringMarket ID (e.g. "BTC-PERP")
data.bid.pxstringBest bid price
data.bid.szstringBest bid size
data.ask.pxstringBest ask price
data.ask.szstringBest ask size
gsnnumberGlobal sequence number
tsstringTimestamp in nanoseconds

Price level fields (px, sz) match the v1PriceLevel schema used in the REST Order Book response.

On this page