Omen Developer Portal

API Reference

Perps Market Data

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

AsyncAPI referencev0.1.0Perpetuals

Omen Perps Market Data WebSocket API

Client-facing market data WebSocket API for Omen perps. Clients connect to a single WebSocket endpoint and exchange MessagePack-encoded command maps. Server events are MessagePack arrays using the positional layouts documented below. Examples are shown as JSON arrays for readability. Market data subscriptions are public. No in-band authentication step is required. The REST API also exposes `GET /api/v1/orderbook/{mar

Environment endpoints

testwss://stream.perps.test.omen.trade/Public test market data stream
localws://localhost:8082/Local development market data stream

Channels and messages

marketDataConnection

/

14 messages

Single WebSocket connection used for subscribing to orderbook, trade, funding, and spot-price channels.

SubscribeCommandUnsubscribeCommandPingCommandSubscribedEventUnsubscribedEventPongEventErrorEventOrderbookSnapshotEventOrderbookDeltaEventOrderbookGapEventTradeEventFundingUpdateEventPriceUpdateEventTradesSnapshotEvent

Data models

MarketDataChannelPriceLevelSideSubscribeCommandPayloadUnsubscribeCommandPayloadPingCommandPayloadSubscribedEventPayloadUnsubscribedEventPayloadPongEventPayloadErrorEventPayloadOrderbookSnapshotEventPayloadOrderbookDeltaEventPayloadOrderbookGapEventPayloadTradeDataTradeEventPayloadFundingUpdateEventPayloadPriceUpdateEventPayloadTradesSnapshotEventPayload