Omen Developer Portal
Request accessSign inAPI Keys

API Reference

Perps REST API

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

OpenAPI referencev0.1.0Perpetuals

Omen Perps 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_

Environment endpoints

Test environmenthttps://api.perps.test.omen.tradeTest environment
Local developmenthttp://localhost:8083Local development

Authentication

BearerAuthhttpbearer

JWT issued by omen-auth. Authenticated endpoints expect a standard `Authorization: Bearer <token>` header with an `aud` of `authenticated`.

Endpoints

MethodPathSummaryTags
GET/healthHealth check
Health
GET/readyzReadiness check
Readiness
GET/api/v1/marketsList live perps markets
Markets
GET/api/v1/trades/{market_id}Get trade history for a market
Trades
GET/api/v1/candles/{market_id}Get OHLCV candles for a market
Candles
GET/api/v1/ticker/{market_id}Get 24h ticker stats for a market
Ticker
GET/api/v1/orderbook/{market_id}Get an L2 orderbook snapshot for a market
Orderbook
GET/api/v1/walletGet the caller's linked wallet
Wallet
POST/api/v1/wallet/linkLink a wallet to the authenticated perps account
Wallet
DELETE/api/v1/wallet/linkUnlink the authenticated account's wallet
Wallet
GET/api/v1/risk/bad-debtGet bad-debt summary
Risk
GET/api/v1/positions/{account}Get open positions for the caller's linked wallet
Positions

Data models

ErrorResponseUpstreamWalletErrorResponseHealthResponseReadinessMarketCheckReadinessResponseMarketResponseTradeResponseCandleResponseTickerResponseOrderbookPriceLevelOrderbookSnapshotResponsePositionResponseWalletResponseLinkWalletRequestLinkWalletResponseBadDebtEventBadDebtSummary