Skip to Content

Status events

Watch stream health and continuity through explicit status event frames.

Status events tell you when the stream hits continuity gaps, backpressure overflow, degraded sources, or a source switch. Use them to make retry or fallback decisions without guessing from missing data alone.

Back to Market WebSocket

Access

  • Surfaces: ws
  • Metering: ws_target_minute
  • Scope: Stream health · DEX · EVM family primary · Solana (Beta)

Handles

SurfaceLabelValue
wsEvent typeSESSION_GAP_DETECTED
wsEvent typeSESSION_BACKPRESSURE_OVERFLOW
wsEvent typeSOURCE_DEGRADED
wsEvent typeSOURCE_SWITCHED

Status event example

{ "event_type": "SESSION_GAP_DETECTED", "session_id": "sess_live_001", "sequence": 8, "target_id": "0xC02aaA39b223FE8D0A0E5C4F27eAD9083C756Cc2", "market_kind": "dex", "chain": "ethereum", "source_id": "multi-source-kline", "source_publish_ts": "2026-04-15T08:00:06Z", "gateway_ingest_ts": "2026-04-15T08:00:06.005Z", "gateway_send_ts": "2026-04-15T08:00:06.010Z", "freshness_ms": 10, "payload": { "continuity_state": "gap_detected", "missed_sequence_count": 2, "reconnect_mode": "resume" } }

Request fields

Subscribe frame

FieldTypeRequiredNotes
actionstringRequiredUse `subscribe`.
profilestringOptionalOptional delivery profile. Omit it to use the current default `standard` profile.
targetsarrayRequiredOne or more market targets to stream.

Target fields

FieldTypeRequiredNotes
targets[].market_kindstringRequiredUse `dex` for the public WebSocket target shape.
targets[].target_idstringRequiredToken or market target id.
targets[].chainstringRequiredTarget chain. Prefer the current EVM family such as `ethereum` or `base`; use `solana` only for the separate Beta lane.
targets[].event_familystringRequiredStream family such as `price` or `short_range_ohlcv`.
targets[].base_assetstringOptionalBase asset label shown in the payload.
targets[].quote_assetstringOptionalQuote asset label shown in the payload.
targets[].intervalstringOptionalOHLCV interval such as `1m`.

Response fields

Event envelope

FieldTypeNotes
event_typestringEvent type for the current frame.
session_idstringServer-issued stream id for the current connection.
sequencenumberMonotonic event order for the session.
target_idstringTarget id for the active stream.
market_kindstringMarket family. Public WebSocket uses `dex`.
chainstringTarget chain.
source_idstringSource label for the current event.
source_publish_tsstringSource publish timestamp.
gateway_ingest_tsstringTimestamp when the gateway received the event.
gateway_send_tsstringTimestamp when the gateway sent the event.
freshness_msnumberElapsed time from source publish to gateway send.
payloadobjectEvent-specific payload.

Gap and continuity payload

FieldTypeNotes
payload.continuity_statestringContinuity status such as `gap_detected`.
payload.missed_sequence_countnumberNumber of missed sequence values when a gap is detected.
payload.reconnect_modestringSuggested reconnect mode for gap handling.

Backpressure and source payload

FieldTypeNotes
payload.overflow_behaviorstringOverflow behavior when the stream cannot keep up.
payload.source_statestringSource status such as `degraded` or `switched`.
payload.previous_source_idstringPrevious source id when the gateway switches sources.
Last updated on