Omen Developer Portal
Build with Omen APIs
Documentation, onboarding, and credential management for teams integrating trading, market data, account, wallet, and settlement workflows with Omen.
Integration workflow
From docs to production traffic
Follow the path from product selection and access review through API-key creation, gateway authentication, and operational validation.
Choose the integration path
Start with the product area you are integrating: perpetuals, options, wallet/account workflows, or cross-product account state.
Request or confirm access
If your team does not already have an Omen account with integration access, submit an onboarding request before creating credentials.
Create an API key
Sign in, create a key for the target system, assign the required permissions, set an expiry, and store the one-time plaintext value.
Connect and validate
Authenticate to the relevant API or gateway, then verify sequencing, replay behavior, health checks, and failure handling before production traffic.
API keys belong to the signed-in Omen account that creates them.
Use separate keys for separate systems, environments, and operational roles.
The plaintext key is shown once; store it in your secret manager before leaving the page.
Grant only the permissions the integration needs, and rotate keys on a fixed schedule.
Credential model
Permission and step-up rules
API-key permissions should match the role of the system using the key. Create separate credentials for separate environments, products, and operational duties.
`read`, `trade`, and `withdraw` are the supported permissions.
`trade` and `withdraw` require a stepped-up account session.
Read-only keys can be created with current password verification.
Tokens default to 30 days and are capped at 90 days.
Reference
API areas
Use the reference pages for endpoint paths, gateway channels, authentication schemes, environment endpoints, message names, and data models.
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
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
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
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
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
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
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
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
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
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
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