Options Trading Gateway

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

AsyncAPI referencev0.1.1Options

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

testWswss://ws.options.test.omen.trade/Public test gateway WebSocket

testwss://options.test.omen.trade/Public test gateway WebSocket alias

localws://localhost:3001/Local development gateway (`OPTIONS_GATEWAY_WS_ADDR`)

Channels and messages

gatewayConnection

23 messages

Single WebSocket connection used for authentication, trading commands, and account reads.

AuthCommandPingCommandAuthorizeSessionKeyCommandRevokeSessionKeyCommandPlaceOrderCommandPlaceOptionSpreadOrderCommandCancelOrderCommandAmendOrderCommandCandlesCommandMarketSnapshotCommandAccountSnapshotCommandAccountStateCommandAuthAckEventPongEventSessionKeyAuthorizedEventSessionKeyRejectedEventSessionKeyRevokedEventCommandResultEventMarketSnapshotEventCandlesEventAccountSnapshotEventAccountStateEventErrorEvent

Data models

WalletAddressHex32Hex65DecimalStringU128StringOrIntegerSideOptionRightTimeInForceCandleIntervalSubIdOrderRequestBaseAuthCommandPayloadPingCommandPayloadAuthorizeSessionKeyCommandPayloadRevokeSessionKeyCommandPayloadPlaceOrderCommandPayloadSpreadLegPlaceOptionSpreadOrderCommandPayloadCancelOrderCommandPayloadAmendOrderCommandPayloadCandlesCommandPayloadMarketSnapshotCommandPayloadAccountSnapshotCommandPayloadAccountStateCommandPayloadGatewayEventAcceptedGatewayEventCancelledGatewayEventAmendedGatewayEventRejectedGatewayEventFilledGatewayEventBookDeltaGatewayEventOrderBookLevelSubIdMarkOrderBookSnapshotMarketDataSnapshotCandleAccountExecutionRecordAccountMarketDataSnapshotAuthAckEventPayloadPongEventPayloadSessionKeyAuthorizedEventPayloadSessionKeyRejectedEventPayloadSessionKeyRevokedEventPayloadCommandResultEventPayloadMarketSnapshotEventPayloadCandlesEventPayloadAccountSnapshotEventPayloadAccountStateEventPayloadErrorCodeErrorEventPayload