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

# Coming from OddsPapi - What changes when you move to the Apexium API

> Move an OddsPapi v5 client to the Apexium API: the host, the key and the endpoints change on REST and on the WebSocket; the paths, payloads and identifiers do not.

The market data of the Apexium API is OddsPapi v5. A client written for OddsPapi keeps its models and its parsing. What changes is how it connects, and which parts it can reach.

## What does not change

* **Paths and parameters** of the market data, under a new prefix.
* **Responses and payloads**, on REST and on the WebSocket feed channels.
* **Identifiers.** `fixtureId`, `outcomeId`, `playerId`, `sportId`, `tournamentId` are OddsPapi's, and they are the ones you place orders on.
* **The WebSocket envelope**: `{ channel, type, payload, ts }`.
* **The languages**: the same eight, as the first segment of the path. See [Languages](https://docs.apexiumbet.com/api-reference/overview.md#languages).

## REST

| | OddsPapi v5 | Apexium |
| - | - | - |
| Base URL | `https://v5.oddspapi.io/{lang}` | `https://api.apexiumbet.com/v1/{lang}` |
| Key | Your OddsPapi key | Your Apexium key, in the `x-api-key` header |
| Endpoints | All of OddsPapi v5 | The market data paths of the [reference](https://docs.apexiumbet.com/api-reference/market-data.md); mapping, settlement, parlays, futures and media are not served |
| Parameters | All | The ones listed on each reference page; others are dropped |
| Bookmakers | Those of your OddsPapi plan | Those of your Apexium account, except any closed to the API |

Responses come back unchanged. OddsPapi's own documentation, at [docs.oddspapi.io](https://docs.oddspapi.io), stays the reference for every field.

## WebSocket

| | OddsPapi v5 | Apexium |
| - | - | - |
| URL | `wss://v5.oddspapi.io/ws` | `wss://api.apexiumbet.com/v1/ws` |
| Key | `apiKey` in the login | `apiKey` in the login, your Apexium key |
| Feed channels | `odds`, `fixtures`, `scores`, `clocks`, `bookmakers`, `currencies`, and the futures, lineups, injuries, stats and events channels | `odds`, `fixtures`, `scores`, `clocks`, `bookmakers`, `currencies` |
| Account channels | none | `orders`, `balance`, `betslip` |
| `bookmakers` in the login | Narrows the bookmakers | Ignored: you receive the bookmakers of your account |
| `futureIds` in the login | Futures to follow | Ignored |
| `receiveType` | `json`, `binary`, `zstd`, `zstd-dict` | `json`, `binary`, `zstd`; production accepts `zstd` only |
| Resume | `serverEpoch` and `lastSeenId` per channel, from `entryId` | None on the feed channels: reload from `/v1/{lang}` on `snapshot_required`. `orders` resumes with `sinceEventId` |
| After login | An `access` message | A `login_ok` frame with the applied selection and the limits |
| Connections per key | 5 | 8 |

> [!WARNING]
>
> **Close code `4003` changes meaning.** At OddsPapi, it means too many connections. At Apexium, it means that the key or the account is no longer active, and you must not reconnect with it. The connection limit is `4004` at Apexium. See [Close codes](https://docs.apexiumbet.com/websocket/close-codes.md).

Feed messages carry no `entryId` and no broker timestamps. `ts` is the time Apexium received the message.

## Checklist

1. Point REST at `https://api.apexiumbet.com/v1/{lang}` and send your Apexium key in `x-api-key`.
2. Remove calls to the endpoints that are not served.
3. Point the WebSocket at `wss://api.apexiumbet.com/v1/ws` and log in with `receiveType: "zstd"`.
4. Remove the resume logic of the feed channels; reload from `/v1/{lang}` on `snapshot_required` instead. See [Feed channels](https://docs.apexiumbet.com/websocket/feed-channels.md).
5. Handle `4003` as final, and `4004` as a limit.


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