Integration area
Options
Use the options APIs for gateway command flow, account reads, health checks, option orderbooks, listings, prices, corrections, and trade streams.
Gateway health
options-gatewayd exposes liveness and latency snapshots on its health port. Order entry, cancels, amendments, account reads, and market reads use WebSocket.
Authenticated commands
The gateway accepts auth, session-key, order, cancel, amend, candle, market-snapshot, account-snapshot, and account-state commands over MessagePack.
Unsupported spread path
`placeOptionSpreadOrder` is documented by the gateway and currently returns an unsupported response. Build single-leg order flow first.
Public market data
Subscribe to listings, provenance, corrections, prices, option orderbooks, and trades. The stream has no in-band authentication requirement.
Omen Options Gateway Health API
HTTP health and latency endpoints exposed by `options-gatewayd`. Order entry, cancels, amendments, account state reads, and market-data reads are not exposed over HTTP. Those client-facing commands use the gateway WebSocket contract in `docs/asyncapi.yaml`. In the test cluster, these endpoints are used as ALB/Kubernetes health checks on the service health port. The public gateway ingress routes `options.test.omen.tra
Environment endpoints
http://localhost:3002Local development gateway health port (`OPTIONS_GATEWAY_HEALTH_ADDR`)Endpoints
| Method | Path | Summary | Tags |
|---|---|---|---|
| GET | /health | Gateway liveness and hot-path counters | Health |
| GET | /health/latency | Structured gateway latency snapshot | Health |
Data models
Omen Options Gateway WebSocket API
Client-facing options trading WebSocket API. Clients connect to a single WebSocket endpoint and exchange MessagePack-encoded application messages. Examples in this document are shown in JSON for readability. Trading commands and wallet-scoped account reads require authentication. The normal first application message is `auth`, but the gateway does not require it to be literally first on the wire. If the auth timeout
Environment endpoints
wss://ws.options.test.omen.trade/Public test gateway WebSocketwss://options.test.omen.trade/Public test gateway WebSocket aliasws://localhost:3001/Local development gateway (`OPTIONS_GATEWAY_WS_ADDR`)Channels and messages
gatewayConnection
/
Single WebSocket connection used for authentication, trading commands, and account reads.
Data models
Omen Options Market Data Health API
HTTP health endpoint exposed by `options-marketdatad`. Market-data subscriptions are not exposed over HTTP. Clients use the WebSocket contract in `docs/asyncapi.yaml`.
Environment endpoints
https://stream.options.test.omen.tradePublic test market-data endpointhttp://localhost:3003Local development market-data WebSocket and health port (`OPTIONS_MARKET_DATA_WS_ADDR`)Endpoints
| Method | Path | Summary | Tags |
|---|---|---|---|
| GET | /health | Market-data liveness | Health |
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
wss://stream.options.test.omen.trade/Public test market-data streamws://localhost:3003/Local development market-data stream (`OPTIONS_MARKET_DATA_WS_ADDR`)Channels and messages
marketDataConnection
/
Single WebSocket connection used for options listings, provenance, prices, orderbooks, trades, and corrections.