Options Market Data

Detailed reference for endpoints, authentication, channels, messages, environment endpoints, and data models in this integration area.

AsyncAPI referencev0.1.0Options

Omen Options Market Data WebSocket API

Client-facing public market-data WebSocket API for Omen options. Clients connect to a single WebSocket endpoint and send MessagePack-encoded command maps. Server events are MessagePack arrays using the positional layouts documented below. Examples are shown as JSON arrays for readability. No in-band authentication step is required.

Environment endpoints

testwss://stream.options.test.omen.trade/Public test market-data stream

localws://localhost:3003/Local development market-data stream (`OPTIONS_MARKET_DATA_WS_ADDR`)

Channels and messages

marketDataConnection

16 messages

Single WebSocket connection used for options listings, provenance, prices, orderbooks, trades, and corrections.

SubscribeCommandUnsubscribeCommandPingCommandSubscribedEventUnsubscribedEventPongEventErrorEventListingsSnapshotEventListingsUpdateEventProvenanceSnapshotEventProvenanceUpdateEventPriceUpdateEventOrderbookSnapshotEventTradeEventTradesSnapshotEventSettlementCorrectionEvent

Data models

MarketDataChannelDecimalStringSideListingSubIdProvenanceOrderBookLevelTradeSubscribeCommandPayloadUnsubscribeCommandPayloadPingCommandPayloadSubscribedEventPayloadUnsubscribedEventPayloadPongEventPayloadErrorEventPayloadListingsSnapshotEventPayloadListingsUpdateEventPayloadProvenanceSnapshotEventPayloadProvenanceUpdateEventPayloadPriceUpdateEventPayloadOrderbookSnapshotEventPayloadTradeEventPayloadTradesSnapshotEventPayloadSettlementCorrectionEventPayload