Skip to main content
This bridge is generated from internal/websocket-schema.json. The contract lists command names, command required fields, and event names. It does not publish a standalone AsyncAPI contract or full event payload field schemas, so this page does not invent event JSON Schema blocks. Use WebSocket Message Schema for the human command and event contract.

Command Inventory

CommandRequired fields
subscribeop, channel, symbol
unsubscribeop, channel, symbol
replayop, channel_or_channels, symbol, start, end
replay.pauseop
replay.resumeop
replay.seekop, timestamp
replay.stopop
pingop

Event Inventory

EventSchema coverage
subscribedName only; full field schema is not present in internal/websocket-schema.json.
unsubscribedName only; full field schema is not present in internal/websocket-schema.json.
pongName only; full field schema is not present in internal/websocket-schema.json.
dataName only; full field schema is not present in internal/websocket-schema.json.
l4_snapshotName only; full field schema is not present in internal/websocket-schema.json.
l4_batchName only; full field schema is not present in internal/websocket-schema.json.
replay_startedName only; full field schema is not present in internal/websocket-schema.json.
replay_snapshotName only; full field schema is not present in internal/websocket-schema.json.
historical_dataName only; full field schema is not present in internal/websocket-schema.json.
historical_tick_dataName only; full field schema is not present in internal/websocket-schema.json.
replay_pausedName only; full field schema is not present in internal/websocket-schema.json.
replay_resumedName only; full field schema is not present in internal/websocket-schema.json.
replay_completedName only; full field schema is not present in internal/websocket-schema.json.
replay_stoppedName only; full field schema is not present in internal/websocket-schema.json.
gap_detectedName only; full field schema is not present in internal/websocket-schema.json.
errorName only; full field schema is not present in internal/websocket-schema.json.

subscribe Command

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "subscribe command",
  "type": "object",
  "required": [
    "op",
    "channel",
    "symbol"
  ],
  "properties": {
    "op": {
      "const": "subscribe"
    },
    "channel": {},
    "symbol": {}
  },
  "additionalProperties": true
}

unsubscribe Command

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "unsubscribe command",
  "type": "object",
  "required": [
    "op",
    "channel",
    "symbol"
  ],
  "properties": {
    "op": {
      "const": "unsubscribe"
    },
    "channel": {},
    "symbol": {}
  },
  "additionalProperties": true
}

replay Command

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "replay command",
  "type": "object",
  "required": [
    "op",
    "channel_or_channels",
    "symbol",
    "start",
    "end"
  ],
  "properties": {
    "op": {
      "const": "replay"
    },
    "channel_or_channels": {},
    "symbol": {},
    "start": {},
    "end": {}
  },
  "additionalProperties": true
}

replay.pause Command

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "replay.pause command",
  "type": "object",
  "required": [
    "op"
  ],
  "properties": {
    "op": {
      "const": "replay.pause"
    }
  },
  "additionalProperties": true
}

replay.resume Command

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "replay.resume command",
  "type": "object",
  "required": [
    "op"
  ],
  "properties": {
    "op": {
      "const": "replay.resume"
    }
  },
  "additionalProperties": true
}

replay.seek Command

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "replay.seek command",
  "type": "object",
  "required": [
    "op",
    "timestamp"
  ],
  "properties": {
    "op": {
      "const": "replay.seek"
    },
    "timestamp": {}
  },
  "additionalProperties": true
}

replay.stop Command

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "replay.stop command",
  "type": "object",
  "required": [
    "op"
  ],
  "properties": {
    "op": {
      "const": "replay.stop"
    }
  },
  "additionalProperties": true
}

ping Command

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "ping command",
  "type": "object",
  "required": [
    "op"
  ],
  "properties": {
    "op": {
      "const": "ping"
    }
  },
  "additionalProperties": true
}
Last modified on June 29, 2026