Skip to main content
The Intention WebSocket API exposes streaming subscriptions for market data and account events. Clients open a single connection, subscribe to one or more channels, and receive a continuous stream of updates anchored to block boundaries. This page will document the channels, their payloads, and their delivery guarantees.
Status: not yet published. The WebSocket subscription protocol will be released alongside the public testnet. Until then, treat the descriptions below as planning documentation.

What this page will contain

When the API ships, this page will list:
  • Market channels. Trades, top-of-book, depth, mark price, index price, and funding-rate updates per market.
  • Account channels. Order updates, fills, position changes, margin changes, and liquidation events for a signed-in account.
  • Block channels. Block-boundary heartbeats with the block hash, height, and the canonical sequencing commitment, useful for clients that want to align their local view with consensus.

Delivery guarantees

The WebSocket feed is anchored to the same per-block execution that produces the Verifiable Execution Stream. Updates are delivered in the order in which they were committed; clients that need stronger guarantees — full byte-deterministic replay — should consume the VES directly via a foundation node.

Conventions

Read the conventions section first. Notation, asset IDs, signing (for account channels), rate limits, and errors apply to WebSocket subscriptions in the same way they apply to REST. For early integration questions, email contact@intention.xyz.