Skip to main content
The Ekiden WebSocket API enables real-time, event-driven communication over persistent WebSocket connections. It complements the REST API by streaming market data and account events with minimal latency. Ekiden provides two WebSocket endpoints:
  • Public — streams publicly available market data, including order books, trades, tickers, candlesticks and other market events.
  • Private — streams authenticated account events, including order updates, executions, positions, balances, transfers, and other account-related events.
The typical connection flow is:
  1. Connect to the appropriate WebSocket endpoint.
  2. Authenticate (private endpoint only).
  3. Subscribe to one or more topics.
  4. Receive real-time event updates.
  5. Keep the connection alive using Ping/Pong messages.
The following pages explain how to establish a connection, authenticate, and subscribe to topics. For complete channel definitions, message schemas, payload formats, and interactive examples, see the WebSocket Reference Public and WebSocket Reference Private.