Omen Developer Portal
Request accessSign inAPI Keys

Reference

API Reference

Endpoint, gateway, market-data, account, and wallet reference for teams wiring Omen integrations. Use these pages for paths, channels, authentication requirements, payload names, and environment endpoints.

Perpetuals

OpenAPI reference · v0.1.0

Perps REST API

Client-facing REST API for the Omen perpetuals exchange. This API exposes public market data plus authenticated account endpoints used by perps clients for wallet linking and position lookups. Monetary values are serialized as decimal strings. Market-level price and size fields are 1e18-scaled fixed-point values rendered as plain decimal strings. Orderbook snapshots are exposed through `GET /api/v1/orderbook/{market_

Reference coverage

12 endpoints

Product area

Perpetuals

View reference

AsyncAPI reference · v0.1.0

Perps Trading Gateway

Client-facing trading and account-stream WebSocket API for Omen perps. Clients connect to a single WebSocket endpoint and exchange MessagePack-encoded messages. Examples in this document are shown in JSON for readability, but the wire format is MessagePack maps. The normal first application message is `auth`, but the gateway does not require it to be literally first on the wire. Trading commands and wallet-scoped sub

Reference coverage

41 messages

Product area

Perpetuals

Orders 100/sec with 50 burst tokensCancels 200/sec with 50 burst tokens64 concurrent sessions per client IP64 active subscriptions per session65536 byte maximum client messageReplay gap signal: drop_copy_gap
View reference

AsyncAPI reference · v0.1.0

Perps Market Data

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

Reference coverage

14 messages

Product area

Perpetuals

10 concurrent sessions per client IP256 active subscriptions per session65536 byte maximum client messageReplay gap signal: orderbook_gap
View reference

Options

OpenAPI reference · v0.1.1

Options Gateway Health

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

Reference coverage

2 endpoints

Product area

Options

View reference

AsyncAPI reference · v0.1.1

Options Trading Gateway

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

Reference coverage

23 messages

Product area

Options

View reference

OpenAPI reference · v0.1.0

Options Market Data Health

HTTP health endpoint exposed by `options-marketdatad`. Market-data subscriptions are not exposed over HTTP. Clients use the WebSocket contract in `docs/asyncapi.yaml`.

Reference coverage

1 endpoints

Product area

Options

View reference

AsyncAPI reference · v0.1.0

Options Market Data

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.

Reference coverage

16 messages

Product area

Options

View reference

Auth

OpenAPI reference · v3.0.0

Auth API

Authentication and identity service for the Omen platform. Provides email OTP, password, passkey (WebAuthn), and OAuth (Google/Apple) login flows, JWT token management with rotating refresh tokens, wallet linking, API token generation, product selection with geoblocking, and a JWKS endpoint for downstream signature verification. ## Base URL | Environment | URL | |-------------|-----| | Local dev | `http://localhost:3

Reference coverage

66 endpoints

Product area

Auth

View reference

Wallets

OpenAPI reference · v0.2.2

Wallet Service API

Server-side signing and credential management for the Omen trading platform. **Flows:** - **Prop Trading** — Risk-checked server-side signing via Privy server wallets - **Retail Delegation** — 24h session key delegation for retail users - **Retail Onboarding** — Full Polymarket account setup (Privy embedded wallet + deposit wallet/Safe + credentials) - **Builder HMAC** — HMAC-SHA256 header generation for Polymarket A

Reference coverage

50 endpoints

Product area

Wallets

View reference

AsyncAPI reference · v0.2.2

Wallet Service Aeron

Low-latency binary messaging interface for the Omen Wallet Service over Aeron UDP. The Gateway communicates with the Wallet Service using SBE (Simple Binary Encoding) messages over Aeron channels. This is the primary transport for latency-sensitive signing and HMAC operations. **Monetary values** are encoded as `u128` at 1e18 fixed-point scale.

Reference coverage

2 messages

Product area

Wallets

View reference

OpenAPI reference · v0.2.2

Wallets Proxy API

Proxy for the Omen Wallets retail API. Authenticates users via JWT (omen-auth) and forwards requests to the internal omen-wallets service. Request and response bodies are passed through verbatim from omen-wallets. **Token amounts** are serialized as raw smallest-unit JSON strings. pUSD, USDC.e, and USDT0 use 6 decimals (e.g. `"1000000"` = 1.00 token).

Reference coverage

22 endpoints

Product area

Wallets

View reference

Environments

Environment Endpoints

API and gateway endpoints documented for local development, health checks, and public ingress.

DomainAPI areaEndpointURLDescription
PerpetualsPerps REST APITest environmenthttps://api.perps.test.omen.tradeTest environment
PerpetualsPerps REST APILocal developmenthttp://localhost:8083Local development
PerpetualsPerps Trading Gatewaytestwss://ws.perps.test.omen.trade/Public test gateway
PerpetualsPerps Trading Gatewaylocalws://localhost:8080/Local development gateway
PerpetualsPerps Market Datatestwss://stream.perps.test.omen.trade/Public test market data stream
PerpetualsPerps Market Datalocalws://localhost:8082/Local development market data stream
OptionsOptions Gateway HealthLocal development gateway health port (`OPTIONS_GATEWAY_HEALTH_ADDR`)http://localhost:3002Local development gateway health port (`OPTIONS_GATEWAY_HEALTH_ADDR`)
OptionsOptions Trading GatewaytestWswss://ws.options.test.omen.trade/Public test gateway WebSocket
OptionsOptions Trading Gatewaytestwss://options.test.omen.trade/Public test gateway WebSocket alias
OptionsOptions Trading Gatewaylocalws://localhost:3001/Local development gateway (`OPTIONS_GATEWAY_WS_ADDR`)
OptionsOptions Market Data HealthPublic test market-data endpointhttps://stream.options.test.omen.tradePublic test market-data endpoint
OptionsOptions Market Data HealthLocal development market-data WebSocket and health port (`OPTIONS_MARKET_DATA_WS_ADDR`)http://localhost:3003Local development market-data WebSocket and health port (`OPTIONS_MARKET_DATA_WS_ADDR`)
OptionsOptions Market Datatestwss://stream.options.test.omen.trade/Public test market-data stream
OptionsOptions Market Datalocalws://localhost:3003/Local development market-data stream (`OPTIONS_MARKET_DATA_WS_ADDR`)
AuthAuth APILocal devhttp://localhost:3100Local dev
WalletsWallet Service APILocal developmenthttp://localhost:8090Local development
WalletsWallet Service AeronwalletServiceaeron-udp://0.0.0.0:40100Wallet Service listener. Configurable via `LISTEN_ENDPOINT` env var. Uses Aeron UDP transport with SBE binary encoding.
WalletsWallet Service Aerongatewayaeron-udp://localhost:40101Gateway endpoint for response delivery. Configurable via `GATEWAY_ENDPOINT` env var.
WalletsWallets Proxy APITest environmenthttps://wallets-proxy.test.omen.tradeTest environment
WalletsWallets Proxy APILocal developmenthttp://localhost:8080Local development