Skip to main content

Base URLs

A test environment, with its own base URL and keys, is available on request while you integrate. Every path starts with /v1. Send your key in the x-api-key header; see Authentication.

Languages

Only the market data carries a language, as the first segment of its path: /v1/{lang}/…. lang is one of en, es, fr, pt, de, it, ru and zh.
  • Names, such as sportName, follow the language when a translation exists.
  • Identifiers never depend on it.
  • The reference shows the market data paths in English: replace en with the language you want.
  • Other endpoints have no text to translate and no language.
On the WebSocket, the lang of the login sets the language of the fixtures channel; see WebSocket languages.

Conventions

  • JSON in and out, with content-type: application/json on request bodies.
  • Money is an object with a decimal string, the same amount in integer cents and a currency: { "amount": "12.50", "amountCents": 1250, "currency": "USD" }. See Money.
  • Prices are decimal odds, as strings: "1.95".
  • Times are ISO 8601 in UTC: "2026-10-05T14:30:00.000Z".
  • Identifiers: orders and bets have UUIDs. fixtureId, outcomeId and playerId are the OddsPapi identifiers used by the market data.
  • Lists are newest first and paginated with a cursor: pass nextCursor back as cursor until it is null.
  • Enums can gain values. Handle a value you do not know gracefully.
  • Errors have a stable code; see Errors.

Endpoints

Health

GET /v1/health is the only /v1 endpoint that needs no API key.
  • Statuses. Each service is healthy, degraded or unhealthy. status is the worst of them.
  • 200 while the API is healthy or degraded. A degraded API still places orders.
  • 503 with the same body when the API is unhealthy, or 503 PUBLIC_API_DISABLED when the API is switched off.
  • Freshness. The result is refreshed at most every 15 seconds: polling faster returns the same answer.
  • Limit. 120 requests per minute per address; see Limits.

Account

Market data

The market data is OddsPapi v5, served under /v1/{lang} with OddsPapi’s paths, parameters, responses and identifiers. For lang, see Languages. Other paths answer 404. Odds are limited to your account’s bookmakers: asking for another one answers 403 BOOKMAKER_NOT_AVAILABLE.
See Market data and identifiers for how sports, fixtures, markets and outcomes fit together, and how an odds row becomes an order.

Betslip

The betslip price is the one you place at. It can differ from the odds of the market data: see Feed odds and the betslip.

Orders

Bets, positions and PnL

Orders and bets placed from the dashboard appear in these endpoints too.

Reference

The endpoint pages in the sidebar are generated:
  • Health, account, betslip, orders, bets, positions and PnL. From the OpenAPI contract that the API exports: fields, types and status codes are exactly those of the API.
  • Market data. From the OddsPapi v5 reference, limited to the paths and parameters Apexium serves.