> ## Documentation Index
> Fetch the complete documentation index at: https://docs.apexiumbet.com/llms.txt
> Use this file to discover all available pages before exploring further.

# API overview - Base URLs, conventions and endpoints

> Base URLs, formats and conventions of the Apexium API, and a map of its endpoints: health, account, market data, betslip, orders, bets, positions and PnL.

## Base URLs

| Environment | Base URL |
| - | - |
| Production | `https://api.apexiumbet.com` |

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](https://docs.apexiumbet.com/api-reference/authentication.md).

## 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`.

```
/v1/en/fixtures
/v1/de/fixtures
```

* **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](https://docs.apexiumbet.com/websocket/overview.md#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](https://docs.apexiumbet.com/guides/money.md).
* **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](https://docs.apexiumbet.com/api-reference/errors.md).

## Endpoints

### Health

| Endpoint | What it returns |
| - | - |
| `GET /v1/health` | Whether the API is up, and the state of each of its services |

`GET /v1/health` is the only `/v1` endpoint that needs no API key.

```bash theme={null}
curl https://api.apexiumbet.com/v1/health
```

```json theme={null}
{
  "status": "degraded",
  "time": "2026-11-10T14:30:00.000Z",
  "services": {
    "database": "healthy",
    "caching": "healthy",
    "betPlacement": "healthy",
    "betUpdates": "degraded"
  }
}
```

* **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](https://docs.apexiumbet.com/api-reference/limits.md#health-check).

### Account

| Endpoint | What it returns |
| - | - |
| `GET /v1/me` | The account behind the key: identity, status, bookmakers, the key in use |
| `GET /v1/balance` | Cash balance, given credit, exposure and available balance |

### Market data

The market data is **OddsPapi v5**, served under `/v1/{lang}` with OddsPapi's paths, parameters, responses and identifiers. For `lang`, see [Languages](#languages).

| Group | Paths under `/v1/{lang}` |
| - | - |
| Reference data | `sports`, `tournaments`, `seasons`, `venues`, `participants`, `players`, `markets`, `currencies`, `bookmakers` |
| Fixtures | `fixtures`, `fixtures/today`, `fixtures/live`, `fixtures/search` |
| Odds | `fixtures/odds`, `fixtures/odds/main`, `fixtures/odds/clv`, `fixtures/odds/historical` |

Other paths answer `404`. Odds are limited to your account's bookmakers: asking for another one answers `403 BOOKMAKER_NOT_AVAILABLE`.

```bash theme={null}
curl "https://api.apexiumbet.com/v1/en/fixtures/odds?fixtureId=id1000001761300868" \
  -H "x-api-key: apx_live_…"
```

See [Market data and identifiers](https://docs.apexiumbet.com/api-reference/market-data.md) for how sports, fixtures, markets and outcomes fit together, and how an odds row becomes an order.

### Betslip

| Endpoint | What it returns |
| - | - |
| `GET /v1/betslip` | For one selection, the price and stake limits at each of your bookmakers, after your account's rules |

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](https://docs.apexiumbet.com/guides/feed-odds-and-betslip.md).

### Orders

| Endpoint | What it does |
| - | - |
| `POST /v1/orders` | Previews or places an order; see [Preview and place](https://docs.apexiumbet.com/guides/preview-and-place.md) |
| `GET /v1/orders` | Lists your orders |
| `GET /v1/orders/{id}` | Reads one order with its bets |
| `GET /v1/orders/by-client-id/{clientOrderId}` | Reads one order by your own identifier |
| `POST /v1/orders/{id}/cancel` | Cancels one order; see [Cancellation](https://docs.apexiumbet.com/guides/cancellation.md) |
| `POST /v1/orders/cancel-all` | Cancels the working orders of the account, of a fixture, or a list |

### Bets, positions and PnL

| Endpoint | What it returns |
| - | - |
| `GET /v1/bets` | Your bets, filterable by status, settlement, fixture, bookmaker and time |
| `GET /v1/bets/{id}` | One bet |
| `GET /v1/positions` | Your open bets, grouped by selection, fixture or bookmaker |
| `GET /v1/pnl` | Your settled results over a time window |

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.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.