# Apexium API — Automated bet execution and market data The Apexium API is the programmatic access to an apexiumbet.com account. With one API key you read the betslip, preview and place orders across bookmakers, exchanges and prediction markets, follow their bets until they settle, cancel what is still working, and read your balance, positions and PnL. Its market data is OddsPapi v5 itself (sports, tournaments, fixtures, scores, markets and odds) under /v1/{lang}, with OddsPapi's paths, responses and identifiers, limited to the bookmakers of your account: the fixtureId and outcomeId read in the odds are the ones orders are placed on, and an OddsPapi client only changes its base URL and key. Base URL: https://api.apexiumbet.com/v1, authenticated with the x-api-key header. An order is your instruction; Apexium splits it into bets at one or more bookmakers. Orders are idempotent through clientOrderId, carry a minimum price, accept partial fills or not, and can keep working their remainder for up to one hour. Selections use the OddsPapi identifiers fixtureId, outcomeId and playerId. Only backing is available in v1. The REST reference is generated from the OpenAPI contract the API exports, and its market data pages from the OddsPapi v5 reference. # Apexium API Docs — Full Bundle # Generated from docs.json navigation # Source: MDX files --- ## Apexium API - Automated bet execution and market data Source: /index --- **Early access.** The API opens with the platform. Contact [contact@apexiumbet.com](mailto:contact@apexiumbet.com) for access, and for a test environment while you integrate. ## What is the Apexium API? The Apexium API is the programmatic access to your [apexiumbet.com](https://apexiumbet.com) account. Everything you do through it happens on that account, with the same balance, the same bookmakers and the same rules as in the dashboard. - **Execution**: read the betslip for your price and stake limits, preview an order, place it, follow its bets until they settle, and cancel what is still working. - **Account**: read your balance, your open positions and your realised PnL. - **Market data**: read fixtures, scores and odds from **OddsPapi v5**, limited to your bookmakers. The market data is OddsPapi v5 itself: same paths, same responses, same identifiers. The `fixtureId` and `outcomeId` you read in the odds are the ones you place orders on, so there is no mapping layer between your data and your execution. An OddsPapi client only changes its base URL and its key; see [Market data and identifiers](/api-reference/market-data). An order is your instruction: back an outcome for a stake, at or above a minimum price. Apexium splits it into **bets** at one or more bookmakers. You follow the order and its bets through the same endpoints, whether you placed it through the API or from the dashboard. ## Environments | Environment | Base URL | API keys | |---|---|---| | **Production** | `https://api.apexiumbet.com` | `apx_live_…` | Every endpoint lives under `/v1`. A test environment, with its own base URL and keys, is available on request while you integrate. Keys only work in the environment that issued them. ## Where to start From a key to a placed order in five calls. Get a key, send it, rotate it. What an order asks for, and what you get back. OddsPapi v5 sports, fixtures, markets and odds, and how they become orders. Every endpoint, generated from the API's contract and the OddsPapi v5 reference. ## How the reference is built The endpoint pages are generated from the OpenAPI contract that the API itself exports, and the market data pages from the OddsPapi v5 reference. A field, a parameter or a status code is in the reference because the API has it. The `/v1` contract only grows: fields, endpoints and enum values are added, never renamed or removed, so handle unknown enum values gracefully. --- ## Quickstart - From an API key to a placed order Source: /quickstart --- Replace `apx_live_…` with your key. On a test environment, use the base URL and the key you were given. ## 1. Get a key Your agent enables API access on your account. You then create a key in the dashboard, under **Preferences → API**. The key is shown once: store it in a secret manager. See [Authentication](/api-reference/authentication). ## 2. Check the key ```bash curl https://api.apexiumbet.com/v1/me \ -H "x-api-key: apx_live_…" ``` The answer names the account, its status, the key in use and the bookmakers you can place on. ## 3. Read the betslip The betslip gives the price you can place at, after your account's rules, and your stake limits. Ask for one selection: ```bash curl "https://api.apexiumbet.com/v1/betslip?fixtureId=id1000001761300868&outcomeId=101" \ -H "x-api-key: apx_live_…" ``` Each bookmaker comes back with `active`, its price and its stake limits. Fixture and outcome identifiers come from the [market data](/api-reference/overview#market-data) endpoints. Their odds can differ from the betslip price: see [Feed odds and the betslip](/guides/feed-odds-and-betslip). ## 4. Preview the order A preview applies every rule and limit, then tells you what would be placed now. It stores nothing. ```bash curl https://api.apexiumbet.com/v1/orders \ -H "x-api-key: apx_live_…" \ -H "content-type: application/json" \ -d '{ "mode": "preview", "clientOrderId": "my-order-0001", "fixtureId": "id1000001761300868", "outcomeId": 101, "side": "back", "stake": { "amount": "50.00", "currency": "USD" }, "minPrice": "1.90", "acceptBetterOdds": true, "acceptPartialStake": true }' ``` The answer has `status: "PREVIEW"` and one entry in `bets` per bookmaker the stake would go to. ## 5. Place it Send the same body with `"mode": "place"`. A new order answers `201 Created`: ```json { "id": "4f0c2b1e-8d4a-4f7e-9a51-2c1f0b7e9d10", "clientOrderId": "my-order-0001", "status": "FILLED", "requestedStake": { "amount": "50.00", "amountCents": 5000, "currency": "USD" }, "filledStake": { "amount": "50.00", "amountCents": 5000, "currency": "USD" }, "averageFilledPrice": "1.92", "bets": [ { "bookmaker": "sharpbet", "status": "PLACED", "filledPrice": "1.92" } ], "version": 2 } ``` The example is shortened. If the connection drops before you read the answer, send the same request again: the `clientOrderId` makes it return the same order instead of placing a second one. See [Idempotency](/guides/idempotency). ## 6. Read it back ```bash curl https://api.apexiumbet.com/v1/orders/by-client-id/my-order-0001 \ -H "x-api-key: apx_live_…" ``` `version` goes up by one at every change of the order or of one of its bets: compare it to know whether anything moved. See [Order and bet life cycle](/guides/order-lifecycle). --- ## Coverage - Sports, markets and bookmakers Source: /coverage --- Apexium trades the fixtures of 12 sports, the same as in the dashboard. Each sport has a numeric `sportId`, with the same identifiers in the **OddsPapi v5** market data and in your orders. See [Market data and identifiers](/api-reference/market-data). ## What you can trade - **Fixtures.** Orders are placed on a fixture's outcome: a `fixtureId`, an `outcomeId` and, for player markets, a `playerId`. Outrights and other futures are not available through the API. - **Markets.** Orders name an `outcomeId`, whatever its market: match result, totals, handicaps, periods, player markets. Whether a bookmaker of your account takes it right now shows in [`GET /v1/betslip`](/api-reference/overview#betslip). - **Back only.** Every order backs its outcome. Laying is not available in v1. - **Your bookmakers.** Orders go to the bookmakers enabled on your account, which `GET /v1/me` lists. Your agent manages that list. - **Bookmakers closed to the API.** Apexium can close a bookmaker to the API, even when it is enabled on your account. It is then left out of `GET /v1/me`, the betslip, the market data and the WebSocket, and an order that names it answers `400 BOOKMAKER_NOT_AVAILABLE_VIA_API`. ## Sports Orders can be placed on the fixtures of these sports. Esports is one sport in the dashboard and four here, one `sportId` per game. | sportId | Sport | |--------:|-------| | 10 | Soccer | | 11 | Basketball | | 12 | Tennis | | 13 | Baseball | | 14 | American Football | | 15 | Ice Hockey | | 16 | ESport Dota | | 17 | ESport Counter-Strike | | 18 | ESport League of Legends | | 20 | MMA | | 21 | Boxing | | 61 | ESport Valorant | The market data lists every sport of OddsPapi v5, with names in your language: ```bash curl https://api.apexiumbet.com/v1/en/sports \ -H "x-api-key: apx_live_…" ``` A sport that is not in the table can be read but not traded. ## What you can read The market data covers the tournaments, seasons, fixtures, scores, markets and odds that OddsPapi v5 publishes for every sport, through [`/v1/{lang}`](/api-reference/market-data). Odds are limited to your account's bookmakers. Identifiers do not depend on the language; display names, such as `sportName`, follow the `lang` of the path. --- ## AI & LLM Integration - Documentation export Source: /ai --- ## Download - **Docs index:** [`/llms.txt`](/llms.txt) - **Full docs bundle:** [`/llms-full.txt`](/llms-full.txt), every page in navigation order, followed by the OpenAPI contract - **OpenAPI contract:** [`/api-reference/openapi.json`](/api-reference/openapi.json), the contract the API exports, for code generators and AI tools ## Recommended usage If your AI tool can fetch URLs, give it `/llms-full.txt`. If it can only take pasted text, open `/llms-full.txt` in the browser and paste its contents. To generate a client, point your OpenAPI generator at `/api-reference/openapi.json`. --- ## Feed odds and the betslip - Which price you can place at Source: /guides/feed-odds-and-betslip --- The Apexium API gives two prices for the same selection: the odds of the market data, and the price of the betslip. They answer different questions, so they can differ. | | Market data odds | Betslip | |---|---|---| | Read with | `GET /v1/{lang}/fixtures/odds`, the `odds` channel | `GET /v1/betslip`, the `betslip` channel | | What it is | The bookmaker's market, as OddsPapi publishes it | The price your account can place at | | Your account's rules | Not applied | Applied | | Stake | The bookmaker's maximum stake, when it publishes one | Your smallest and largest stake | | Scope | Every outcome of the fixtures you read | One selection at a time | ## Market data odds The odds of the market data are raw bookmaker market data: the price each of your bookmakers shows, as OddsPapi collects it. Use them to find fixtures and outcomes, follow the market and compare bookmakers. They are the same for every Apexium account, apart from the list of bookmakers. See [Market data and identifiers](/api-reference/market-data). ## The betslip The betslip is what your account gets. For one selection, it answers for each of your bookmakers: - **`active`**: whether the bookmaker can take a bet on this selection right now. - **`price`**: the price after your account's rules. - **`minStake`** and **`maxStake`**: the smallest stake the bookmaker accepts, and the largest stake your account can place there. When `active` is `false`, the other fields are `null`. ## Why they differ - **Your account's rules.** Your agent sets the rules of your account. They can change the price and the largest stake you get at a bookmaker, or keep a bookmaker out of a selection. The betslip applies them; the market data does not. - **Live checks.** At some bookmakers, the betslip asks the bookmaker for its price and limits at the moment you read it. It can then be more recent than the last odds you received. - **Stake limits.** The market data has none of your account's limits. The betslip gives the stake range of your account at each bookmaker, within the bookmaker's own limits. A bookmaker can therefore show odds in the market data and be `active: false` in the betslip. ## Before you place Read its `fixtureId`, `outcomeId` and `playerId` from the market data. Call [`GET /v1/betslip`](/api-reference/overview#betslip) once, or subscribe to the [`betslip` channel](/websocket/betslip) to follow it. Take `minPrice` from the betslip `price`, preview the order, then place it. See [Preview and place](/guides/preview-and-place). A betslip `price` sent as `minPrice` places at the bookmaker's current price. A `minPrice` taken from the market data can be above the price your account gets: the order can then fail its price check. See [Errors](/api-reference/errors#order-rejections). Prices move. The betslip and the preview show the market at the moment you read them; they reserve nothing. --- ## Preview and place - Sending an order Source: /guides/preview-and-place --- `POST /v1/orders` both previews and places. `mode` is required and has no default, so a request can never place by accident. | `mode` | What happens | Answer | |---|---|---| | `"preview"` | Every rule and limit is applied, and the order is tried as a test order with the bookmakers. Nothing is placed or stored. | `200` with `status: "PREVIEW"` | | `"place"` | The order is placed. | `201` with the new order, or `200` with the existing one when you resend the same request (see [Idempotency](/guides/idempotency)) | ## The request ```json { "mode": "place", "clientOrderId": "my-order-0002", "fixtureId": "id1000001761300868", "outcomeId": 101, "playerId": 0, "side": "back", "bookmakers": ["sharpbet", "betfair-ex"], "stake": { "amount": "200.00", "currency": "USD" }, "minPrice": "1.90", "acceptBetterOdds": true, "acceptPartialStake": true, "expiresAt": "2026-10-05T15:00:00.000Z" } ``` | Field | Meaning | |---|---| | `clientOrderId` | Your identifier for the order, unique on your account. It makes retries safe. | | `fixtureId`, `outcomeId`, `playerId` | The selection, with the market data identifiers. `playerId` defaults to `0` (no player). | | `side` | `"back"`. Laying is not available in v1. | | `bookmakers` | Where the stake may go. Omitted, every bookmaker of your account is used. | | `stake` | The total stake, in the account currency. See [Money](/guides/money). | | `minPrice` | The lowest price you accept, at least `1.001`. | | `acceptBetterOdds` | `true` lets a bet fill at a better price than quoted. | | `acceptPartialStake` | `true` accepts filling only part of the stake. `false` is fill or kill. | | `expiresAt` | Optional. Keeps working the unfilled remainder until then, at most one hour ahead. | ### How the stake is split The stake is split across the requested bookmakers that offer a price at or above `minPrice`, within each one's limits. Each part becomes a **bet**. An order can therefore have several bets, at different prices; `averageFilledPrice` is their stake-weighted average. ### Partial fills and expiry | `acceptPartialStake` | `expiresAt` | Behaviour | |---|---|---| | `false` | — | Fill or kill: the whole stake or nothing. | | `true` | absent | Immediate or cancel: what fills now is kept, the rest is dropped. | | `true` | set | What fills now is kept, and the remainder keeps being worked until `expiresAt`. | An order with `expiresAt` stays working until it fills or expires. Cancel it early with [`POST /v1/orders/{id}/cancel`](/guides/cancellation). Some environments do not offer expiry yet: they answer `503 EXPIRY_NOT_AVAILABLE`, and the same order without `expiresAt` works. ### Bookmakers - **Your bookmakers.** `GET /v1/me` lists the bookmakers of your account. Asking for another one answers `403 BOOKMAKER_NOT_AVAILABLE`. - **Bookmakers closed to the API.** A bookmaker can be closed to the API even when it is enabled on your account, and `GET /v1/me` leaves it out. Asking for it answers `400 BOOKMAKER_NOT_AVAILABLE_VIA_API`, and it is never used when `bookmakers` is omitted. ## Preview first A preview answers with what would be placed now: one entry per bookmaker in `bets`, with its status, stake and price. ```json { "clientOrderId": "my-order-0002", "status": "PREVIEW", "requestedStake": { "amount": "200.00", "amountCents": 20000, "currency": "USD" }, "filledStake": { "amount": "200.00", "amountCents": 20000, "currency": "USD" }, "averageFilledPrice": "1.93", "bets": [ { "bookmaker": "sharpbet", "status": "PLACED", "requestedStake": { "amount": "120.00", "amountCents": 12000, "currency": "USD" }, "filledPrice": "1.95" }, { "bookmaker": "betfair-ex", "status": "PLACED", "requestedStake": { "amount": "80.00", "amountCents": 8000, "currency": "USD" }, "filledPrice": "1.90" } ] } ``` The example is shortened. Prices move: a preview is a good estimate, not a reservation. When nothing can be placed, the preview answers the same error a placement would. To read only the prices and limits, read the betslip with `GET /v1/betslip`: see [Feed odds and the betslip](/guides/feed-odds-and-betslip). ## Rejections Before anything is sent to a bookmaker, the order is checked: your balance, your limit per fixture, your account's rules, the prices and the liquidity. When a check fails, the request answers an error and nothing is recorded; see [Errors](/api-reference/errors#order-rejections). Once the order is recorded, a bookmaker can still decline its part. That is not an error: the order comes back, and the declined bet has `status: "REJECTED"` and a `declineReason`. See [Order and bet life cycle](/guides/order-lifecycle). --- ## Idempotency - Retrying orders safely with clientOrderId Source: /guides/idempotency --- A network can drop the answer to a placement after the order was placed. Without a way to retry safely, you would have to choose between missing an order and placing it twice. `clientOrderId` removes that choice. ## The rule Every order carries a `clientOrderId` that you choose: 1 to 200 characters, unique on your account. Use an identifier from your own system, or a UUID you generate before the first attempt. | You send | You get | |---|---| | A `clientOrderId` never used | The order is placed: `201` | | The same `clientOrderId` and the same terms | The existing order, unchanged: `200`. Nothing new is placed. | | The same `clientOrderId` with other terms | `409 CLIENT_ORDER_ID_REUSED`. Nothing new is placed. | The terms are the selection, the bookmakers, the stake, `minPrice`, `acceptBetterOdds`, `acceptPartialStake` and `expiresAt`. A resent request matches when they are equal; `mode` must be `"place"` both times. Previews store nothing, so a `clientOrderId` used only in previews is still free. ## Retrying Retry with the **same body**, never with a new `clientOrderId`: - **Timeout or dropped connection.** Resend the request. You get the order if it was placed, or it is placed now. - **`502 UPSTREAM_UNAVAILABLE`.** The bookmaker gateway did not answer, and the order may exist. Resend the request: it returns the order if it was recorded. - **`409 PREVIOUS_ATTEMPT_UNRESOLVED`.** An earlier attempt with this `clientOrderId` is still being resolved with the bookmaker. Wait a few seconds and resend. - **`5xx` in general.** Resend with backoff. - **`4xx` other than the above.** The request itself is wrong: fix it before you send it again. ## Reading an order by your identifier You can also look the order up without placing anything: ```bash curl https://api.apexiumbet.com/v1/orders/by-client-id/my-order-0002 \ -H "x-api-key: apx_live_…" ``` It answers `404 NOT_FOUND` when no order was recorded with this identifier. --- ## Order and bet life cycle - Statuses and versions Source: /guides/order-lifecycle --- An **order** is your instruction. Its **bets** are the parts of the stake placed at each bookmaker. The order's status is derived from its bets, so you can follow an order by reading it alone. ## Order statuses | Status | Meaning | Final | |---|---|---| | `PENDING` | Sent to the bookmakers, nothing filled yet | No | | `PARTIALLY_FILLED` | Part of the stake is filled, and some is still being worked | No | | `FILLED` | The whole stake is filled, or what the order accepted to fill is | Yes | | `EXPIRED` | `expiresAt` passed before the whole stake filled. `filledStake` shows what did. | Yes | | `CANCELLED` | Cancelled before it completed, by you or by a bookmaker. `filledStake` shows what filled before. | Yes | | `REJECTED` | Nothing filled: every bet was declined | Yes | `PENDING` and `PARTIALLY_FILLED` are the **working** statuses: those orders can still change, and [cancellation](/guides/cancellation) applies to them. `FILLED` covers partial fills too. An immediate-or-cancel order (`acceptPartialStake: true`, no `expiresAt`) that filled 120 of 200 is `FILLED` with `filledStake` 120.00. Compare `filledStake` with `requestedStake` to know how much filled. ## Bet statuses | Status | Meaning | |---|---| | `PENDING` | Sent to the bookmaker, no answer yet | | `WAITING` | Received by the bookmaker, not confirmed yet, for example during an in-play delay | | `PARTIALLY_PLACED` | Part of the bet's stake is accepted, for example on an exchange | | `PLACED` | Accepted by the bookmaker | | `REJECTED` | Declined by the bookmaker; `declineReason` says why | | `CANCELLED` | Cancelled, or expired at the bookmaker, before it was accepted | | `SETTLED` | Graded by the bookmaker; see `settlement` | A placed bet then settles. Its `settlement.status` is `UNSETTLED` until then, and one of `WON`, `LOST`, `VOID`, `HALF_WON`, `HALF_LOST`, `PUSH`, `CASHOUT` after. `settlement.amount` is your profit or loss on the bet. ## Following changes Every order has a `version` that goes up by one at each change of the order or of one of its bets. To follow an order, read it and compare `version` with the last one you saw; when it moved, something changed. - **One order.** `GET /v1/orders/{id}` or `GET /v1/orders/by-client-id/{clientOrderId}`. - **Working orders.** `GET /v1/orders?status=PENDING&status=PARTIALLY_FILLED`. - **Settlements.** `GET /v1/bets?settledFrom=…` lists the bets settled since a time. ## Amounts on an order | Field | Meaning | |---|---| | `requestedStake` | The stake you asked for | | `filledStake` | The stake accepted by the bookmakers so far | | `remainingStake` | The stake still being worked; `0.00` once the order is final | | `averageFilledPrice` | The stake-weighted price of the filled bets, `null` while nothing filled | --- ## Cancellation - Outcomes of cancelling an order Source: /guides/cancellation --- Cancelling stops what is still working on an order. It cannot undo what a bookmaker already accepted. ## Cancelling one order ```bash curl -X POST https://api.apexiumbet.com/v1/orders/4f0c2b1e-8d4a-4f7e-9a51-2c1f0b7e9d10/cancel \ -H "x-api-key: apx_live_…" ``` The answer is the order after cancellation, with two more fields that tell you what happened. ### The remainder `remainder` is about the unfilled stake that an order with `expiresAt` keeps working: | `remainder` | Meaning | |---|---| | `cancelled` | The remainder was being worked and is now stopped | | `alreadyTerminal` | The remainder had already ended: filled, expired or cancelled | | `none` | The order has no expiry, so there is no remainder | ### Each bet Each bet carries a `cancellation`: | `cancellation` | Meaning | |---|---| | `cancelled` | The bet was cancelled before the bookmaker accepted it | | `alreadyTerminal` | The bet had already ended: rejected or settled | | `notRecallable` | The bookmaker accepted the bet; it stands and will settle | `filledStake` after cancellation is what you keep at risk. ### Cancelling again Cancelling is safe to repeat. Cancelling an order that is already final returns the same outcomes again, and changes nothing. `409 ORDER_BUSY` means the order is being worked on at that moment, for example by its expiry remainder. Retry after a short delay. ## Cancelling many orders `POST /v1/orders/cancel-all` cancels orders in one of three scopes: | Body | Scope | |---|---| | `{}` | Every working order (`PENDING`, `PARTIALLY_FILLED`) of the account | | `{ "fixtureId": "id1000001761300868" }` | The working orders on one fixture | | `{ "orderIds": ["…", "…"] }` | The listed orders, at most 200, whatever their status. A final order comes back with its outcomes, unchanged. | The answer has four lists: | Field | Meaning | |---|---| | `orders` | The cancelled orders, each with `remainder` and per-bet `cancellation` as above | | `notFound` | Listed ids that match no order of the account (or not on `fixtureId` when you gave one) | | `busy` | Orders that were being worked on; cancel them again shortly | | `nextCursor` | Not `null` when there are more than 200 orders: call again with `{ "cursor": "…" }`, and the same `fixtureId` if you gave one | ```bash curl -X POST https://api.apexiumbet.com/v1/orders/cancel-all \ -H "x-api-key: apx_live_…" \ -H "content-type: application/json" \ -d '{ "fixtureId": "id1000001761300868" }' ``` `cursor` cannot be combined with `orderIds`. Cancellations count against the order budget of your key; see [Limits](/api-reference/limits). --- ## Money format - Amounts, currency and prices Source: /guides/money --- ## Amounts Every amount the API returns is an object with a decimal string, the same amount in integer cents, and an ISO 4217 currency code: ```json { "amount": "1250.00", "amountCents": 125000, "currency": "USD" } ``` - **Decimal string.** `amount` always has two decimals and no thousands separator. It is a string so that no precision is lost: parse it with a decimal type, not a floating-point number. - **Integer cents.** `amountCents` is the same amount as a whole number of cents: always `amount` × 100. Use it if your platform counts in cents; the two fields never disagree. - **Sign.** Amounts that can be negative, such as a profit or loss, carry a leading `-`: `"-50.00"`. `amountCents` is negative too: `-5000`. - **Currency.** Amounts are in your account currency, USD. ## The stake you send `stake` on `POST /v1/orders` takes `amount` and `currency` only: the API does not read `amountCents` on input. These rules apply: | Field | Rule | Error | |---|---|---| | `stake.amount` | Positive, at most two decimals: `"50"`, `"50.5"` and `"50.50"` are valid | `400 INVALID_STAKE` | | `stake.currency` | Your account currency, `"USD"` | `400 CURRENCY_NOT_SUPPORTED` | The stake is the total of the order. Apexium splits it across bookmakers; each bet shows its own `requestedStake` and `filledStake`. ## Prices Prices are decimal odds, written as strings: `"1.95"`. - **`minPrice`.** The price floor you send: at least `1.001`, at most four decimals. - **`filledPrice`.** The price a bet was accepted at. - **`averageFilledPrice`.** The stake-weighted price of an order's filled bets. ## Balance `GET /v1/balance` returns four amounts: | Field | Meaning | |---|---| | `cashBalance` | Your cash | | `givenCredit` | The credit your agent gives you | | `exposure` | What your bets not settled yet hold: their stake, or for a retail account the full liability, unmatched commitments and commission included | | `available` | What you can stake now: `givenCredit` + `cashBalance` − `exposure`, or `cashBalance` − `exposure` for a retail account | An order whose stake exceeds `available` is refused with `400 INSUFFICIENT_FUNDS`. --- ## Coming from OddsPapi - What changes when you move to the Apexium API Source: /guides/coming-from-oddspapi --- 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](/api-reference/overview#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](/api-reference/market-data); 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 | **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](/websocket/close-codes). 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](/websocket/feed-channels). 5. Handle `4003` as final, and `4004` as a limit. --- ## API overview - Base URLs, conventions and endpoints Source: /api-reference/overview --- ## 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](/api-reference/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`. ``` /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](/websocket/overview#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](/guides/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](/api-reference/errors). ## 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 curl https://api.apexiumbet.com/v1/health ``` ```json { "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](/api-reference/limits#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 curl "https://api.apexiumbet.com/v1/en/fixtures/odds?fixtureId=id1000001761300868" \ -H "x-api-key: apx_live_…" ``` See [Market data and identifiers](/api-reference/market-data) 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](/guides/feed-odds-and-betslip). ### Orders | Endpoint | What it does | |---|---| | `POST /v1/orders` | Previews or places an order; see [Preview and place](/guides/preview-and-place) | | `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](/guides/cancellation) | | `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. --- ## Market data and identifiers - OddsPapi v5 through Apexium Source: /api-reference/market-data --- The market data of the Apexium API is **OddsPapi v5**: the same paths, parameters, responses and identifiers, under `/v1/{lang}` (see [Languages](/api-reference/overview#languages)). The `fixtureId`, `outcomeId` and `playerId` you read in the odds are the ones you place orders on: there is no mapping between the data and the execution. OddsPapi documents every field of this data in its own documentation, at [docs.oddspapi.io](https://docs.oddspapi.io). Moving a client that already uses OddsPapi? See [Coming from OddsPapi](/guides/coming-from-oddspapi). ## Sports, tournaments, seasons - **`sportId`.** Integer. Its two digits start several other identifiers. List them with [`GET /v1/{lang}/sports`](/coverage). - **`tournamentId`.** Integer. Belongs to one sport. List them with `GET /v1/{lang}/tournaments`. - **`seasonId`.** Integer. Belongs to one tournament. List them with `GET /v1/{lang}/seasons`. ## Entity hierarchy Everything hangs off one tree: ``` Sport └── Tournament (recurring competition) └── Season (time-bound instance) └── Fixture (single match) ├── Participants (teams / competitors) ├── Scores (per period) └── Players (squad members) ``` A **tournament** is the recurring competition ("Premier League"); a **season** is one instance of it ("Premier League 25/26"); a **fixture** is one match in it: ``` Sport: Soccer (sportId=10) Tournament: Premier League (tournamentId=17) Season: Premier League 25/26 (seasonId=130281) Fixture: Arsenal vs Chelsea (fixtureId=id1000001770366972) ├── participant1Id → Arsenal ├── participant2Id → Chelsea ├── Scores: result 2-1, p1 1-0, p2 1-1 (per-period rows) └── Players: squads per participant (player markets) ``` - **The fixture.** It carries the schedule and state: `startTime` (epoch seconds), `statusId`, `participant1Id` and `participant2Id`, `seasonId`, venue. - **Scores.** They are per period, keyed `result`, `p1`, `p2`, and so on. The `result` row is the authoritative final or current score. - **Odds.** They attach to a fixture through the [odds identifiers](#odds-identifiers). ## Markets and outcomes Every selection follows a fixed hierarchy: `marketType → period → handicap → side`, all encoded in the `outcomeId`. The same bet therefore always has the same `marketId` and `outcomeId`, whatever the bookmaker. The player is the one part not in `outcomeId`: it is `playerId`. ### How markets decompose Every `outcomeId` comes from one deterministic decomposition: ``` marketType → period → handicap (line value) → side (outcome) [+ optional player] ``` | Level | Field | Meaning | |-------|-------|---------| | 1 | `marketType` | The kind of market: `1x2`, `totals`, `spreads`, `spreads-european`, `bothteamsscore`, `drawnobet`, `oddeven`, … | | 2 | `period` | The segment the market applies to: `fulltime`, `p1`, `p2` | | 3 | `handicap` | The line value, for example `2.5` or `-0.25`. Each line value is its own `marketId`. `0.0` for markets without a line, such as `1x2` | | 4 | `outcomeName` | The side: `Over` / `Under`, `1` / `X` / `2`, `Yes` / `No`, … | Because every line value has its own `marketId`, "Over 2.5" and "Over 3.5" are different markets. Within one `marketId`, the outcomes are only the sides of that exact line. Each `marketId` equals its first `outcomeId`, and each line value is its own market: | marketId | marketName | marketType | period | handicap | outcomeId | outcomeName | |---------:|------------|------------|--------|---------:|----------:|-------------| | 101 | Full Time Result | `1x2` | fulltime | 0.0 | 101 | 1 | | 101 | Full Time Result | `1x2` | fulltime | 0.0 | 102 | X | | 101 | Full Time Result | `1x2` | fulltime | 0.0 | 103 | 2 | | 104 | Both Teams To Score | `bothteamsscore` | fulltime | 0.0 | 104 | Yes | | 104 | Both Teams To Score | `bothteamsscore` | fulltime | 0.0 | 105 | No | | 1010 | Over Under Full Time | `totals` | fulltime | 2.5 | 1010 | Over | | 1010 | Over Under Full Time | `totals` | fulltime | 2.5 | 1011 | Under | | 1068 | Asian Handicap | `spreads` | fulltime | -0.5 | 1068 | 1 | | 1068 | Asian Handicap | `spreads` | fulltime | -0.5 | 1069 | 2 | | 10208 | First Half Result | `1x2` | p1 | 0.0 | 10208 | 1 | | 10208 | First Half Result | `1x2` | p1 | 0.0 | 10209 | X | | 10208 | First Half Result | `1x2` | p1 | 0.0 | 10210 | 2 | The first row reads: `marketType=1x2`, `period=fulltime`, `handicap=0.0`, `outcomeName=1`, the home side of the full-time result. The full map of a sport comes from `GET /v1/{lang}/markets?sportId=10`. ### `marketId` and `outcomeId` - **Shared `marketId`.** All the outcomes of a market share its `marketId`. - **First outcome.** The first `outcomeId` of a market equals its `marketId`, so you can group outcomes without extra metadata. - **`marketLength`.** The number of outcomes under a `marketId`: the sides that together form the full probability space. `1x2` has 3. - **Structure.** Both are integers built as `{sportId (2 digits)}{incrementing number}`: `11xxxx` is basketball, `14xxxx` American football. All the outcomes of one `marketId` cover every result. Group odds by `marketId` for margin, overround and arbitrage calculations. ## Participants and players - **`participantId`.** Integer, a team or competitor. List them with `GET /v1/{lang}/participants`. - **`playerId`.** Integer, for player markets. `0` means a market that is not about a player. List them with `GET /v1/{lang}/players`. ## Fixture IDs `fixtureId` is a string that encodes several pieces of information: ``` id1100013262926199 ``` - `id`: namespace prefix; treat it as opaque - `11`: `sportId` (2 digits) - `000132`: `tournamentId` (6 digits) - `62926199`: native fixture ID From the `fixtureId` alone you can read the sport and the tournament. ## Odds identifiers A price is identified by its `oddsId`: ``` {fixtureId}:{bookmaker}:{outcomeId}:{playerId} ``` For example `id1400003160574217:sharpbet:141:0`. Use it as the primary key of the prices you store. Drop the bookmaker and you have the **selection**, `{fixtureId}:{outcomeId}:{playerId}`: the same bet at every bookmaker, which wins or loses the same way everywhere. ## From odds to an order An order names a selection with the same three identifiers. To back the price above: ```json { "mode": "preview", "clientOrderId": "my-order-0003", "fixtureId": "id1400003160574217", "outcomeId": 141, "playerId": 0, "side": "back", "bookmakers": ["sharpbet"], "stake": { "amount": "100.00", "currency": "USD" }, "minPrice": "1.90", "acceptBetterOdds": true, "acceptPartialStake": true } ``` - **Price floor.** `minPrice` is the lowest price you accept: the price you read, or a little below to allow for movement. - **Bookmakers.** Leave `bookmakers` out to let Apexium split the stake across every bookmaker of your account. - **Betslip price.** [`GET /v1/betslip`](/api-reference/overview#betslip) gives the price after your account's rules, which can differ from the market price. See [Feed odds and the betslip](/guides/feed-odds-and-betslip). See [Preview and place](/guides/preview-and-place). ## Timestamps The market data uses OddsPapi's two units: - **Epoch seconds** for schedules: `startTime`, `startTimeFrom`, `startTimeTo`. - **Epoch milliseconds** for odds updates: `changedAt`, `bookmakerChangedAt`, and the `since` filters. The `/v1` endpoints of the account and its orders use ISO 8601 strings in UTC instead. ## Efficient polling - **`since`.** On `fixtures/odds` and `fixtures/odds/main`, pass the last `changedAt` you saw to get only what changed since then. - **Storage.** Store prices keyed by `oddsId`, so updates replace rows instead of adding them. - **Limits.** Market data counts against your key's general budget; see [Limits](/api-reference/limits). ## Historical odds and CLV | Purpose | Endpoint | |---|---| | Full price timeline of an outcome | `GET /v1/{lang}/fixtures/odds/historical` | | Opening and closing line (OLV / CLV) | `GET /v1/{lang}/fixtures/odds/clv` | Both use the same `oddsId`, so you can join your fills to their history: - **CLV.** Compare the price you were filled at with the closing line to measure your edge. - **Fill auditing.** Compare your fill prices with the recorded timeline. - **Backtesting.** Replay the timeline against your strategy. ## Reference The market data endpoints are in the **API → Reference** sidebar, under **Reference data**, **Fixtures** and **Odds**. Their parameters and response schemas come from the OddsPapi v5 reference, limited to what Apexium forwards. For background on the data itself, see the [OddsPapi documentation](https://docs.oddspapi.io). ## Glossary - **sportId**: numeric sport identifier; the first two digits of `marketId`, `outcomeId` and `fixtureId`. - **fixtureId**: string key of a match, encoding sport, tournament and a native ID. - **marketType**: the kind of market (`1x2`, `totals`, `spreads`, …). - **period**: the segment a market applies to (`fulltime`, `p1`, `p2`). - **handicap**: the line value of a market; each line value is its own `marketId`. - **marketId**: integer grouping the outcomes of one market; equals its first `outcomeId`. - **marketLength**: the number of outcomes under a `marketId`. - **outcomeId**: integer identifying one selection: market type, period, line and side. - **playerId**: ties an outcome to a player; `0` is a market not about a player. - **participantId**: integer identifying a team or competitor. - **oddsId**: price key, `{fixtureId}:{bookmaker}:{outcomeId}:{playerId}`. - **OLV / CLV**: opening and closing line value, the first and last recorded prices of an outcome. --- ## Authentication - API keys, rotation and revocation Source: /api-reference/authentication --- Every request carries an API key in the `x-api-key` header. The key identifies your account: every order, bet and figure the API returns belongs to it. The one exception is [`GET /v1/health`](/api-reference/overview#health), which needs no key. A key sent to it is ignored. ```bash curl https://api.apexiumbet.com/v1/me \ -H "x-api-key: apx_live_…" ``` ## Getting a key 1. **Access.** Your agent enables API access on your account. Until then, you cannot create a key. 2. **Key.** In the dashboard, open **Preferences → API** and create a key. 3. **Storage.** The key is shown once, in full. Apexium stores only a hash of it and cannot show it again: keep it in a secret manager. The dashboard then shows only its prefix and its last four characters. Keys look like `apx_live_…`. A test environment, with its own base URL and keys, is available on request while you integrate. A key only works in the environment that issued it. ## Live keys You can have **two live keys** at a time. That is enough to rotate without downtime. To create a third, revoke one first. ## Rotating a key Rotate a key from the same place. Rotation issues a new key and sets an end date on the old one. You choose when the old key stops working: | Option | The old key stops | |---|---| | Now | immediately | | In 1 hour | one hour later | | In 24 hours | one day later | | In 7 days | one week later | Deploy the new key while both work, then let the old one expire. Rotation needs a free slot: with two live keys, revoke one before rotating the other. ## Revoking a key Revoking stops a key immediately. Revoke a key as soon as you suspect it leaked. If your agent withdraws API access from the account, every key of the account stops at once. ## Failed authentication A request without a key, or with a key that is unknown, revoked or expired, gets `401 INVALID_API_KEY`. A valid key gets `403 API_ACCESS_DENIED` when the account no longer has API access or is suspended. Repeated failures from the same address are throttled: after 20 failed requests in one minute, every request from that address gets `429 RATE_LIMITED` until the minute ends, whatever key it carries. See [Limits](/api-reference/limits). ## Request identifiers Every response carries an `x-request-id` header. Quote it when you contact support about a request. --- ## Errors - Status codes and error codes Source: /api-reference/errors --- Errors share one body: ```json { "code": "INVALID_STAKE", "message": "stake.amount must be a positive decimal with at most 2 decimals" } ``` - `code` is stable: branch on it. - `message` is for humans and may change. - `details` is present on some errors and described below. New codes can be added. Treat an unknown code like any other error of its HTTP status. ## Request errors | Code | Status | Meaning | |---|---|---| | `VALIDATION_FAILED` | 400 | The request does not match the schema. `details.errors` lists `{ field, message }` pairs. | | `MODE_REQUIRED` | 400 | `mode` is missing on `POST /v1/orders`. It must be `"preview"` or `"place"`; there is no default. | | `INVALID_STAKE` | 400 | `stake.amount` is not a positive decimal with at most two decimals. | | `INVALID_PRICE` | 400 | `minPrice` is below 1.001. | | `INVALID_EXPIRY` | 400 | `expiresAt` is in the past or more than one hour ahead. | | `CURRENCY_NOT_SUPPORTED` | 400 | `stake.currency` is not the account currency. | | `BOOKMAKER_NOT_AVAILABLE_VIA_API` | 400 | A requested bookmaker is closed to the API, even if it is enabled on your account. | | `INVALID_CURSOR` | 400 | The pagination cursor is invalid. Restart the listing without one. | | `INVALID_WINDOW` | 400 | `from` is not before `to`, or the window is longer than 366 days. | | `NOT_FOUND` | 404 | No such resource on your account, or no such path. | ## Authentication and access | Code | Status | Meaning | |---|---|---| | `INVALID_API_KEY` | 401 | The key is missing, unknown, revoked or expired. | | `API_ACCESS_DENIED` | 403 | The account no longer has API access, or is suspended. | | `ACCOUNT_NOT_ACTIVE` | 403 | The account cannot place orders in its current status. | | `BOOKMAKER_NOT_AVAILABLE` | 403 | A requested bookmaker is not available on your account. | | `BETTING_NOT_ALLOWED` | 403 | Your account's rules do not allow betting on this selection. | | `FORBIDDEN` | 403 | The request is not allowed. | ## Order rejections These are the checks made before anything is sent to a bookmaker. When one fails, nothing is recorded: no order, no bet. Once the checks pass, the order is recorded. A bookmaker that then declines does not make the request fail. The order comes back with `201`, and each declined bet carries its `declineReason`. When every bet is declined, the order's status is `REJECTED`. | Code | Status | Meaning | |---|---|---| | `INSUFFICIENT_FUNDS` | 400 | The available balance does not cover the stake. | | `MAX_STAKE_PER_FIXTURE_EXCEEDED` | 400 | The stake exceeds your maximum for this fixture. `details` holds `maxStake`, `existingStake` and `remaining`. | | `PRICE_NOT_AVAILABLE` | 400 | No active price at the requested bookmakers. | | `PRICE_CHANGED` | 400 | The price moved below `minPrice`. | | `NO_LIQUIDITY` | 400 | No liquidity at or above `minPrice`. | | `INSUFFICIENT_LIQUIDITY` | 400 | The liquidity does not cover the full stake, and `acceptPartialStake` is `false`. | | `CLIENT_ORDER_ID_REUSED` | 409 | The `clientOrderId` belongs to an order with different terms. See [Idempotency](/guides/idempotency). | | `PREVIOUS_ATTEMPT_UNRESOLVED` | 409 | An earlier attempt with this `clientOrderId` is still being resolved. Retry the same request later. | | `ORDER_BUSY` | 409 | The order is being worked on right now. Retry the cancellation. | | `CONFLICT` | 409 | The request conflicts with the current state. | ## Service errors | Code | Status | Meaning | Retry | |---|---|---|---| | `RATE_LIMITED` | 429 | Too many requests. See [Limits](/api-reference/limits). | After `retry-after` seconds | | `INTERNAL_ERROR` | 500 | Unexpected error. | Yes, with backoff | | `UPSTREAM_UNAVAILABLE` | 502 | The bookmaker gateway did not answer. The order may or may not exist. | Resend the same request with its `clientOrderId` to read the order | | `FEED_UNAVAILABLE` | 502 | The market data service did not answer. | Yes, with backoff | | `BETTING_SUSPENDED` | 503 | Betting is suspended for this selection or bookmaker. | Later | | `EXPIRY_NOT_AVAILABLE` | 503 | Orders with `expiresAt` are not available on this environment. | Without `expiresAt` | | `BALANCE_UNAVAILABLE` | 409 | The balance cannot be read right now. | Yes, shortly | | `PUBLIC_API_DISABLED` | 503 | The API is temporarily disabled. | Later | | `SERVICE_UNAVAILABLE` | 503 | The service is temporarily unavailable. | Yes, with backoff | | `FEED_TIMEOUT` | 504 | The market data service took too long to answer. | Yes, with backoff | Every response carries an `x-request-id` header. Quote it when you report an error. --- ## Limits - Rate limits and request limits Source: /api-reference/limits --- ## Rate limits Each key has three budgets, counted over one minute: | Budget | Endpoints | Requests per minute | |---|---|---| | Placements | `POST /v1/orders`, previews included | 600 | | Betslip | `GET /v1/betslip` | 60 | | Everything else | every other endpoint, market data included | 600 | Cancellations count against no budget: `POST /v1/orders/{id}/cancel` and `POST /v1/orders/cancel-all` are not rate-limited per key, so you can always pull your orders. The budgets are separate: reading orders does not consume the placement budget. Over a budget, requests get `429 RATE_LIMITED` with these headers: | Header | Meaning | |---|---| | `retry-after` | Seconds until the budget refills | | `x-ratelimit-limit` | Requests allowed per minute | | `x-ratelimit-remaining` | Always `0` on a refusal | | `x-ratelimit-reset` | Seconds until the budget refills | Wait `retry-after` seconds before you retry. To place many orders, spread them over the minute rather than bursting. ## Health check [`GET /v1/health`](/api-reference/overview#health) carries no key, so it has its own budget per address: 120 requests per minute. Over it, requests get the same `429 RATE_LIMITED` and headers. Its result is refreshed at most every 15 seconds, so polling every 15 seconds is enough. ## Failed authentication After 20 failed authentications from the same address within one minute, every request from that address gets `429 RATE_LIMITED` until the minute ends, whatever key it carries. A client that retries with a revoked key can lock itself out this way: check the key first. See [Authentication](/api-reference/authentication#failed-authentication). ## Request limits | What | Limit | |---|---| | `clientOrderId` | 1 to 200 characters, unique per account | | `bookmakers` on an order | 1 to 50 | | `stake.amount` | positive, at most two decimals | | `minPrice` | at least 1.001, at most four decimals | | `expiresAt` | in the future, at most one hour ahead | | `POST /v1/orders/cancel-all` | 200 orders per call; continue with `nextCursor` | | `GET /v1/pnl` window | at most 366 days | Your account also has its own limits, such as a maximum stake per fixture. They are applied to every order and shown by [`GET /v1/betslip`](/api-reference/overview#betslip). ## WebSocket | Limit | Value | |---|---| | Connections per API key | 8 | | Fixtures per account, summed over its connections | 500 | | Betslip selections per account, summed over its connections | 50 | | Send buffer of a connection that reads too slowly | closed with `4002` above 4 MB, or when not empty for more than 5 seconds | Over the connection, fixture or selection limit, the server refuses with `4004 limit_exceeded`. See [Close codes](/websocket/close-codes#4004) for what each code means and what to do. --- ## WebSocket - Live market data and order updates on /v1/ws Source: /websocket/overview --- One WebSocket carries both the market data and the state of your account: your balance, the bookmakers and currencies, the fixtures, scores and clocks, the odds, the betslip of the selections you follow, and your orders. ``` wss://api.apexiumbet.com/v1/ws ``` ## Log in Send a `login` frame as the first message, within 10 seconds of the connection: ```json { "type": "login", "apiKey": "apx_live_…", "receiveType": "zstd", "channels": ["odds", "fixtures", "scores", "orders", "balance"], "fixtureIds": ["id1000001770366972"], "sportIds": [10], "lang": "en" } ``` | Field | Type | Default | Description | |---|---|---|---| | `apiKey` | string | required | The same key as on REST | | `receiveType` | string | `json` | `json`, `binary` or `zstd`. Production accepts `zstd` only. See [Encodings](/websocket/encodings) | | `channels` | string[] | every channel | Any of `balance`, `bookmakers`, `currencies`, `fixtures`, `scores`, `clocks`, `odds`, `betslip`, `orders`. See [Channels](#channels) | | `fixtureIds` | string[] | none | Fixtures to follow on `odds`, `bookmakers`, `fixtures`, `scores` and `clocks` | | `tournamentIds` | integer[] | none | Tournaments to follow on `fixtures`, `scores` and `clocks`; not on `odds`, see [Feed channels](/websocket/feed-channels#what-you-receive) | | `sportIds` | integer[] | none | Sports to follow on `fixtures`, `scores` and `clocks`; not on `odds` | | `lang` | string | `en` | Language of the `fixtures` channel. See [Languages](#languages) | | `sinceEventId` | integer | none | Resume the `orders` channel. See [Orders](/websocket/orders#resume) | The server answers `login_ok` with what it applied: ```json { "type": "login_ok", "connectionId": "3d9a7f52-…", "sub": "8b0c6e0e-…", "lang": "en", "receiveType": "zstd", "channels": ["odds", "fixtures", "scores", "orders", "balance"], "sportIds": [10], "tournamentIds": [], "fixtureIds": ["id1000001770366972"], "limits": { "connections": 8, "fixtures": 500, "betslips": 50 } } ``` `connectionId` is a UUID that identifies this connection. Quote it when you report a problem. A refused login closes the connection with [`4001`](/websocket/close-codes). One connection logs in once: a second `login` frame gets an `error` frame. ## Change what you follow Add or remove fixtures, tournaments and sports without reconnecting: ```json { "type": "subscribe", "fixtureIds": ["id1000001770366973"] } { "type": "unsubscribe", "sportIds": [10] } ``` The server answers `subscribed` or `unsubscribed` with the whole selection now in force. The channels are fixed at login. ## Channels | Channel | Carries | Routed by | |---|---|---| | [`balance`](/websocket/balance) | Your balance: the current one, then every change | your account | | [`bookmakers`](/websocket/feed-channels#channels) | Bookmaker-level changes on a fixture | `fixtureIds` | | [`currencies`](/websocket/feed-channels#channels) | Exchange rates | every connection on the channel | | [`fixtures`](/websocket/feed-channels#channels) | Fixture changes: schedule, status, participants | `fixtureIds`, `tournamentIds`, `sportIds` | | [`scores`](/websocket/feed-channels#channels) | Score changes | `fixtureIds`, `tournamentIds`, `sportIds` | | [`clocks`](/websocket/feed-channels#channels) | Match clock changes | `fixtureIds`, `tournamentIds`, `sportIds` | | [`odds`](/websocket/feed-channels#channels) | Odds changes of your bookmakers | `fixtureIds` | | [`betslip`](/websocket/betslip) | The price and stake limits of the selections you subscribe to, after your account's rules | your subscriptions | | [`orders`](/websocket/orders) | Your orders: a snapshot, then every change | your account | `bookmakers`, `currencies`, `fixtures`, `scores`, `clocks` and `odds` are the [feed channels](/websocket/feed-channels): they carry changes only, and you load the current state from `/v1/{lang}`. `balance`, `betslip` and `orders` are the execution channels: they carry the state of your account. ## Envelope Every channel message has the same envelope: ```json { "channel": "odds", "type": "UPDATE", "payload": { "fixtureId": "id1000001770366972", "odds": { "…": "…" } }, "ts": 1791413359090 } ``` - **`channel`** and **`type`** tell you how to read `payload`. - **`ts`** is a Unix time in milliseconds. On feed channels, it is when Apexium received the message; on execution channels, when it sent it. - **`seq`** is present on execution channels only. It counts the execution messages of this connection and starts again at 1 on every connection. It is not a resume cursor: resume `orders` with `eventId`. Control frames have a `type` and no `channel`: `login_ok`, `subscribed`, `unsubscribed`, `betslip_subscribed`, `betslip_unsubscribed`, `snapshot_required`, `reconnect` and `error`. They are always JSON text frames, whatever your `receiveType`. An `error` frame reports a frame the server could not apply, and the connection stays open: ```json { "type": "error", "error": "bad_request", "message": "fixtureIds must be an array of fixture ids", "connectionId": "3d9a7f52-…" } ``` Every `error` frame carries the `connectionId` of the connection, including one sent before `login_ok` or right before a close. ## Limits | Limit | Value | Past it | |---|---|---| | Connections per API key | 8 | `4004` at login | | Fixtures per account, summed over its connections | 500 (`fixtureIds` only) | `4004` at login or on `subscribe` | | Betslip selections per account, summed over its connections | 50 | `4004` on `subscribeBetslip` | | Client frame size | 64 kB | the connection is closed with `1009` | | Time to send `login` | 10 seconds | `4001` | A connection that reads too slowly is closed with `4002`. See [Close codes](/websocket/close-codes). ## Heartbeat The server sends a WebSocket ping every 30 seconds. Client libraries answer with a pong on their own. A connection that leaves two pings in a row unanswered is dropped. You do not need to send pings yourself. ## Reconnect Reconnect after any close, with an exponential backoff and a random jitter: for example 1 second, then doubling up to 30 seconds, each delay multiplied by a random factor between 0.5 and 1.5. The jitter keeps your connections from all coming back in the same instant. After a reconnect: - **Feed channels.** Load the state of your fixtures again from `/v1/{lang}`, then apply the messages. - **`orders`.** Log in with `sinceEventId` to receive what you missed. See [Orders](/websocket/orders#resume). - **`balance`.** The current balance arrives right after `login_ok`. - **`betslip`.** Send your `subscribeBetslip` frames again. Before a planned restart, the server sends `{ "type": "reconnect", "reason": "server_restart" }` and closes with `1012`: reconnect at once. ## Languages The `lang` of the login applies to the `fixtures` channel: the names of the sport, tournament, status, participants and venue follow it when a translation exists. It takes the same values as the [market data paths](/api-reference/overview#languages). The other channels carry identifiers and numbers only, and identifiers never depend on the language. ## Bookmakers The `odds` and `bookmakers` channels carry only the bookmakers that `GET /v1/me` lists: those of your account, except any closed to the API. A message left with none of your bookmakers is not sent. When that list changes, open connections follow within a few seconds. --- ## WebSocket encodings - JSON, MessagePack and zstd Source: /websocket/encodings --- You choose the encoding of channel messages with `receiveType` at login. | `receiveType` | Frame | Content | |---|---|---| | `json` | text | The envelope as JSON | | `binary` | binary | The envelope as [MessagePack](https://msgpack.org) | | `zstd` | binary | The envelope as JSON, compressed with [zstd](https://facebook.github.io/zstd/) | Production accepts `zstd` only. A login with another `receiveType` is refused with `4001`. The odds feed is several megabits per second for a client that follows many fixtures, and zstd makes it about four times smaller. - **Control frames.** `login_ok`, `subscribed`, `snapshot_required`, `error` and the other control frames are always JSON text frames, whatever the `receiveType`. Tell them apart by the frame type: text is a control frame, binary is a channel message. - **One frame, one message.** Each binary frame holds exactly one message, compressed on its own. There is no dictionary and no state between frames. ## Decode in Python With [`websockets`](https://pypi.org/project/websockets/) and [`zstandard`](https://pypi.org/project/zstandard/): ```python import asyncio import json import websockets import zstandard URL = "wss://api.apexiumbet.com/v1/ws" LOGIN = { "type": "login", "apiKey": "apx_live_…", "receiveType": "zstd", "channels": ["odds", "orders"], "fixtureIds": ["id1000001770366972"], } decompressor = zstandard.ZstdDecompressor() async def main(): async with websockets.connect(URL) as ws: await ws.send(json.dumps(LOGIN)) async for frame in ws: if isinstance(frame, str): control = json.loads(frame) print("control", control["type"], control) continue message = json.loads(decompressor.decompress(frame)) print(message["channel"], message["type"], message["ts"]) asyncio.run(main()) ``` For `binary`, decode with [`msgpack`](https://pypi.org/project/msgpack/) instead: `message = msgpack.unpackb(frame)`. ## Decode in Node.js Node.js 22.15 or later decompresses zstd natively. With [`ws`](https://www.npmjs.com/package/ws): ```js import { zstdDecompressSync } from 'node:zlib'; import WebSocket from 'ws'; const ws = new WebSocket('wss://api.apexiumbet.com/v1/ws'); ws.on('open', () => ws.send( JSON.stringify({ type: 'login', apiKey: 'apx_live_…', receiveType: 'zstd', channels: ['odds', 'orders'], fixtureIds: ['id1000001770366972'], }) ) ); ws.on('message', (data, isBinary) => { if (!isBinary) { const control = JSON.parse(data.toString()); console.log('control', control.type, control); return; } const message = JSON.parse(zstdDecompressSync(data).toString()); console.log(message.channel, message.type, message.ts); }); ``` For `binary`, decode with [`msgpackr`](https://www.npmjs.com/package/msgpackr) instead: `const message = unpack(data)`. --- ## WebSocket close codes - Why a connection closed and what to do Source: /websocket/close-codes --- Before it closes a connection, the server sends a frame that names the reason: an `error` frame, or a `reconnect` frame before a restart. ```json { "type": "error", "error": "limit_exceeded", "message": "Fixture limit reached: 500 per account across its connections", "connectionId": "3d9a7f52-…" } ``` The same value is the close reason. Like every `error` frame, it carries the [`connectionId`](/websocket/overview#log-in) of the connection. | Code | Reason | Meaning | What to do | |---|---|---|---| | `4001` | `bad_login`, `login_failed`, `login_timeout` | The login frame was invalid, the key was refused, or no login came within 10 seconds | Fix the login. Do not retry a refused key in a loop: see [Failed logins](#failed-logins) | | `4002` | `backpressure` | The connection read too slowly | Reconnect, reload the feed channels, and read faster. See [4002](#4002) | | `4003` | `access_revoked` | The key, the API access or the account is no longer active | Do not reconnect with this key | | `4004` | `limit_exceeded` | Too many connections for the key, fixtures for the account, or betslip selections for the connection | Follow fewer fixtures or close other connections, then reconnect. See [4004](#4004) | | `1011` | `internal_error` | The server failed to handle a frame | Reconnect with backoff | | `1012` | `server_restart` | The server is restarting; a `reconnect` frame came first | Reconnect at once | | `1013` | `public_api_disabled` | The API is turned off for maintenance or an incident | Reconnect with backoff; check the [status page](https://apexiumbet.instatus.com) | A code without a frame, such as `1006`, means the connection was cut: reconnect with backoff. ### 4002 Apexium closes a connection whose send buffer passes 4 MB, or stays not empty for more than 5 seconds. The other clients keep receiving. Your client may see `1006` instead of `4002`: the close frame waits behind the full buffer, and the connection is cut before it arrives. Treat a `1006` that follows a burst of traffic as a `4002`. After either, reload the feed channels from `/v1/{lang}`: some changes were not delivered. See [Feed channels](/websocket/feed-channels#read-too-slowly-get-closed) for how to keep up. ### 4004 | Limit | Value | |---|---| | Connections per API key | 8 | | Fixtures per account, summed over its connections | 500 | | Betslip selections per account, summed over its connections | 50 | The fixture limit counts `fixtureIds` only; `sportIds` and `tournamentIds` do not count. It applies at login and on every `subscribe` that adds fixtures. A refused `subscribe` keeps nothing of the new selection. ## Refused at connection time Some refusals come before the WebSocket opens, as an HTTP response to the upgrade: | Status | `code` | Meaning | What to do | |---|---|---|---| | `429` | `RATE_LIMITED` | Too many failed logins from your address | Wait for the `Retry-After` seconds | | `503` | `PUBLIC_API_DISABLED` | The API is turned off | Retry with backoff | ### Failed logins Failed logins count with failed REST authentications: after 20 within one minute from the same address, connections from that address are refused until the minute ends. See [Limits](/api-reference/limits#failed-authentication). --- ## WebSocket balance channel - Live credit, cash, exposure and available balance Source: /websocket/balance --- The `balance` channel sends the balance of the account behind your API key. Right after `login_ok`, and then whenever one of the four amounts changes, you receive: ```json { "channel": "balance", "type": "balance", "payload": { "givenCredit": { "amount": "5000.00", "amountCents": 500000, "currency": "USD" }, "cashBalance": { "amount": "120.00", "amountCents": 12000, "currency": "USD" }, "exposure": { "amount": "830.50", "amountCents": 83050, "currency": "USD" }, "available": { "amount": "4289.50", "amountCents": 428950, "currency": "USD" } }, "ts": 1791413359090, "seq": 1 } ``` The payload has the shape and the values of [`GET /v1/balance`](/api-reference/overview#account). A change usually arrives within half a second: a placement, a fill, a cancellation, a settlement, or a credit or cash change on the account. Each message carries the whole balance, so the channel has no `eventId` and no resume. After a reconnect, the current balance arrives right after `login_ok`. --- ## WebSocket feed channels - bookmakers, currencies, fixtures, scores, clocks, odds Source: /websocket/feed-channels --- The feed channels carry OddsPapi v5 market data. Their payloads are OddsPapi's, unchanged except for the bookmakers, which are limited to your account. ## Channels | Channel | Carries | Payload, field by field | |---|---|---| | `bookmakers` | Bookmaker-level changes on a fixture | [OddsPapi `bookmakers`](https://docs.oddspapi.io/websocket/channels/bookmakers) | | `currencies` | Exchange rates | [OddsPapi `currencies`](https://docs.oddspapi.io/websocket/channels/currencies) | | `fixtures` | Fixture changes: schedule, status, participants | [OddsPapi `fixtures`](https://docs.oddspapi.io/websocket/channels/fixtures) | | `scores` | Score changes | [OddsPapi `scores`](https://docs.oddspapi.io/websocket/channels/scores) | | `clocks` | Match clock changes | [OddsPapi `clocks`](https://docs.oddspapi.io/websocket/channels/clocks) | | `odds` | Odds changes of your bookmakers | [OddsPapi `odds`](https://docs.oddspapi.io/websocket/channels/odds) | The [OddsPapi WebSocket channels](https://docs.oddspapi.io/websocket/channels) documentation describes them together. ## Load, then apply changes The feed channels carry **changes only**. They never send the current state of a fixture. Build it in three steps: Open the socket and log in with the channels and fixtures you want. Keep the messages that arrive from now on. Read the fixtures and their odds from `/v1/{lang}`, for example [`GET /v1/en/fixtures/odds`](/api-reference/market-data). Apply the messages you kept, then every new one, on top of what you loaded. Connecting before loading means no change is lost between the two. A change that was already in the loaded state is harmless to apply again. ## Reload on `snapshot_required` When Apexium cannot guarantee that you received every change, it tells you which channels to reload: ```json { "type": "snapshot_required", "reason": "feed_interrupted", "channels": ["odds", "scores"] } ``` Load the state of these channels again from `/v1/{lang}`, then keep applying the messages. This happens when: - **The feed source was interrupted** and Apexium has just subscribed to it again. - **Apexium fell behind the feed** by more than one second: it discards what it could not send in time rather than send old prices, and asks the clients concerned to reload. Every message sent before `snapshot_required` is older than the state you reload. A connection receives `snapshot_required` at most once every 10 seconds, which leaves you time to reload. Channels that need a reload within those 10 seconds come in one `snapshot_required` when they end. ## What you receive - **`odds` and `bookmakers`** come for the fixtures in your `fixtureIds` only. Following a sport or a tournament does not bring its odds. - **`fixtures`, `scores` and `clocks`** come for your `fixtureIds`, and for every fixture of your `tournamentIds` and `sportIds`. - **`currencies`** comes to every connection on the channel. - **Bookmakers.** Odds carry only the bookmakers of your account, except any closed to the API. A message left with none of them is not sent. - **Language.** `fixtures` follows the `lang` of your login. See [Languages](/websocket/overview#languages). Odds are most of the feed, so you follow them fixture by fixture, within the [fixture limit](/websocket/close-codes#4004) of your account. To trade a whole tournament: 1. Log in with its `tournamentIds` on `fixtures`, or read its fixtures from `/v1/{lang}`. 2. Send `{ "type": "subscribe", "fixtureIds": [...] }` with the fixtures you trade, and their odds start. 3. Send `unsubscribe` for a fixture once it is over, to free its place. ## Read too slowly, get closed Apexium sends each client what it can absorb. A connection whose send buffer stays full is closed with `4002`, and the other clients are not slowed down. See [Close codes](/websocket/close-codes#4002). To keep up: - **Use `zstd`.** It makes the feed about four times smaller. See [Encodings](/websocket/encodings). - **Read in its own task.** Decode and store each message quickly; do the slow work, such as pricing or database writes, elsewhere. - **Follow what you use.** Every fixture in `fixtureIds` adds its odds to your stream. --- ## WebSocket betslip channel - Live prices and stake limits Source: /websocket/betslip --- The `betslip` channel streams what [`GET /v1/betslip`](/api-reference/overview#betslip) returns: the price and stake limits of a selection at each bookmaker, after the rules of your account. This is the price you place at. It can differ from the `odds` channel: see [Feed odds and the betslip](/guides/feed-odds-and-betslip). ## Subscribe Log in with `betslip` in `channels`, then send one frame per selection: ```json { "type": "subscribeBetslip", "fixtureId": "id1000001770366972", "outcomeId": 101, "playerId": 0, "bookmakers": ["sharpbet", "vertex"] } ``` - **`playerId`** is optional and defaults to `0`. - **`bookmakers`** is optional. Without it, every bookmaker of your account is quoted, as with `GET /v1/betslip`. The server answers with the selection and the bookmakers it quotes: ```json { "type": "betslip_subscribed", "fixtureId": "id1000001770366972", "outcomeId": 101, "playerId": 0, "bookmakers": ["sharpbet", "vertex"] } ``` ## Updates Then, and on every change of price or limit: ```json { "channel": "betslip", "type": "betslip", "payload": { "fixtureId": "id1000001770366972", "outcomeId": 101, "playerId": 0, "bookmakers": [ { "bookmaker": "sharpbet", "active": true, "price": "1.952", "minStake": { "amount": "1.00", "amountCents": 100, "currency": "USD" }, "maxStake": { "amount": "850.00", "amountCents": 85000, "currency": "USD" } } ] }, "ts": 1791413359090, "seq": 3 } ``` The payload has the shape and the values of `GET /v1/betslip`. A `price` sent as `minPrice` places at the bookmaker's current price. A change of your account's rules shows on the socket within about 10 seconds. ## Unsubscribe ```json { "type": "unsubscribeBetslip", "fixtureId": "id1000001770366972", "outcomeId": 101, "playerId": 0 } ``` The server answers `betslip_unsubscribed`. Closing the connection unsubscribes everything. ## Limits and refusals - **50 selections per account.** They are summed over its connections; one more closes the connection with [`4004`](/websocket/close-codes#4004). - **Bookmakers closed to the API** are not quoted. Naming one in `bookmakers` comes back as an `error` frame with `BOOKMAKER_NOT_AVAILABLE_VIA_API`. A subscription keeps the bookmakers it started with until you send `subscribeBetslip` again or reconnect. - **Refusals.** A selection that cannot be quoted, such as one without odds, comes back as an `error` frame with the code of the [error catalogue](/api-reference/errors). The connection stays open. - **After a reconnect**, send your `subscribeBetslip` frames again. --- ## WebSocket orders channel - Snapshot, live order updates and resume Source: /websocket/orders --- The `orders` channel sends the orders of the account behind your API key: a snapshot right after login, then the whole order every time it changes. ## Snapshot Right after `login_ok`, you receive: ```json { "channel": "orders", "type": "snapshot", "payload": { "eventId": 48213, "orders": [ { "id": "…", "version": 3, "…": "…" } ] }, "ts": 1791413359090, "seq": 1 } ``` `orders` holds every working order, plus every order that changed in the last 24 hours. Each order has the shape of [`GET /v1/orders/{id}`](/api-reference/overview#orders). ## Changes Every change to an order sends the whole order again: ```json { "channel": "orders", "type": "order", "payload": { "eventId": 48214, "order": { "id": "…", "version": 4, "status": "FILLED", "…": "…" } }, "ts": 1791413359512, "seq": 2 } ``` A change is anything that moves the order or one of its bets: a fill, a decline, a cancellation, an expiry, a settlement or a correction. For each order `id`, keep the order with the highest `version`, and ignore one with a lower or equal version: the same version can arrive twice. ## Resume `eventId` exists for resuming. Keep the highest `eventId` you received, the snapshot's included. When you reconnect, log in with it: ```json { "type": "login", "apiKey": "apx_live_…", "receiveType": "zstd", "channels": ["orders"], "sinceEventId": 48214 } ``` - **Inside the window.** At most 1 000 changes were missed and the oldest is less than 10 minutes old: the orders that changed are sent as `order` messages, then the live changes follow. No snapshot is sent. - **Outside the window.** You receive `{ "type": "snapshot_required", "reason": "resume_window_exceeded", "channels": ["orders"] }`, then a new snapshot. Replace what you held with it. A login without `sinceEventId` always starts with a snapshot. ## Without the channel A login that names `channels` without `orders` receives none of this. A login without `channels` covers every channel, `orders` included. --- ## Changelog Source: /changelog/index --- ## 2026-11-10 — Health check - **`GET /v1/health`.** Tells you whether the API is up, without an API key: `200` while it is healthy or degraded, `503` when it is unhealthy or switched off, with the state of each service. The result is refreshed at most every 15 seconds, and each address can call it 120 times per minute. See [Health](/api-reference/overview#health). ## 2026-10-29 — Bookmakers closed to the API - **Pinnacle.** Pinnacle is available through the API when it is enabled on your account. - **Bookmakers closed to the API.** Apexium can close a bookmaker to the API. It is left out of `GET /v1/me`, the betslip, the market data and the WebSocket, and naming it answers `400 BOOKMAKER_NOT_AVAILABLE_VIA_API`. See [Coverage](/coverage#what-you-can-trade). ## 2026-10-23 — Connection id on the WebSocket - **`connectionId`.** `login_ok` and every `error` frame of `/v1/ws` now carry `connectionId`, a UUID that identifies the connection. Quote it when you report a problem. See [Log in](/websocket/overview#log-in). ## 2026-10-22 — Market data paths and limits - **Market data.** The market data paths lose `/feed`: `/v1/{lang}/…` instead of `/v1/feed/{lang}/…`. The old paths answer `404`. See [Languages](/api-reference/overview#languages). - **Cancellations.** `POST /v1/orders/{id}/cancel` and `POST /v1/orders/cancel-all` count against no rate-limit budget. - **Placements.** `POST /v1/orders` has its own budget of 600 requests per minute, instead of 120 shared with cancellations. See [Limits](/api-reference/limits). - **Betslip channel.** Up to 50 selections per account, summed over its connections, instead of 10 per connection. `login_ok` reports it in `limits.betslips`. - **Documentation.** The guides move to the Welcome tab, the reference follows the order account, market data, betslip, orders, bets, and [Feed odds and the betslip](/guides/feed-odds-and-betslip) explains which price to place at. ## 2026-10-08 — Amounts in integer cents - **`amountCents`.** Every amount the API returns, over REST and on the WebSocket, now carries `amountCents`: the same amount as a whole number of cents, next to the decimal `amount`. See [Money](/guides/money). - **Stake.** The stake you send is unchanged: `amount` and `currency`. ## 2026-10-05 — `/v1` reference from the API contract The documentation now describes the API as it exists. - **Reference.** The endpoint pages are generated from the OpenAPI contract that the API exports, and the market data pages from the OddsPapi v5 reference. They replace the hand-written draft. - **Market data.** OddsPapi v5 sports, tournaments, fixtures, markets and odds, one page per path, with a page on how identifiers fit together and become orders. - **Endpoints.** Account, pricing, orders with preview and cancellation, bets, positions, PnL, and OddsPapi market data limited to your bookmakers, all under `https://api.apexiumbet.com/v1`. - **Guides.** Authentication and key rotation, errors, limits, idempotency with `clientOrderId`, preview and place, order and bet life cycle, cancellation, money format. - **Removed.** The draft described features the API does not have: tenants, scopes, bookmaker accounts, batch orders, settlement feeds, futures. Those pages are gone. - **WebSocket.** The WebSocket pages are withdrawn while they are rewritten for `/v1/ws`. ## 2026-08-12 — Initial documentation (draft) First public draft, written before the API existed. --- ## OpenAPI (REST Reference) Source: /api-reference/openapi.json --- ```json { "openapi": "3.1.0", "info": { "title": "Apexium Trading API", "version": "1", "description": "Public API, authenticated with an API key in the x-api-key header." }, "tags": [ { "name": "Health", "description": "Whether the API is up, without an API key" }, { "name": "Account", "description": "The account behind the API key and its balance" }, { "name": "Reference data", "description": "OddsPapi sports, tournaments, participants, markets and bookmakers" }, { "name": "Fixtures", "description": "OddsPapi fixtures: schedule, status, scores" }, { "name": "Odds", "description": "OddsPapi odds, limited to the account's bookmakers" }, { "name": "Betslip", "description": "The price and stake limits of one selection at each of the account's bookmakers" }, { "name": "Orders", "description": "Preview, place, read and cancel orders" }, { "name": "Bets", "description": "The bets your orders were split into" }, { "name": "Positions and PnL", "description": "Open exposure and realised results" } ], "components": { "securitySchemes": { "apiKey": { "type": "apiKey", "in": "header", "name": "x-api-key" } }, "schemas": { "Venue": { "type": "object", "properties": { "venueId": { "type": "integer", "description": "Numeric venue identifier." }, "venueSlug": { "type": "string", "description": "URL-safe venue slug." }, "venueName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Venue display name, translated per the request language prefix." }, "venueLocation": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Venue location (city), translated per the request language prefix." } }, "required": [ "venueId", "venueSlug" ], "additionalProperties": true }, "TournamentList": { "type": "array", "items": { "$ref": "#/components/schemas/Tournament" } }, "Tournament": { "type": "object", "properties": { "tournamentId": { "type": "integer", "description": "Numeric tournament identifier (embedded zero-padded to 6 digits inside fixture/future IDs)." }, "sportId": { "type": "integer", "description": "Sport the tournament belongs to." }, "tournamentSlug": { "type": [ "string", "null" ], "description": "URL-safe tournament slug." }, "categorySlug": { "type": [ "string", "null" ], "description": "URL-safe slug of the category (usually the country/region) the tournament belongs to." }, "tournamentName": { "type": "string", "description": "Tournament display name, translated per the request language prefix." }, "categoryName": { "type": [ "string", "null" ], "description": "Category display name, translated per the request language prefix." } }, "required": [ "tournamentId", "sportId", "tournamentName" ], "additionalProperties": true }, "SportList": { "type": "array", "items": { "$ref": "#/components/schemas/Sport" } }, "Sport": { "type": "object", "properties": { "sportId": { "type": "integer", "description": "Numeric sport identifier. Also the first two digits of downstream `marketId`, `outcomeId` and `fixtureId` values." }, "slug": { "type": "string", "description": "URL-safe sport slug. This field will be renamed to `sportSlug` in a future release." }, "sportName": { "type": "string", "description": "Sport display name, translated per the request language prefix." } }, "required": [ "sportId", "slug", "sportName" ], "additionalProperties": true }, "SeasonList": { "type": "array", "items": { "$ref": "#/components/schemas/Season" } }, "Season": { "type": "object", "properties": { "seasonId": { "type": "integer", "description": "Numeric season identifier." }, "tournamentId": { "type": "integer", "description": "Tournament this season belongs to." }, "sportId": { "type": [ "integer", "null" ], "description": "Sport the season belongs to." }, "seasonSlug": { "type": [ "string", "null" ], "description": "URL-safe season slug." }, "seasonName": { "type": "string", "description": "Season display name, translated per the request language prefix." } }, "required": [ "seasonId", "tournamentId", "seasonName" ], "additionalProperties": true }, "PlayerList": { "type": "array", "items": { "$ref": "#/components/schemas/Player" } }, "Player": { "type": "object", "properties": { "playerId": { "type": "integer", "description": "Numeric player identifier. `0` is reserved to mean \"no player\" in odds and settlement payloads." }, "playerName": { "type": [ "string", "null" ], "description": "Player display name." } }, "required": [ "playerId" ], "additionalProperties": true }, "ParticipantList": { "type": "array", "items": { "$ref": "#/components/schemas/Participant" } }, "Participant": { "type": "object", "properties": { "participantId": { "type": "integer", "description": "Numeric participant (team/individual) identifier." }, "sportId": { "type": [ "integer", "null" ], "description": "Sport the participant belongs to." }, "name": { "type": [ "string", "null" ], "description": "Full participant name, translated per the request language prefix. This field will be renamed to `participantName` in a future release." }, "participantShortName": { "type": [ "string", "null" ], "description": "Short participant name." }, "participantMediumName": { "type": [ "string", "null" ], "description": "Medium-length participant name." }, "participantAbbr": { "type": [ "string", "null" ], "description": "Participant abbreviation (e.g. jersey code)." } }, "required": [ "participantId" ], "additionalProperties": true }, "MarketList": { "type": "array", "items": { "$ref": "#/components/schemas/Market" } }, "Market": { "type": "object", "properties": { "marketId": { "type": "integer", "description": "Frozen market identifier — equal to the first (lowest) `outcomeId` of the market." }, "sportId": { "type": [ "integer", "null" ], "description": "Sport the market belongs to (also the first two digits of `marketId`)." }, "marketType": { "type": [ "string", "null" ], "description": "Open market-type taxonomy value (e.g. `1x2`, `totals`, `spreads`, `players-shots`). Stable per value, never exhaustive." }, "period": { "type": [ "string", "null" ], "description": "Generic period key the market settles on (see the period vocabulary in Enumerations)." }, "marketLength": { "type": [ "integer", "null" ], "description": "Number of outcomes under this marketId - the sides that can be bet on, together forming the complete probability space (implied probabilities sum to ~1 before margin removal)." }, "playerProp": { "type": [ "boolean", "null" ], "description": "True for player proposition markets — their odds rows carry a non-zero `playerId`." }, "handicap": { "type": [ "number", "null" ], "description": "Handicap / total line of the market. Each line is its own market (own `marketId`)." }, "marketName": { "type": [ "string", "null" ], "description": "Market display name, translated per the request language prefix." }, "marketNameShort": { "type": [ "string", "null" ], "description": "Short market display name." }, "outcomes": { "type": "array", "items": { "$ref": "#/components/schemas/MarketOutcome" }, "description": "The market's outcomes, in their canonical order." } }, "required": [ "marketId" ], "additionalProperties": true }, "MarketOutcome": { "type": "object", "properties": { "outcomeId": { "type": "integer", "description": "Frozen outcome identifier — a fully decomposed selection (marketType → period → handicap → side). First two digits = `sportId`." }, "outcomeName": { "type": [ "string", "null" ], "description": "Outcome display name, translated per the request language prefix." } }, "required": [ "outcomeId" ], "additionalProperties": true }, "FixtureHistoricalOddsResponse": { "allOf": [ { "$ref": "#/components/schemas/Fixture" }, { "type": "object", "properties": { "odds": { "$ref": "#/components/schemas/HistoricalOddsByBookmaker" } }, "required": [ "odds" ], "additionalProperties": true } ] }, "HistoricalOddsByBookmaker": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/OddQuote" } } } }, "OddQuote": { "type": "object", "properties": { "bookmaker": { "type": "string", "description": "Bookmaker slug." }, "outcomeId": { "type": "integer", "description": "Frozen outcome identifier of the selection." }, "playerId": { "type": "integer", "description": "Player the price refers to; `0` for non-player markets." }, "price": { "type": "number", "description": "Decimal odds." }, "active": { "type": "boolean", "description": "Whether this outcome is currently available at the bookmaker." }, "marketActive": { "type": [ "boolean", "null" ], "description": "Whether the entire market is active at the bookmaker. Advisory and optional — many bookmakers never report it, so `null` is common and does not mean the market is closed (as one example, every quote from `bet365` on a sampled fixture returned `null` while `pinnacle` returned `true` on all of its own). Use `active` on the quote itself as the authoritative per-row state; treat `marketActive` as extra context only." }, "mainLine": { "type": [ "boolean", "null" ], "description": "Whether this is the bookmaker's main line for the market type." }, "marketId": { "type": "integer", "description": "Frozen market identifier the outcome belongs to." }, "bookmakerMarketId": { "type": [ "string", "null" ], "description": "Native bookmaker market identifier." }, "bookmakerOutcomeId": { "type": [ "string", "null" ], "description": "Native bookmaker outcome identifier." }, "bookmakerChangedAt": { "type": [ "integer", "null" ], "description": "Bookmaker-provided change timestamp (epoch ms), when present." }, "priceFractional": { "type": [ "string", "null" ], "description": "Fractional odds (e.g. `5/2`)." }, "priceAmerican": { "type": [ "integer", "null" ], "description": "American odds (e.g. `-110`, `+250`)." }, "meta": { "type": [ "object", "null" ], "description": "Bookmaker-specific metadata (orderbooks, ladders, …)." }, "limit": { "type": [ "number", "null" ], "description": "Maximum accepted stake, when provided by the bookmaker." }, "betslip": { "type": [ "string", "null" ], "description": "Bookmaker betslip / deeplink token, when available." }, "changedAt": { "type": "integer", "description": "When OddsPapi observed this change at the bookmaker (epoch ms, UTC) — always present." } }, "required": [ "bookmaker", "outcomeId", "playerId", "price", "active", "changedAt" ], "additionalProperties": true }, "Fixture": { "type": "object", "properties": { "fixtureId": { "type": "string", "description": "Fixture identifier: `{prefix}{sportId}{tournamentId}{nativeId}` — see Core Concepts → ID structure." }, "reissuedFixtureId": { "type": [ "string", "null" ], "description": "The fixture that replaced this one, when a cancelled fixture has been re-listed under a new id. `null` is the normal value: it is only ever populated on a cancelled fixture (`status.statusId` `3`) whose replacement already exists in the feed, so permanent cancellations stay `null`, and a fixture can go from `null` to an id after you first saw it cancelled. One hop: if the replacement was itself cancelled, follow its own `reissuedFixtureId`." }, "previousFixtureId": { "type": [ "string", "null" ], "description": "The inverse of `reissuedFixtureId`: the cancelled fixture this one replaced. Unlike the forward pointer this sits on a normal scheduled or live fixture, so a fixture carries its own history even if you never saw the cancelled one. `null` is the normal value. One hop and one predecessor at most — follow it repeatedly to walk back to the start of a chain, where a fixture postponed twice gives `A → B → C` and `B` carries both `previousFixtureId: A` and `reissuedFixtureId: C`. Cleared again if a postponement is reverted." }, "status": { "$ref": "#/components/schemas/Status", "description": "Lifecycle status of the fixture." }, "sport": { "$ref": "#/components/schemas/SportRef", "description": "Sport reference." }, "tournament": { "$ref": "#/components/schemas/TournamentRef", "description": "Tournament reference." }, "season": { "$ref": "#/components/schemas/SeasonRef", "description": "Season reference, when resolved." }, "venue": { "$ref": "#/components/schemas/VenueRef", "description": "Venue reference, when known." }, "startTime": { "type": "integer", "description": "Epoch seconds (UTC)." }, "trueStartTime": { "type": [ "string", "null" ], "description": "Actual start time (ISO 8601), once known — may differ from the scheduled `startTime`." }, "trueEndTime": { "type": [ "string", "null" ], "description": "Actual end time (ISO 8601), once known." }, "participants": { "$ref": "#/components/schemas/ParticipantsRef", "description": "Both participants with names, rotation numbers and abbreviations." }, "scores": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ScorePeriod" }, "description": "Score rows keyed by period (`result`, `p1`, …)." }, "clock": { "anyOf": [ { "$ref": "#/components/schemas/Clock" }, { "type": "null" } ], "description": "Live match clock, while in play." }, "expectedPeriods": { "type": [ "integer", "null" ], "description": "Number of regular periods expected for this fixture — use it (with `periodLength`) to interpret period keys per sport/league." }, "periodLength": { "type": [ "integer", "null" ], "description": "Length of a regular period in minutes." }, "externalProviders": { "$ref": "#/components/schemas/ExternalProviders", "description": "Native identifiers of this fixture at external providers (betradar, pinnacle, …)." }, "bookmakers": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/BookmakerFixtureMeta" }, "description": "Per-bookmaker availability and freshness metadata. Only populated when the `bookmakers` query parameter is present on the request — otherwise `{}`. Contains only bookmakers that currently offer valid realtime odds for this fixture. Present on odds endpoints; omitted on CLV, historical-odds and settlement responses." } }, "required": [ "fixtureId", "reissuedFixtureId", "previousFixtureId", "status", "sport", "tournament", "season", "venue", "startTime", "participants", "scores", "clock", "externalProviders" ], "additionalProperties": true }, "BookmakerFixtureMeta": { "type": "object", "properties": { "bookmaker": { "type": "string", "description": "Bookmaker slug." }, "bookmakerFixtureId": { "type": [ "string", "null" ], "description": "Native fixture identifier at the bookmaker." }, "fixturePath": { "type": [ "string", "null" ], "description": "Path of the fixture page on the bookmaker's site, when known." }, "hasOdds": { "type": "boolean", "description": "True if the bookmaker currently publishes odds for this fixture." }, "staleOdds": { "type": "boolean", "description": "Critical for trading: true if the connection to this bookmaker was lost or interrupted, so odds freshness can no longer be guaranteed." }, "staleOddsResponseCode": { "type": [ "integer", "null" ], "deprecated": true, "description": "**Deprecated.** HTTP status code observed during the staleness check, when any. Rely on `staleOdds` instead." }, "suspended": { "type": "boolean", "description": "True while the bookmaker has suspended betting on this fixture." }, "participantsRotated": { "type": "boolean", "description": "True if the bookmaker lists the participants in the opposite order (participant 1/2 swapped) relative to OddsPapi." }, "meta": { "type": [ "object", "null" ], "additionalProperties": true, "description": "Bookmaker-specific metadata." }, "updatedAt": { "type": "string", "description": "When this bookmaker meta last changed." } }, "required": [ "bookmaker", "hasOdds", "staleOdds", "suspended", "participantsRotated", "updatedAt" ], "additionalProperties": true }, "ExternalProviders": { "type": "object", "additionalProperties": true }, "Clock": { "type": "object", "properties": { "currentPeriod": { "type": [ "string", "null" ], "description": "Period key currently being played (see the period vocabulary in Enumerations)." }, "currentTime": { "type": [ "string", "null" ], "description": "Elapsed match time, `mm:ss`." }, "remainingTime": { "type": [ "string", "null" ], "description": "Remaining match time, `mm:ss` (count-down sports)." }, "remainingTimeInPeriod": { "type": [ "string", "null" ], "description": "Remaining time in the current period, `mm:ss`." }, "stopped": { "type": [ "boolean", "null" ], "description": "True while the match clock is stopped." } }, "additionalProperties": true }, "ScorePeriod": { "type": "object", "properties": { "period": { "type": "string", "description": "Period key this score row refers to (`result` = overall scoreline; see Enumerations)." }, "participant1Score": { "type": "integer", "description": "Score of participant 1 for this period." }, "participant2Score": { "type": "integer", "description": "Score of participant 2 for this period." }, "updatedAt": { "type": "string", "description": "When this score value last changed." } }, "required": [ "period", "participant1Score", "participant2Score", "updatedAt" ], "additionalProperties": true }, "ParticipantsRef": { "type": "object", "properties": { "participant1Id": { "type": "integer", "description": "Identifier of participant 1 (home / first-listed side)." }, "participant1RotNr": { "type": [ "integer", "null" ], "description": "Rotation number of participant 1 (US-book convention), when available." }, "participant1Name": { "type": [ "string", "null" ], "description": "Full name of participant 1, translated." }, "participant1ShortName": { "type": [ "string", "null" ], "description": "Short name of participant 1." }, "participant1Abbr": { "type": [ "string", "null" ], "description": "Abbreviation of participant 1." }, "participant2Id": { "type": "integer", "description": "Identifier of participant 2 (away / second-listed side)." }, "participant2RotNr": { "type": [ "integer", "null" ], "description": "Rotation number of participant 2 (US-book convention), when available." }, "participant2Name": { "type": [ "string", "null" ], "description": "Full name of participant 2, translated." }, "participant2ShortName": { "type": [ "string", "null" ], "description": "Short name of participant 2." }, "participant2Abbr": { "type": [ "string", "null" ], "description": "Abbreviation of participant 2." } }, "required": [ "participant1Id", "participant2Id" ], "additionalProperties": true }, "VenueRef": { "type": "object", "properties": { "venueId": { "type": [ "integer", "null" ], "description": "Numeric venue identifier, when known." }, "venueName": { "type": [ "string", "null" ], "description": "Venue display name, translated." }, "venueLocation": { "type": [ "string", "null" ], "description": "Venue location (city), translated." } }, "additionalProperties": true }, "SeasonRef": { "type": "object", "properties": { "seasonId": { "type": [ "integer", "null" ], "description": "Numeric season identifier, when known." }, "seasonName": { "type": [ "string", "null" ], "description": "Season display name, translated." }, "seasonRound": { "type": [ "integer", "null" ], "description": "Round number within the season, when applicable." } }, "additionalProperties": true }, "TournamentRef": { "type": "object", "properties": { "tournamentId": { "type": "integer", "description": "Numeric tournament identifier." }, "tournamentName": { "type": "string", "description": "Tournament display name, translated per the request language prefix." }, "categoryName": { "type": [ "string", "null" ], "description": "Category (usually country/region) display name, translated." } }, "required": [ "tournamentId", "tournamentName" ], "additionalProperties": true }, "SportRef": { "type": "object", "properties": { "sportId": { "type": "integer", "description": "Numeric sport identifier." }, "sportName": { "type": "string", "description": "Sport display name, translated per the request language prefix." } }, "required": [ "sportId", "sportName" ], "additionalProperties": true }, "Status": { "type": "object", "properties": { "live": { "type": "boolean", "description": "Convenience flag — true only while in play (`statusId` 1)." }, "statusId": { "type": "integer", "description": "Lifecycle status: `0` pregame, `1` live, `2` finished, `3` cancelled. Moves forward only — always branch on this ID." }, "statusName": { "type": "string", "description": "Translated display label for the status. For logic, branch on `statusId`, never on this string." } }, "required": [ "live", "statusId", "statusName" ], "additionalProperties": true }, "FixtureClvResponse": { "allOf": [ { "$ref": "#/components/schemas/Fixture" }, { "type": "object", "properties": { "odds": { "$ref": "#/components/schemas/ClvOddsByBookmaker" } }, "required": [ "odds" ], "additionalProperties": true } ] }, "ClvOddsByBookmaker": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ClvPair" } } }, "ClvPair": { "type": "object", "properties": { "olv": { "$ref": "#/components/schemas/PricePoint", "description": "Opening line value — the earliest recorded price point for the outcome." }, "clv": { "description": "Closing line value — the last recorded price point before the fixture started. `null` until the fixture closes, so every quote on a pre-game fixture returns `clv: null` with only `olv` populated.", "oneOf": [ { "$ref": "#/components/schemas/PricePoint" }, { "type": "null" } ] } }, "required": [ "olv", "clv" ], "additionalProperties": true }, "PricePoint": { "type": "object", "properties": { "bookmaker": { "type": "string", "description": "Bookmaker slug." }, "outcomeId": { "type": "integer", "description": "Frozen outcome identifier of the selection." }, "playerId": { "type": "integer", "description": "Player the price refers to; `0` for non-player markets." }, "price": { "type": "number", "description": "Decimal odds." }, "active": { "type": "boolean", "description": "Whether this outcome is currently available at the bookmaker." }, "marketActive": { "type": [ "boolean", "null" ], "description": "Whether the entire market is active at the bookmaker. Advisory and optional — many bookmakers never report it, so `null` is common and does not mean the market is closed (as one example, every quote from `bet365` on a sampled fixture returned `null` while `pinnacle` returned `true` on all of its own). Use `active` on the quote itself as the authoritative per-row state; treat `marketActive` as extra context only." }, "mainLine": { "type": [ "boolean", "null" ], "description": "Whether this is the bookmaker's main line for the market type." }, "marketId": { "type": "integer", "description": "Frozen market identifier the outcome belongs to." }, "bookmakerMarketId": { "type": [ "string", "null" ], "description": "Native bookmaker market identifier." }, "bookmakerOutcomeId": { "type": [ "string", "null" ], "description": "Native bookmaker outcome identifier." }, "bookmakerChangedAt": { "type": [ "integer", "null" ], "description": "Bookmaker-provided change timestamp (epoch ms), when present." }, "priceFractional": { "type": [ "string", "null" ], "description": "Fractional odds (e.g. `5/2`)." }, "priceAmerican": { "type": [ "integer", "null" ], "description": "American odds (e.g. `-110`, `+250`)." }, "meta": { "type": [ "object", "null" ], "description": "Bookmaker-specific metadata (orderbooks, ladders, …)." }, "limit": { "type": [ "number", "null" ], "description": "Maximum accepted stake, when provided by the bookmaker." }, "betslip": { "type": [ "string", "null" ], "description": "Bookmaker betslip / deeplink token, when available." }, "changedAt": { "type": "integer", "description": "When OddsPapi observed this price point at the bookmaker (epoch ms, UTC)." } }, "required": [ "bookmaker", "outcomeId", "playerId", "price", "active", "changedAt" ], "additionalProperties": true }, "FixtureOddsResponse": { "allOf": [ { "$ref": "#/components/schemas/Fixture" }, { "type": "object", "properties": { "odds": { "$ref": "#/components/schemas/OddsByBookmaker" } }, "required": [ "odds" ], "additionalProperties": true } ] }, "OddsByBookmaker": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/OddsMap" } }, "OddsMap": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/OddQuote" } }, "FixtureList": { "type": "array", "items": { "$ref": "#/components/schemas/Fixture" } }, "CurrencyList": { "type": "array", "items": { "$ref": "#/components/schemas/Currency" } }, "Currency": { "type": "object", "properties": { "currency": { "type": "string", "description": "ISO 4217 currency code." }, "updatedAt": { "type": "string", "description": "Timestamp of the latest rate refresh." }, "currencyValue": { "type": "number", "description": "Current exchange rate for the currency." } }, "required": [ "currency", "updatedAt", "currencyValue" ], "additionalProperties": true }, "BookmakerList": { "type": "array", "items": { "$ref": "#/components/schemas/Bookmaker" } }, "Bookmaker": { "type": "object", "properties": { "slug": { "type": "string", "description": "Stable bookmaker slug — the key used in `bookmakers` filters and in all odds payloads." }, "bookmakerName": { "type": "string", "description": "Bookmaker display name." }, "active": { "type": "boolean", "description": "Whether the bookmaker is currently served by the API." }, "domain": { "type": [ "string", "null" ], "format": "uri", "description": "Main public website URL of the bookmaker." }, "serverGroup": { "type": [ "string", "null" ], "description": "Deprecated internal field — safe to ignore for API consumers.", "deprecated": true }, "price": { "type": [ "integer", "null" ], "description": "Deprecated internal field — safe to ignore for API consumers.", "deprecated": true }, "websocketPregame": { "type": [ "boolean", "null" ], "description": "Whether pregame odds for this bookmaker are streamed over the WebSocket." }, "websocketLive": { "type": [ "boolean", "null" ], "description": "Whether live (in-play) odds for this bookmaker are streamed over the WebSocket." }, "playerProps": { "type": [ "boolean", "null" ], "description": "Whether this bookmaker offers player proposition markets." }, "maxDelayPregameInSec": { "type": [ "number", "null" ], "description": "Maximum expected refresh delay for pregame odds, in seconds — the freshness bound for this bookmaker. Measured from observed vs. bookmaker change times (currently the rolling p50) where the book publishes usable timestamps, estimated otherwise." }, "maxDelayLiveInSec": { "type": [ "number", "null" ], "description": "Maximum expected refresh delay for live odds, in seconds. Measured from observed vs. bookmaker change times (currently the rolling p50) where the book publishes usable timestamps, estimated otherwise." }, "maxDelayPregameMainInSec": { "type": [ "number", "null" ], "description": "Maximum expected refresh delay for pregame main lines, in seconds. Measured from observed vs. bookmaker change times (currently the rolling p50) where the book publishes usable timestamps, estimated otherwise." }, "availableCountries": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "ISO 3166-1 alpha-2 country codes where the bookmaker accepts customers." } }, "required": [ "slug", "bookmakerName", "active" ], "additionalProperties": true } } }, "paths": { "/v1/health": { "get": { "summary": "Get the health of the Trading API", "tags": [ "Health" ], "description": "No API key needed. 200 while healthy or degraded, 503 when unhealthy or when the API is switched off. Refreshed at most every 15 seconds.", "security": [], "responses": { "200": { "description": "`status` is the worst of the services. A degraded API still places orders.", "content": { "application/json": { "schema": { "description": "`status` is the worst of the services. A degraded API still places orders.", "type": "object", "required": [ "status", "time", "services" ], "properties": { "status": { "type": "string", "enum": [ "healthy", "degraded", "unhealthy" ] }, "time": { "format": "date-time", "type": "string" }, "services": { "type": "object", "required": [ "database", "caching", "betPlacement", "betUpdates" ], "properties": { "database": { "type": "string", "enum": [ "healthy", "degraded", "unhealthy" ] }, "caching": { "type": "string", "enum": [ "healthy", "degraded", "unhealthy" ] }, "betPlacement": { "type": "string", "enum": [ "healthy", "degraded", "unhealthy" ] }, "betUpdates": { "type": "string", "enum": [ "healthy", "degraded", "unhealthy" ] } } } } } } } }, "429": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "anyOf": [ { "description": "`status` is the worst of the services. A degraded API still places orders.", "type": "object", "required": [ "status", "time", "services" ], "properties": { "status": { "type": "string", "enum": [ "healthy", "degraded", "unhealthy" ] }, "time": { "format": "date-time", "type": "string" }, "services": { "type": "object", "required": [ "database", "caching", "betPlacement", "betUpdates" ], "properties": { "database": { "type": "string", "enum": [ "healthy", "degraded", "unhealthy" ] }, "caching": { "type": "string", "enum": [ "healthy", "degraded", "unhealthy" ] }, "betPlacement": { "type": "string", "enum": [ "healthy", "degraded", "unhealthy" ] }, "betUpdates": { "type": "string", "enum": [ "healthy", "degraded", "unhealthy" ] } } } } }, { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } ] } } } } } } }, "/v1/balance": { "get": { "summary": "Get the balance", "tags": [ "Account" ], "description": "The account's balance, the same figures the dashboard shows. For retail, exposure is full betting liability (including unmatched commitments, lay liability and commission), and available is cashBalance minus exposure. Agent balances retain givenCredit plus cashBalance minus stake exposure.", "security": [ { "apiKey": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "givenCredit", "cashBalance", "exposure", "available" ], "properties": { "givenCredit": { "description": "Money amount", "type": "object", "required": [ "amount", "amountCents", "currency" ], "properties": { "amount": { "pattern": "^-?\\d+\\.\\d{2}$", "description": "Decimal string, two decimals", "type": "string" }, "amountCents": { "description": "The same amount in integer cents: amount times 100", "type": "integer" }, "currency": { "description": "ISO 4217 code", "type": "string" } } }, "cashBalance": { "description": "Money amount", "type": "object", "required": [ "amount", "amountCents", "currency" ], "properties": { "amount": { "pattern": "^-?\\d+\\.\\d{2}$", "description": "Decimal string, two decimals", "type": "string" }, "amountCents": { "description": "The same amount in integer cents: amount times 100", "type": "integer" }, "currency": { "description": "ISO 4217 code", "type": "string" } } }, "exposure": { "description": "Money amount", "type": "object", "required": [ "amount", "amountCents", "currency" ], "properties": { "amount": { "pattern": "^-?\\d+\\.\\d{2}$", "description": "Decimal string, two decimals", "type": "string" }, "amountCents": { "description": "The same amount in integer cents: amount times 100", "type": "integer" }, "currency": { "description": "ISO 4217 code", "type": "string" } } }, "available": { "description": "Money amount", "type": "object", "required": [ "amount", "amountCents", "currency" ], "properties": { "amount": { "pattern": "^-?\\d+\\.\\d{2}$", "description": "Decimal string, two decimals", "type": "string" }, "amountCents": { "description": "The same amount in integer cents: amount times 100", "type": "integer" }, "currency": { "description": "ISO 4217 code", "type": "string" } } } } } } } }, "401": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "403": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "409": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "429": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "503": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } } } } }, "/v1/me": { "get": { "summary": "Get the account behind the API key", "tags": [ "Account" ], "description": "Identity, status and bookmakers of the account, the key in use and the feed paths.", "security": [ { "apiKey": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "accountId", "username", "status", "bookmakers", "key", "feed" ], "properties": { "accountId": { "format": "uuid", "type": "string" }, "username": { "type": "string" }, "status": { "type": "string" }, "bookmakers": { "type": "array", "items": { "type": "string" } }, "key": { "type": "object", "required": [ "prefix", "lastFour", "createdAt" ], "properties": { "prefix": { "type": "string" }, "lastFour": { "type": "string" }, "createdAt": { "format": "date-time", "type": "string" } } }, "feed": { "type": "object", "required": [ "rest", "ws" ], "properties": { "rest": { "type": "string" }, "ws": { "type": "string" } } } } } } } }, "401": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "403": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "429": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "503": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } } } } }, "/v1/en/bookmakers": { "get": { "summary": "Get Bookmakers", "description": "OddsPapi `GET /{lang}/bookmakers`, returned unchanged. The reference shows `en`; see [Languages](/api-reference/overview#languages) for the others.\n\nList bookmakers.\n\nReturns the bookmaker catalog available to the provided apiKey.\n\nLookup mode: `bookmakers` (optional filter list) + `playerProps` (optional capability filter).\n\nOdds are limited to your account's bookmakers: without `bookmakers`, you get all of them; asking for another one answers `403 BOOKMAKER_NOT_AVAILABLE`.", "operationId": "feed_bookmakers", "tags": [ "Reference data" ], "parameters": [ { "name": "bookmakers", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "description": "Comma- or space-separated bookmaker slugs. Supports `*` / `all` for wildcard." }, { "name": "playerProps", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "description": "If true, only return bookmakers that support player proposition markets." } ], "responses": { "200": { "description": "Returns Bookmaker[]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BookmakerList" }, "examples": { "example": { "summary": "Bookmaker list", "value": [ { "slug": "188bet", "bookmakerName": "188BET", "active": true, "domain": "https://188bet.com", "serverGroup": "at4", "price": 10, "websocketPregame": true, "websocketLive": false, "maxDelayPregameInSec": 80, "maxDelayPregameMainInSec": 60, "availableCountries": [ "ag", "al", "am", "ar", "at" ] }, { "slug": "1xbet", "bookmakerName": "1xBet", "active": true, "domain": "https://1xbet.com", "serverGroup": "de4", "price": 10, "websocketPregame": true, "websocketLive": true, "maxDelayPregameInSec": 30, "maxDelayLiveInSec": 4, "maxDelayPregameMainInSec": 6, "availableCountries": [ "bo", "kr", "tn", "in" ] } ] } } } } }, "400": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "401": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "403": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "404": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "429": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "502": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "503": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "504": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } } } } }, "/v1/en/currencies": { "get": { "summary": "Get Currencies", "description": "OddsPapi `GET /{lang}/currencies`, returned unchanged. The reference shows `en`; see [Languages](/api-reference/overview#languages) for the others.\n\nList currencies and conversion values.\n\nLookup mode: `currency` (optional filter).", "operationId": "feed_currencies", "tags": [ "Reference data" ], "parameters": [ { "name": "currency", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "description": "Currency code (case-insensitive), e.g. EUR, usd, BTC." } ], "responses": { "200": { "description": "Returns Currency[]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CurrencyList" }, "examples": { "example": { "summary": "Currencies list", "value": [ { "currency": "BTC", "updatedAt": "2026-10-19T21:08:01+00:00", "currencyValue": 0.00001221 }, { "currency": "EUR", "updatedAt": "2026-10-19T21:00:00+00:00", "currencyValue": 0.891896 } ] } } } } }, "400": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "401": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "403": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "404": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "429": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "502": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "503": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "504": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } } } } }, "/v1/en/markets": { "get": { "summary": "Get Markets", "description": "OddsPapi `GET /{lang}/markets`, returned unchanged. The reference shows `en`; see [Languages](/api-reference/overview#languages) for the others.\n\nList markets.\n\nLookup mode: `marketIds` OR `sportId` OR `outcomeIds`.", "operationId": "feed_markets", "tags": [ "Reference data" ], "parameters": [ { "name": "marketIds", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "description": "Comma- or space-separated market IDs." }, { "name": "sportId", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "description": "Single sport ID." }, { "name": "outcomeIds", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "description": "Comma- or space-separated outcome IDs." } ], "responses": { "200": { "description": "Returns Market[]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MarketList" }, "examples": { "example": { "summary": "Markets list", "value": [ { "marketId": 111, "marketLength": 2, "sportId": 11, "playerProp": false, "handicap": 0, "period": "result", "marketType": "moneyline", "marketName": "Winner (incl. overtime)", "marketNameShort": "Winner", "outcomes": [ { "outcomeId": 111, "outcomeName": "1" }, { "outcomeId": 112, "outcomeName": "2" } ] }, { "marketId": 113, "marketLength": 3, "sportId": 11, "playerProp": false, "handicap": 0, "period": "fulltime", "marketType": "1x2", "marketName": "Regular Time Result", "marketNameShort": "1X2", "outcomes": [ { "outcomeId": 113, "outcomeName": "1" }, { "outcomeId": 114, "outcomeName": "X" } ] } ] } } } } }, "400": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "401": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "403": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "404": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "429": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "502": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "503": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "504": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } } } } }, "/v1/en/participants": { "get": { "summary": "Get Participants", "description": "OddsPapi `GET /{lang}/participants`, returned unchanged. The reference shows `en`; see [Languages](/api-reference/overview#languages) for the others.\n\nList participants.\n\nLookup mode: `participantIds` OR `sportId` OR `playerId`.", "operationId": "feed_participants", "tags": [ "Reference data" ], "parameters": [ { "name": "participantIds", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "description": "Comma- or space-separated participant IDs." }, { "name": "sportId", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "description": "Single sport ID." }, { "name": "playerId", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "description": "Single player ID." } ], "responses": { "200": { "description": "Returns Participant[]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ParticipantList" }, "examples": { "example": { "summary": "Participants list", "value": [ { "participantId": 3409, "sportId": 11, "name": "Chicago Bulls", "participantShortName": "Chicago", "participantAbbr": "CHI" }, { "participantId": 3410, "sportId": 11, "name": "Milwaukee Bucks", "participantShortName": "Milwaukee", "participantAbbr": "MIL" } ] } } } } }, "400": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "401": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "403": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "404": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "429": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "502": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "503": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "504": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } } } } }, "/v1/en/players": { "get": { "summary": "Get Players", "description": "OddsPapi `GET /{lang}/players`, returned unchanged. The reference shows `en`; see [Languages](/api-reference/overview#languages) for the others.\n\nList players.\n\nLookup mode: `playerIds` OR `participantId` OR `sportId`.", "operationId": "feed_players", "tags": [ "Reference data" ], "parameters": [ { "name": "playerIds", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "description": "Comma- or space-separated player IDs." }, { "name": "participantId", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "description": "Single participant ID." }, { "name": "sportId", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "description": "Single sport ID." } ], "responses": { "200": { "description": "Returns Player[]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlayerList" }, "examples": { "example": { "summary": "Players list", "value": [ { "playerId": 607468, "playerName": "Jokic, Nikola" }, { "playerId": 607336, "playerName": "Antetokounmpo, Giannis" } ] } } } } }, "400": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "401": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "403": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "404": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "429": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "502": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "503": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "504": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } } } } }, "/v1/en/seasons": { "get": { "summary": "Get Seasons", "description": "OddsPapi `GET /{lang}/seasons`, returned unchanged. The reference shows `en`; see [Languages](/api-reference/overview#languages) for the others.\n\nList seasons.\n\nLookup mode: `seasonIds` OR `tournamentId`.", "operationId": "feed_seasons", "tags": [ "Reference data" ], "parameters": [ { "name": "seasonIds", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "description": "Comma- or space-separated season IDs." }, { "name": "tournamentId", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "description": "Tournament ID." } ], "responses": { "200": { "description": "Returns Season[]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SeasonList" }, "examples": { "example": { "summary": "Season list", "value": [ { "seasonId": 119257, "tournamentId": 132, "sportId": 11, "seasonSlug": "nba-24-25", "seasonName": "NBA 24/25" }, { "seasonId": 131631, "tournamentId": 132, "sportId": 11, "seasonSlug": "nba-25-26", "seasonName": "NBA 25/26" } ] } } } } }, "400": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "401": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "403": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "404": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "429": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "502": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "503": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "504": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } } } } }, "/v1/en/sports": { "get": { "summary": "Get Sports", "description": "OddsPapi `GET /{lang}/sports`, returned unchanged. The reference shows `en`; see [Languages](/api-reference/overview#languages) for the others.\n\nList sports.\n\nLookup mode: `sportIds` (optional filter list).", "operationId": "feed_sports", "tags": [ "Reference data" ], "parameters": [ { "name": "sportIds", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "description": "Comma- or space-separated sport IDs." } ], "responses": { "200": { "description": "Returns Sport[]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SportList" }, "examples": { "example": { "summary": "Sports list", "value": [ { "sportId": 10, "slug": "soccer", "sportName": "Soccer" }, { "sportId": 11, "slug": "basketball", "sportName": "Basketball" }, { "sportId": 12, "slug": "tennis", "sportName": "Tennis" } ] } } } } }, "400": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "401": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "403": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "404": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "429": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "502": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "503": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "504": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } } } } }, "/v1/en/tournaments": { "get": { "summary": "Get Tournaments", "description": "OddsPapi `GET /{lang}/tournaments`, returned unchanged. The reference shows `en`; see [Languages](/api-reference/overview#languages) for the others.\n\nList tournaments.\n\nLookup mode: `sportId` OR `tournamentIds`.\n\nDefault: if neither is provided, the API uses `sportId=11`.", "operationId": "feed_tournaments", "tags": [ "Reference data" ], "parameters": [ { "name": "sportId", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "description": "Single sport ID." }, { "name": "tournamentIds", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "description": "Comma- or space-separated tournament IDs." } ], "responses": { "200": { "description": "Returns Tournament[]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TournamentList" }, "examples": { "example": { "summary": "Tournament list", "value": [ { "tournamentId": 132, "sportId": 11, "tournamentSlug": "nba", "categorySlug": "usa", "tournamentName": "NBA", "categoryName": "USA" }, { "tournamentId": 138, "sportId": 11, "tournamentSlug": "euroleague", "categorySlug": "international", "tournamentName": "Euroleague", "categoryName": "International" } ] } } } } }, "400": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "401": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "403": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "404": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "429": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "502": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "503": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "504": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } } } } }, "/v1/en/venues": { "get": { "summary": "Get Venues", "description": "OddsPapi `GET /{lang}/venues`, returned unchanged. The reference shows `en`; see [Languages](/api-reference/overview#languages) for the others.\n\nList venues by explicit IDs.\n\nName fields are returned in the requested language when available.", "operationId": "feed_venues", "tags": [ "Reference data" ], "parameters": [ { "name": "venueIds", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Comma/space-separated venue IDs, e.g. `1234,5678`." } ], "responses": { "200": { "description": "Returns Venue[]", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Venue" } }, "examples": { "example": { "summary": "Venues list", "value": [ { "venueId": 15672, "venueSlug": "levis-stadium", "venueName": "Levi's Stadium", "venueLocation": "Santa Clara, CA, USA" }, { "venueId": 6054, "venueSlug": "madison-square-garden", "venueName": "Madison Square Garden", "venueLocation": "New York, NY, USA" } ] } } } } }, "400": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "401": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "403": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "404": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "429": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "502": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "503": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "504": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } } } } }, "/v1/en/fixtures": { "get": { "summary": "Fixtures Filtered", "description": "OddsPapi `GET /{lang}/fixtures`, returned unchanged. The reference shows `en`; see [Languages](/api-reference/overview#languages) for the others.\n\nList fixtures.\n\nLookup mode: `fixtureIds` OR filters (`sportId`, `tournamentId`, `statusId`, optional time range).\n\nIf `bookmakers` is present, bookmaker meta is included and results may be filtered by mapping availability.\n\nWhen you pass `bookmakers`, only your account's bookmakers are allowed: asking for another one answers `403 BOOKMAKER_NOT_AVAILABLE`.", "operationId": "feed_fixtures", "tags": [ "Fixtures" ], "parameters": [ { "name": "fixtureIds", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "description": "Comma/space-separated fixture IDs (fast path)." }, { "name": "sportId", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "description": "Single sport ID." }, { "name": "tournamentId", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "description": "Single tournament ID." }, { "name": "statusId", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Forwarded to OddsPapi unchanged." }, { "name": "bookmakers", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "description": "Comma/space-separated bookmaker slugs. If present (even empty), includes bookmaker META and filters by mapping." }, { "name": "startTimeFrom", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "description": "Start time from (epoch seconds)." }, { "name": "startTimeTo", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "description": "Start time to (epoch seconds)." } ], "responses": { "200": { "description": "Returns Fixture[] (fixture meta objects)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FixtureList" }, "examples": { "example": { "summary": "Fixtures list", "value": [ { "fixtureId": "id1000023875243922", "reissuedFixtureId": null, "previousFixtureId": null, "status": { "live": false, "statusId": 2, "statusName": "Finished" }, "sport": { "sportId": 10, "sportName": "Soccer" }, "tournament": { "tournamentId": 238, "tournamentName": "Liga Portugal", "categoryName": "Portugal" }, "season": { "seasonId": 143496, "seasonName": "Liga Portugal 26/27", "seasonRound": 2 }, "venue": { "venueId": 951, "venueName": "Braga Municipal", "venueLocation": "Braga, Portugal" }, "startTime": 1792437300, "trueStartTime": "2026-10-19T19:17:21.664419+00:00", "trueEndTime": "2026-10-19T21:17:33.00531+00:00", "participants": { "participant1Id": 2999, "participant1RotNr": 4132, "participant1Name": "SC Braga", "participant1ShortName": "Braga", "participant1Abbr": "BRA", "participant2Id": 3010, "participant2RotNr": 4133, "participant2Name": "Gil Vicente Barcelos", "participant2ShortName": "Vicente Barcelos", "participant2Abbr": "GIL" }, "scores": { "p1": { "period": "p1", "participant1Score": 1, "participant2Score": 0, "updatedAt": "2026-10-19T20:07:15.073052+00:00" }, "result": { "period": "result", "participant1Score": 1, "participant2Score": 2, "updatedAt": "2026-10-19T20:54:37.027805+00:00" } }, "clock": { "currentPeriod": "p2", "currentTime": "98:02", "remainingTime": null, "remainingTimeInPeriod": null, "stopped": true, "updatedAt": "2026-10-19T21:17:15.236113+00:00" }, "expectedPeriods": 2, "periodLength": 45, "externalProviders": { "betgeniusId": 14532333, "betradarId": 75243922, "flashscoreId": "rX6GkgVb", "mollybetId": "2026-10-19,1178,1180", "oddinId": null, "opticoddsId": "20261019047F01A6", "pinnacleId": 1638273301, "sofascoreId": 17243270, "lsportsId": 20502265, "txoddsId": null }, "bookmakers": { "draftkings": { "bookmaker": "draftkings", "bookmakerFixtureId": "34825335", "fixturePath": "https://sportsbook.draftkings.com/event/34825335", "hasOdds": true, "staleOdds": false, "staleOddsResponseCode": null, "suspended": true, "participantsRotated": false, "meta": null, "updatedAt": "2026-10-19T21:17:14.329536+00:00" } } } ] } } } } }, "400": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "401": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "403": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "404": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "429": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "502": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "503": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "504": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } } } } }, "/v1/en/fixtures/live": { "get": { "summary": "Fixtures Live", "description": "OddsPapi `GET /{lang}/fixtures/live`, returned unchanged. The reference shows `en`; see [Languages](/api-reference/overview#languages) for the others.\n\nList live fixtures.\n\nLookup mode: optional filters (`bookmakers`, `sportId`, `tournamentId`).\n\nWhen you pass `bookmakers`, only your account's bookmakers are allowed: asking for another one answers `403 BOOKMAKER_NOT_AVAILABLE`.", "operationId": "feed_fixtures_live", "tags": [ "Fixtures" ], "parameters": [ { "name": "sportId", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "description": "Single sport ID." }, { "name": "tournamentId", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "description": "Single tournament ID." }, { "name": "bookmakers", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "description": "Comma/space-separated bookmaker slugs." } ], "responses": { "200": { "description": "Returns Fixture[] (live only)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FixtureList" }, "examples": { "example": { "summary": "Fixtures list", "value": [ { "fixtureId": "id1000023875243922", "reissuedFixtureId": null, "previousFixtureId": null, "status": { "live": false, "statusId": 2, "statusName": "Finished" }, "sport": { "sportId": 10, "sportName": "Soccer" }, "tournament": { "tournamentId": 238, "tournamentName": "Liga Portugal", "categoryName": "Portugal" }, "season": { "seasonId": 143496, "seasonName": "Liga Portugal 26/27", "seasonRound": 2 }, "venue": { "venueId": 951, "venueName": "Braga Municipal", "venueLocation": "Braga, Portugal" }, "startTime": 1792437300, "trueStartTime": "2026-10-19T19:17:21.664419+00:00", "trueEndTime": "2026-10-19T21:17:33.00531+00:00", "participants": { "participant1Id": 2999, "participant1RotNr": 4132, "participant1Name": "SC Braga", "participant1ShortName": "Braga", "participant1Abbr": "BRA", "participant2Id": 3010, "participant2RotNr": 4133, "participant2Name": "Gil Vicente Barcelos", "participant2ShortName": "Vicente Barcelos", "participant2Abbr": "GIL" }, "scores": { "p1": { "period": "p1", "participant1Score": 1, "participant2Score": 0, "updatedAt": "2026-10-19T20:07:15.073052+00:00" }, "result": { "period": "result", "participant1Score": 1, "participant2Score": 2, "updatedAt": "2026-10-19T20:54:37.027805+00:00" } }, "clock": { "currentPeriod": "p2", "currentTime": "98:02", "remainingTime": null, "remainingTimeInPeriod": null, "stopped": true, "updatedAt": "2026-10-19T21:17:15.236113+00:00" }, "expectedPeriods": 2, "periodLength": 45, "externalProviders": { "betgeniusId": 14532333, "betradarId": 75243922, "flashscoreId": "rX6GkgVb", "mollybetId": "2026-10-19,1178,1180", "oddinId": null, "opticoddsId": "20261019047F01A6", "pinnacleId": 1638273301, "sofascoreId": 17243270, "lsportsId": 20502265, "txoddsId": null }, "bookmakers": { "draftkings": { "bookmaker": "draftkings", "bookmakerFixtureId": "34825335", "fixturePath": "https://sportsbook.draftkings.com/event/34825335", "hasOdds": true, "staleOdds": false, "staleOddsResponseCode": null, "suspended": true, "participantsRotated": false, "meta": null, "updatedAt": "2026-10-19T21:17:14.329536+00:00" } } } ] } } } } }, "400": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "401": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "403": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "404": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "429": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "502": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "503": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "504": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } } } } }, "/v1/en/fixtures/search": { "get": { "summary": "Search fixtures", "description": "OddsPapi `GET /{lang}/fixtures/search`, returned unchanged. The reference shows `en`; see [Languages](/api-reference/overview#languages) for the others.\n\nSearches fixtures by name. OddsPapi does not describe this path in its reference yet.", "operationId": "feed_fixtures_search", "tags": [ "Fixtures" ], "parameters": [ { "name": "query", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Forwarded to OddsPapi unchanged." }, { "name": "startTimeFrom", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Forwarded to OddsPapi unchanged." }, { "name": "startTimeTo", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Forwarded to OddsPapi unchanged." } ], "responses": { "200": { "description": "The OddsPapi response, unchanged", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "401": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "403": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "404": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "429": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "502": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "503": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "504": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } } } } }, "/v1/en/fixtures/today": { "get": { "summary": "Fixtures Today", "description": "OddsPapi `GET /{lang}/fixtures/today`, returned unchanged. The reference shows `en`; see [Languages](/api-reference/overview#languages) for the others.\n\nList today's fixtures.\n\nLookup mode: optional filters (`bookmakers`, `sportId`, `tournamentId`).\n\nWhen you pass `bookmakers`, only your account's bookmakers are allowed: asking for another one answers `403 BOOKMAKER_NOT_AVAILABLE`.", "operationId": "feed_fixtures_today", "tags": [ "Fixtures" ], "parameters": [ { "name": "sportId", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "description": "Single sport ID." }, { "name": "tournamentId", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "description": "Single tournament ID." }, { "name": "bookmakers", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "description": "Comma/space-separated bookmaker slugs." } ], "responses": { "200": { "description": "Returns Fixture[] (fixture meta objects)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FixtureList" }, "examples": { "example": { "summary": "Today's fixtures", "value": [ { "fixtureId": "id1400003171515924", "reissuedFixtureId": null, "previousFixtureId": null, "status": { "live": false, "statusId": 0, "statusName": "Pre-Game" }, "sport": { "sportId": 14, "sportName": "American Football" }, "tournament": { "tournamentId": 31, "tournamentName": "NFL", "categoryName": "USA" }, "season": { "seasonId": 139396, "seasonName": "NFL 26/27", "seasonRound": 6 }, "venue": { "venueId": 15672, "venueName": "Levi's Stadium", "venueLocation": "Santa Clara, CA, USA" }, "startTime": 1792455300, "trueStartTime": null, "trueEndTime": null, "participants": { "participant1Id": 4389, "participant1RotNr": 141, "participant1Name": "San Francisco 49ers", "participant1ShortName": "San Francisco", "participant1Abbr": "SF", "participant2Id": 4432, "participant2RotNr": 140, "participant2Name": "Washington Commanders", "participant2ShortName": "Washington", "participant2Abbr": "WAS" }, "scores": {}, "clock": { "currentPeriod": null, "currentTime": null, "remainingTime": null, "remainingTimeInPeriod": null, "stopped": null, "updatedAt": null }, "expectedPeriods": 4, "periodLength": 15, "externalProviders": { "betgeniusId": null, "betradarId": 71515924, "flashscoreId": "Op9YIhXq", "mollybetId": "2026-10-20,21640,10050390", "oddinId": null, "opticoddsId": "20261020BC02533C", "pinnacleId": 1637707533, "sofascoreId": 16183736, "lsportsId": 19776801, "txoddsId": null }, "bookmakers": { "pinnacle": { "bookmaker": "pinnacle", "bookmakerFixtureId": "1637707533", "fixturePath": "https://www.pinnacle.com/en/e/e/e/1637707533", "hasOdds": true, "staleOdds": false, "staleOddsResponseCode": 502, "suspended": false, "participantsRotated": false, "meta": null, "updatedAt": "2026-10-17T14:00:01.921523+00:00" } } } ] } } } } }, "400": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "401": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "403": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "404": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "429": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "502": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "503": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "504": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } } } } }, "/v1/en/fixtures/odds": { "get": { "summary": "Fixture Odds", "description": "OddsPapi `GET /{lang}/fixtures/odds`, returned unchanged. The reference shows `en`; see [Languages](/api-reference/overview#languages) for the others.\n\nGet current odds for a fixture.\n\nLookup mode: required `fixtureId` + optional `bookmakers`, optional filtering flags.\n\nIf `since` is provided, returns odds updates with `changedAt >= since`.\n\nOdds are limited to your account's bookmakers: without `bookmakers`, you get all of them; asking for another one answers `403 BOOKMAKER_NOT_AVAILABLE`.", "operationId": "feed_fixtures_odds", "tags": [ "Odds" ], "parameters": [ { "name": "fixtureId", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Single fixture ID (e.g. id1400003171515924)." }, { "name": "bookmakers", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "description": "Comma/space-separated bookmaker slugs (default: all)." }, { "name": "since", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "description": "changedAt >= since (ms)" }, { "name": "activeOnly", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Forwarded to OddsPapi unchanged." }, { "name": "marketActive", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "description": "If set, filter by marketActive flag." }, { "name": "mainLine", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "description": "If set, filter by mainLine flag." } ], "responses": { "200": { "description": "Returns FixtureOddsResponse (fixture meta + odds + bookmaker meta)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FixtureOddsResponse" }, "examples": { "example": { "summary": "Fixture odds", "value": { "fixtureId": "id1100013273682356", "reissuedFixtureId": null, "previousFixtureId": null, "status": { "live": false, "statusId": 0, "statusName": "Pre-Game" }, "sport": { "sportId": 11, "sportName": "Basketball" }, "tournament": { "tournamentId": 132, "tournamentName": "NBA", "categoryName": "USA" }, "season": { "seasonId": 142074, "seasonName": "NBA 26/27", "seasonRound": 1 }, "venue": { "venueId": 6054, "venueName": "Madison Square Garden", "venueLocation": "New York, NY, USA" }, "startTime": 1792537200, "trueStartTime": null, "trueEndTime": null, "participants": { "participant1Id": 3421, "participant1RotNr": 504, "participant1Name": "New York Knicks", "participant1ShortName": "New York", "participant1Abbr": "NYK", "participant2Id": 3420, "participant2RotNr": 503, "participant2Name": "Philadelphia 76ers", "participant2ShortName": "Philadelphia", "participant2Abbr": "PHI" }, "scores": {}, "clock": { "currentPeriod": null, "currentTime": null, "remainingTime": null, "remainingTimeInPeriod": null, "stopped": null, "updatedAt": null }, "expectedPeriods": 4, "periodLength": 12, "externalProviders": { "betgeniusId": 14304079, "betradarId": 73682356, "flashscoreId": "prbYk4Kq", "mollybetId": "2026-10-20,29093,29094", "oddinId": null, "opticoddsId": "20261020D42F1162", "pinnacleId": 1633801639, "sofascoreId": 16814811, "lsportsId": 19766754, "txoddsId": null }, "odds": { "pinnacle": { "id1100013273682356:pinnacle:111470:0": { "outcomeId": 111470, "playerId": 0, "price": 1.689, "active": true, "changedAt": 1792444223199, "bookmaker": "pinnacle", "limit": 326, "marketId": 111470, "marketActive": true, "mainLine": false, "bookmakerMarketId": "altLine/4/487/1633801639/3772269294/57414014940/0/teamTotal", "bookmakerOutcomeId": "home/116.5/over", "bookmakerChangedAt": 1792444222717, "priceFractional": "31/45", "priceAmerican": -145 }, "id1100013273682356:pinnacle:111471:0": { "outcomeId": 111471, "playerId": 0, "price": 2.19, "active": true, "changedAt": 1792444223199, "bookmaker": "pinnacle", "limit": 225, "marketId": 111470, "marketActive": true, "mainLine": false, "bookmakerMarketId": "altLine/4/487/1633801639/3772269294/57414014940/0/teamTotal", "bookmakerOutcomeId": "home/116.5/under", "bookmakerChangedAt": 1792444222717, "priceFractional": "119/100", "priceAmerican": 119 } } }, "bookmakers": { "pinnacle": { "bookmaker": "pinnacle", "bookmakerFixtureId": "1633801639", "fixturePath": "https://www.pinnacle.com/en/e/e/e/1633801639", "hasOdds": true, "staleOdds": false, "staleOddsResponseCode": 502, "suspended": false, "participantsRotated": false, "meta": null, "updatedAt": "2026-10-18T13:00:45.998318+00:00" } } } } } } } }, "400": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "401": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "403": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "404": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "429": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "502": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "503": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "504": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } } } } }, "/v1/en/fixtures/odds/clv": { "get": { "summary": "Fixture Odds CLV", "description": "OddsPapi `GET /{lang}/fixtures/odds/clv`, returned unchanged. The reference shows `en`; see [Languages](/api-reference/overview#languages) for the others.\n\nGet opening vs closing line values (OLV/CLV) for a fixture.\n\nLookup mode: required `fixtureId` + optional `bookmakers` OR optional `oddsIds`.\n\nOdds are limited to your account's bookmakers: without `bookmakers`, you get all of them; asking for another one answers `403 BOOKMAKER_NOT_AVAILABLE`.", "operationId": "feed_fixtures_odds_clv", "tags": [ "Odds" ], "parameters": [ { "name": "fixtureId", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Single fixture ID (e.g. id1400003171515924)." }, { "name": "bookmakers", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "description": "Comma/space-separated bookmaker slugs (default: all)." }, { "name": "oddsIds", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "description": "Optional: comma/space-separated oddsIds to restrict the response." } ], "responses": { "200": { "description": "Returns FixtureClvResponse (fixture meta + OLV/CLV pairs)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FixtureClvResponse" }, "examples": { "example": { "summary": "Fixture CLV/OLV", "value": { "fixtureId": "id1400003171515924", "reissuedFixtureId": null, "previousFixtureId": null, "status": { "live": false, "statusId": 0, "statusName": "Pre-Game" }, "sport": { "sportId": 14, "sportName": "American Football" }, "tournament": { "tournamentId": 31, "tournamentName": "NFL", "categoryName": "USA" }, "season": { "seasonId": 139396, "seasonName": "NFL 26/27", "seasonRound": 6 }, "venue": { "venueId": 15672, "venueName": "Levi's Stadium", "venueLocation": "Santa Clara, CA, USA" }, "startTime": 1792455300, "trueStartTime": null, "trueEndTime": null, "participants": { "participant1Id": 4389, "participant1RotNr": 141, "participant1Name": "San Francisco 49ers", "participant1ShortName": "San Francisco", "participant1Abbr": "SF", "participant2Id": 4432, "participant2RotNr": 140, "participant2Name": "Washington Commanders", "participant2ShortName": "Washington", "participant2Abbr": "WAS" }, "scores": {}, "clock": { "currentPeriod": null, "currentTime": null, "remainingTime": null, "remainingTimeInPeriod": null, "stopped": null, "updatedAt": null }, "expectedPeriods": 4, "periodLength": 15, "externalProviders": { "betgeniusId": null, "betradarId": 71515924, "flashscoreId": "Op9YIhXq", "mollybetId": "2026-10-20,21640,10050390", "oddinId": null, "opticoddsId": "20261020BC02533C", "pinnacleId": 1637707533, "sofascoreId": 16183736, "lsportsId": 19776801, "txoddsId": null }, "odds": { "pinnacle": { "id1400003171515924:pinnacle:14100:0": { "clv": null, "olv": { "bookmaker": "pinnacle", "outcomeId": 14100, "playerId": 0, "price": 2.25, "priceFractional": "5/4", "priceAmerican": 125, "active": true, "limit": 3750, "changedAt": 1792080445959 } }, "id1400003171515924:pinnacle:14101:0": { "clv": null, "olv": { "bookmaker": "pinnacle", "outcomeId": 14101, "playerId": 0, "price": 1.68, "priceFractional": "17/25", "priceAmerican": -147, "active": true, "limit": 5514, "changedAt": 1792080445959 } } } }, "bookmakers": { "pinnacle": { "bookmaker": "pinnacle", "bookmakerFixtureId": "1637707533", "fixturePath": "https://www.pinnacle.com/en/e/e/e/1637707533", "hasOdds": true, "staleOdds": false, "staleOddsResponseCode": 502, "suspended": false, "participantsRotated": false, "meta": null, "updatedAt": "2026-10-17T14:00:01.921523+00:00" } } } } } } } }, "400": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "401": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "403": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "404": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "429": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "502": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "503": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "504": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } } } } }, "/v1/en/fixtures/odds/historical": { "get": { "summary": "Fixture Odds Historical", "description": "OddsPapi `GET /{lang}/fixtures/odds/historical`, returned unchanged. The reference shows `en`; see [Languages](/api-reference/overview#languages) for the others.\n\nGet historical odds timeline for a fixture.\n\nLookup mode: required `fixtureId` + (`bookmaker` required when `oddsIds` is not provided) OR `oddsIds`.\n\n`bookmaker` or `oddsIds` is required, and the bookmaker must be one of your account's: another one answers `403 BOOKMAKER_NOT_AVAILABLE`.", "operationId": "feed_fixtures_odds_historical", "tags": [ "Odds" ], "parameters": [ { "name": "fixtureId", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Single fixture ID (e.g. id1400003171515924)." }, { "name": "bookmaker", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "description": "Single bookmaker slug. RULE: If oddsIds is NOT provided, you must pass exactly ONE bookmaker." }, { "name": "oddsIds", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "description": "Optional: comma/space-separated oddsIds to restrict the response." } ], "responses": { "200": { "description": "Returns FixtureHistoricalOddsResponse (fixture meta + time-series odds)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FixtureHistoricalOddsResponse" }, "examples": { "example": { "summary": "Historical odds", "value": { "fixtureId": "id1400003171515924", "reissuedFixtureId": null, "previousFixtureId": null, "status": { "live": false, "statusId": 0, "statusName": "Pre-Game" }, "sport": { "sportId": 14, "sportName": "American Football" }, "tournament": { "tournamentId": 31, "tournamentName": "NFL", "categoryName": "USA" }, "season": { "seasonId": 139396, "seasonName": "NFL 26/27", "seasonRound": 6 }, "venue": { "venueId": 15672, "venueName": "Levi's Stadium", "venueLocation": "Santa Clara, CA, USA" }, "startTime": 1792455300, "trueStartTime": null, "trueEndTime": null, "participants": { "participant1Id": 4389, "participant1RotNr": 141, "participant1Name": "San Francisco 49ers", "participant1ShortName": "San Francisco", "participant1Abbr": "SF", "participant2Id": 4432, "participant2RotNr": 140, "participant2Name": "Washington Commanders", "participant2ShortName": "Washington", "participant2Abbr": "WAS" }, "scores": {}, "clock": { "currentPeriod": null, "currentTime": null, "remainingTime": null, "remainingTimeInPeriod": null, "stopped": null, "updatedAt": null }, "expectedPeriods": 4, "periodLength": 15, "externalProviders": { "betgeniusId": null, "betradarId": 71515924, "flashscoreId": "Op9YIhXq", "mollybetId": "2026-10-20,21640,10050390", "oddinId": null, "opticoddsId": "20261020BC02533C", "pinnacleId": 1637707533, "sofascoreId": 16183736, "lsportsId": 19776801, "txoddsId": null }, "odds": { "pinnacle": { "id1400003171515924:pinnacle:14100:0": { "1792080445959": { "bookmaker": "pinnacle", "outcomeId": 14100, "playerId": 0, "price": 2.25, "active": true, "changedAt": 1792080445959, "marketActive": true, "mainLine": false, "priceFractional": "5/4", "priceAmerican": 125, "marketId": 14100, "limit": 3750 }, "1792089957678": { "bookmaker": "pinnacle", "outcomeId": 14100, "playerId": 0, "price": 2.24, "active": true, "changedAt": 1792089957678, "marketActive": true, "mainLine": false, "priceFractional": "31/25", "priceAmerican": 124, "marketId": 14100, "limit": 3750 } }, "id1400003171515924:pinnacle:14101:0": { "1792080445959": { "bookmaker": "pinnacle", "outcomeId": 14101, "playerId": 0, "price": 1.68, "active": true, "changedAt": 1792080445959, "marketActive": true, "mainLine": false, "priceFractional": "17/25", "priceAmerican": -147, "marketId": 14100, "limit": 5514 }, "1792089957678": { "bookmaker": "pinnacle", "outcomeId": 14101, "playerId": 0, "price": 1.684, "active": true, "changedAt": 1792089957678, "marketActive": true, "mainLine": false, "priceFractional": "13/19", "priceAmerican": -146, "marketId": 14100, "limit": 5482 } } } }, "bookmakers": { "pinnacle": { "bookmaker": "pinnacle", "bookmakerFixtureId": "1637707533", "fixturePath": "https://www.pinnacle.com/en/e/e/e/1637707533", "hasOdds": true, "staleOdds": false, "staleOddsResponseCode": 502, "suspended": false, "participantsRotated": false, "meta": null, "updatedAt": "2026-10-17T14:00:01.921523+00:00" } } } } } } } }, "400": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "401": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "403": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "404": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "429": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "502": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "503": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "504": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } } } } }, "/v1/en/fixtures/odds/main": { "get": { "summary": "Fixtures Odds Main", "description": "OddsPapi `GET /{lang}/fixtures/odds/main`, returned unchanged. The reference shows `en`; see [Languages](/api-reference/overview#languages) for the others.\n\nGet current main odds for multiple fixtures.\n\nLookup mode: provide exactly one of:\n- `tournamentId` (recommended)\n- `fixtureIds` (fast path)\n\nIf `since` is provided, returns odds updates with `changedAt >= since`.\n\n**Capped at 100 fixtures per call.** The limit is fixed and cannot be raised by a parameter — `limit`, `offset`, `cursor` and `page` are not supported and are ignored if sent. Truncation is silent: a `tournamentId` with more than 100 fixtures, or a `fixtureIds` list longer than 100, still returns `200` with only the first 100 entries and no warning. To cover a larger tournament, list the fixtures first with `/fixtures?tournamentId=...` (uncapped) and then request odds in chunks of 100 via `fixtureIds`.\n\nResponse size is driven by the number of **bookmakers**, not the number of fixtures. A single top-league call with `bookmakers=*` can return tens of MiB and take ten seconds, while the same call narrowed to one bookmaker returns well under a MiB in under a second. Always pass an explicit `bookmakers` list in production.\n\nOdds are limited to your account's bookmakers: without `bookmakers`, you get all of them; asking for another one answers `403 BOOKMAKER_NOT_AVAILABLE`.", "operationId": "feed_fixtures_odds_main", "tags": [ "Odds" ], "parameters": [ { "name": "tournamentId", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "description": "Single tournamentId. Required if `fixtureIds` is not provided. Only the first 100 fixtures of the tournament are returned; see the endpoint description for chunking." }, { "name": "fixtureIds", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "description": "Comma/space-separated fixtureIds (fast path). Required if `tournamentId` is not provided. Maximum 100 ids — anything beyond the first 100 is silently dropped." }, { "name": "bookmakers", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "description": "Comma/space-separated bookmaker slugs (default: all)." }, { "name": "since", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "description": "changedAt >= since (ms). If provided, returns also inactive odds." }, { "name": "activeOnly", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Forwarded to OddsPapi unchanged." } ], "responses": { "200": { "description": "Returns an array of fixtures (fixture meta + odds + bookmaker meta).", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FixtureOddsResponse" } }, "examples": { "example": { "summary": "Odds by tournament (fixtures list with odds)", "value": [ { "fixtureId": "id1400003171515924", "reissuedFixtureId": null, "previousFixtureId": null, "status": { "live": false, "statusId": 0, "statusName": "Pre-Game" }, "sport": { "sportId": 14, "sportName": "American Football" }, "tournament": { "tournamentId": 31, "tournamentName": "NFL", "categoryName": "USA" }, "season": { "seasonId": 139396, "seasonName": "NFL 26/27", "seasonRound": 6 }, "venue": { "venueId": 15672, "venueName": "Levi's Stadium", "venueLocation": "Santa Clara, CA, USA" }, "startTime": 1792455300, "trueStartTime": null, "trueEndTime": null, "participants": { "participant1Id": 4389, "participant1RotNr": 141, "participant1Name": "San Francisco 49ers", "participant1ShortName": "San Francisco", "participant1Abbr": "SF", "participant2Id": 4432, "participant2RotNr": 140, "participant2Name": "Washington Commanders", "participant2ShortName": "Washington", "participant2Abbr": "WAS" }, "scores": {}, "clock": { "currentPeriod": null, "currentTime": null, "remainingTime": null, "remainingTimeInPeriod": null, "stopped": null, "updatedAt": null }, "expectedPeriods": 4, "periodLength": 15, "externalProviders": { "betgeniusId": null, "betradarId": 71515924, "flashscoreId": "Op9YIhXq", "mollybetId": "2026-10-20,21640,10050390", "oddinId": null, "opticoddsId": "20261020BC02533C", "pinnacleId": 1637707533, "sofascoreId": 16183736, "lsportsId": 19776801, "txoddsId": null }, "odds": { "pinnacle": { "id1400003171515924:pinnacle:141149:0": { "outcomeId": 141149, "playerId": 0, "price": 1.675, "active": true, "changedAt": 1792444043445, "bookmaker": "pinnacle", "limit": 3333, "marketId": 141149, "marketActive": true, "mainLine": true, "bookmakerMarketId": "line/15/889/1637707533/3772268293/1/teamTotal", "bookmakerOutcomeId": "away/9.5/over", "bookmakerChangedAt": 1792444043163, "priceFractional": "27/40", "priceAmerican": -148 }, "id1400003171515924:pinnacle:141150:0": { "outcomeId": 141150, "playerId": 0, "price": 2.29, "active": true, "changedAt": 1792444043445, "bookmaker": "pinnacle", "limit": 2250, "marketId": 141149, "marketActive": true, "mainLine": true, "bookmakerMarketId": "line/15/889/1637707533/3772268293/1/teamTotal", "bookmakerOutcomeId": "away/9.5/under", "bookmakerChangedAt": 1792444043163, "priceFractional": "129/100", "priceAmerican": 129 } } }, "bookmakers": { "pinnacle": { "bookmaker": "pinnacle", "bookmakerFixtureId": "1637707533", "fixturePath": "https://www.pinnacle.com/en/e/e/e/1637707533", "hasOdds": true, "staleOdds": false, "staleOddsResponseCode": 502, "suspended": false, "participantsRotated": false, "meta": null, "updatedAt": "2026-10-17T14:00:01.921523+00:00" } } } ] } } } } }, "400": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "401": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "403": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "404": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "429": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "502": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "503": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "504": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } } } } }, "/v1/betslip": { "get": { "summary": "Get the betslip", "tags": [ "Betslip" ], "description": "Prices and stake limits for one selection at each bookmaker, with the account's rules applied. Without `bookmaker`, every bookmaker of the account is quoted. Fields are null when `active` is false.", "parameters": [ { "schema": { "minLength": 1, "maxLength": 255, "type": "string" }, "in": "query", "name": "fixtureId", "required": true }, { "schema": { "type": "integer" }, "in": "query", "name": "outcomeId", "required": true }, { "schema": { "default": 0, "type": "integer" }, "in": "query", "name": "playerId", "required": false }, { "schema": { "type": "array", "items": { "minLength": 1, "maxLength": 64, "type": "string" } }, "in": "query", "name": "bookmaker", "required": false, "description": "Repeat the parameter to ask for several values" } ], "security": [ { "apiKey": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "fixtureId", "outcomeId", "playerId", "bookmakers" ], "properties": { "fixtureId": { "type": "string" }, "outcomeId": { "type": "integer" }, "playerId": { "type": "integer" }, "bookmakers": { "type": "array", "items": { "type": "object", "required": [ "bookmaker", "active", "price", "minStake", "maxStake" ], "properties": { "bookmaker": { "type": "string" }, "active": { "description": "false when the bookmaker cannot take a bet on this selection right now", "type": "boolean" }, "price": { "description": "Price the account gets, after its rules. Sent as minPrice, it books at the bookmaker's current price.", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "minStake": { "anyOf": [ { "description": "Smallest stake the bookmaker accepts", "type": "object", "required": [ "amount", "amountCents", "currency" ], "properties": { "amount": { "pattern": "^-?\\d+\\.\\d{2}$", "description": "Decimal string, two decimals", "type": "string" }, "amountCents": { "description": "The same amount in integer cents: amount times 100", "type": "integer" }, "currency": { "description": "ISO 4217 code", "type": "string" } } }, { "type": "null" } ] }, "maxStake": { "anyOf": [ { "description": "Largest stake the account can place at this bookmaker", "type": "object", "required": [ "amount", "amountCents", "currency" ], "properties": { "amount": { "pattern": "^-?\\d+\\.\\d{2}$", "description": "Decimal string, two decimals", "type": "string" }, "amountCents": { "description": "The same amount in integer cents: amount times 100", "type": "integer" }, "currency": { "description": "ISO 4217 code", "type": "string" } } }, { "type": "null" } ] } } } } } } } } }, "400": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "401": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "403": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "404": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "429": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "502": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "503": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } } } } }, "/v1/orders": { "get": { "summary": "List orders", "tags": [ "Orders" ], "description": "The account's orders, newest first, dashboard orders included. A page filtered on status can hold fewer than `limit` orders and still carry a `nextCursor`: keep following it until it is null.", "parameters": [ { "schema": { "type": "array", "items": { "type": "string", "enum": [ "PENDING", "PARTIALLY_FILLED", "FILLED", "EXPIRED", "CANCELLED", "REJECTED" ] } }, "in": "query", "name": "status", "required": false, "description": "Repeat the parameter to ask for several statuses" }, { "schema": { "minLength": 1, "maxLength": 255, "type": "string" }, "in": "query", "name": "fixtureId", "required": false }, { "schema": { "format": "date-time", "type": "string" }, "in": "query", "name": "from", "required": false, "description": "createdAt at or after" }, { "schema": { "format": "date-time", "type": "string" }, "in": "query", "name": "to", "required": false, "description": "createdAt before" }, { "schema": { "minLength": 1, "maxLength": 512, "type": "string" }, "in": "query", "name": "cursor", "required": false }, { "schema": { "minimum": 1, "maximum": 200, "default": 50, "type": "integer" }, "in": "query", "name": "limit", "required": false } ], "security": [ { "apiKey": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "orders", "nextCursor" ], "properties": { "orders": { "type": "array", "items": { "type": "object", "required": [ "id", "clientOrderId", "status", "selection", "side", "bookmakers", "requestedStake", "filledStake", "remainingStake", "minPrice", "averageFilledPrice", "acceptBetterOdds", "acceptPartialStake", "expiresAt", "createdAt", "updatedAt", "version", "bets" ], "properties": { "id": { "format": "uuid", "type": "string" }, "clientOrderId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "status": { "type": "string", "enum": [ "PENDING", "PARTIALLY_FILLED", "FILLED", "EXPIRED", "CANCELLED", "REJECTED" ] }, "selection": { "type": "object", "required": [ "fixtureId", "outcomeId", "playerId", "sportId", "tournamentId", "marketId" ], "properties": { "fixtureId": { "type": "string" }, "outcomeId": { "type": "integer" }, "playerId": { "type": "integer" }, "sportId": { "type": "integer" }, "tournamentId": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "marketId": { "type": "integer" } } }, "side": { "description": "Only back is supported in v1", "type": "string", "enum": [ "back" ] }, "bookmakers": { "description": "Bookmakers the stake was split across", "type": "array", "items": { "type": "string" } }, "requestedStake": { "description": "Money amount", "type": "object", "required": [ "amount", "amountCents", "currency" ], "properties": { "amount": { "pattern": "^-?\\d+\\.\\d{2}$", "description": "Decimal string, two decimals", "type": "string" }, "amountCents": { "description": "The same amount in integer cents: amount times 100", "type": "integer" }, "currency": { "description": "ISO 4217 code", "type": "string" } } }, "filledStake": { "description": "Money amount", "type": "object", "required": [ "amount", "amountCents", "currency" ], "properties": { "amount": { "pattern": "^-?\\d+\\.\\d{2}$", "description": "Decimal string, two decimals", "type": "string" }, "amountCents": { "description": "The same amount in integer cents: amount times 100", "type": "integer" }, "currency": { "description": "ISO 4217 code", "type": "string" } } }, "remainingStake": { "description": "Money amount", "type": "object", "required": [ "amount", "amountCents", "currency" ], "properties": { "amount": { "pattern": "^-?\\d+\\.\\d{2}$", "description": "Decimal string, two decimals", "type": "string" }, "amountCents": { "description": "The same amount in integer cents: amount times 100", "type": "integer" }, "currency": { "description": "ISO 4217 code", "type": "string" } } }, "minPrice": { "description": "Decimal price floor", "type": "string" }, "averageFilledPrice": { "anyOf": [ { "description": "Stake-weighted price of the filled legs", "type": "string" }, { "type": "null" } ] }, "acceptBetterOdds": { "type": "boolean" }, "acceptPartialStake": { "type": "boolean" }, "expiresAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "createdAt": { "format": "date-time", "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" }, "version": { "description": "Goes up by one at every change of the order or one of its bets", "type": "integer" }, "bets": { "type": "array", "items": { "type": "object", "required": [ "id", "orderId", "bookmaker", "status", "requestedStake", "filledStake", "filledPrice", "declineReason", "placedAt", "filledAt", "settlement" ], "properties": { "id": { "format": "uuid", "type": "string" }, "orderId": { "format": "uuid", "type": "string" }, "bookmaker": { "type": "string" }, "status": { "type": "string", "enum": [ "PENDING", "WAITING", "PARTIALLY_PLACED", "PLACED", "REJECTED", "CANCELLED", "SETTLED" ] }, "requestedStake": { "description": "Money amount", "type": "object", "required": [ "amount", "amountCents", "currency" ], "properties": { "amount": { "pattern": "^-?\\d+\\.\\d{2}$", "description": "Decimal string, two decimals", "type": "string" }, "amountCents": { "description": "The same amount in integer cents: amount times 100", "type": "integer" }, "currency": { "description": "ISO 4217 code", "type": "string" } } }, "filledStake": { "anyOf": [ { "description": "Money amount", "type": "object", "required": [ "amount", "amountCents", "currency" ], "properties": { "amount": { "pattern": "^-?\\d+\\.\\d{2}$", "description": "Decimal string, two decimals", "type": "string" }, "amountCents": { "description": "The same amount in integer cents: amount times 100", "type": "integer" }, "currency": { "description": "ISO 4217 code", "type": "string" } } }, { "type": "null" } ] }, "filledPrice": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "declineReason": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placedAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "filledAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "settlement": { "type": "object", "required": [ "status", "amount", "settledAt" ], "properties": { "status": { "type": "string", "enum": [ "UNSETTLED", "WON", "LOST", "VOID", "HALF_WON", "HALF_LOST", "PUSH", "CASHOUT" ] }, "amount": { "description": "Profit or loss of the account on this bet", "anyOf": [ { "description": "Money amount", "type": "object", "required": [ "amount", "amountCents", "currency" ], "properties": { "amount": { "pattern": "^-?\\d+\\.\\d{2}$", "description": "Decimal string, two decimals", "type": "string" }, "amountCents": { "description": "The same amount in integer cents: amount times 100", "type": "integer" }, "currency": { "description": "ISO 4217 code", "type": "string" } } }, { "type": "null" } ] }, "settledAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] } } } } } } } } }, "nextCursor": { "anyOf": [ { "description": "Pass it back as cursor for the next page; null on the last page", "type": "string" }, { "type": "null" } ] } } } } } }, "400": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "401": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "403": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "429": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "503": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } } } }, "post": { "summary": "Place or preview an order", "tags": [ "Orders" ], "description": "mode \"place\" answers 201 with the new order, or 200 with the existing order when the same request is resent with its clientOrderId. mode \"preview\" answers 200 with what would be placed now, status PREVIEW, and stores nothing.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "mode", "clientOrderId", "fixtureId", "outcomeId", "side", "stake", "minPrice", "acceptBetterOdds", "acceptPartialStake" ], "properties": { "mode": { "description": "\"preview\" applies rules and limits and stores nothing; \"place\" places the order. No default.", "type": "string", "enum": [ "preview", "place" ] }, "clientOrderId": { "minLength": 1, "maxLength": 200, "description": "Unique per account. Resending the same request with it returns the same order.", "type": "string" }, "fixtureId": { "minLength": 1, "maxLength": 255, "type": "string" }, "outcomeId": { "type": "integer" }, "playerId": { "minimum": 0, "default": 0, "type": "integer" }, "side": { "description": "Only back is supported in v1", "type": "string", "enum": [ "back" ] }, "bookmakers": { "minItems": 1, "maxItems": 50, "description": "Bookmakers to split the stake across. Omitted: every bookmaker of the account, except those closed to the API.", "type": "array", "items": { "minLength": 1, "maxLength": 64, "type": "string" } }, "stake": { "type": "object", "required": [ "amount", "currency" ], "properties": { "amount": { "pattern": "^\\d+(\\.\\d{1,2})?$", "description": "Positive decimal string, at most two decimals", "type": "string" }, "currency": { "pattern": "^[A-Z]{3}$", "description": "ISO 4217 code; must be the account currency (USD)", "type": "string" } } }, "minPrice": { "pattern": "^\\d+(\\.\\d{1,4})?$", "description": "Decimal price floor, at least 1.001", "type": "string" }, "acceptBetterOdds": { "type": "boolean" }, "acceptPartialStake": { "description": "true without expiresAt: immediate or cancel; false: fill or kill", "type": "boolean" }, "expiresAt": { "format": "date-time", "description": "Keep working the remainder until then, at most 1 hour ahead", "type": "string" } } } } } }, "security": [ { "apiKey": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "required": [ "id", "clientOrderId", "status", "selection", "side", "bookmakers", "requestedStake", "filledStake", "remainingStake", "minPrice", "averageFilledPrice", "acceptBetterOdds", "acceptPartialStake", "expiresAt", "createdAt", "updatedAt", "version", "bets" ], "properties": { "id": { "format": "uuid", "type": "string" }, "clientOrderId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "status": { "type": "string", "enum": [ "PENDING", "PARTIALLY_FILLED", "FILLED", "EXPIRED", "CANCELLED", "REJECTED" ] }, "selection": { "type": "object", "required": [ "fixtureId", "outcomeId", "playerId", "sportId", "tournamentId", "marketId" ], "properties": { "fixtureId": { "type": "string" }, "outcomeId": { "type": "integer" }, "playerId": { "type": "integer" }, "sportId": { "type": "integer" }, "tournamentId": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "marketId": { "type": "integer" } } }, "side": { "description": "Only back is supported in v1", "type": "string", "enum": [ "back" ] }, "bookmakers": { "description": "Bookmakers the stake was split across", "type": "array", "items": { "type": "string" } }, "requestedStake": { "description": "Money amount", "type": "object", "required": [ "amount", "amountCents", "currency" ], "properties": { "amount": { "pattern": "^-?\\d+\\.\\d{2}$", "description": "Decimal string, two decimals", "type": "string" }, "amountCents": { "description": "The same amount in integer cents: amount times 100", "type": "integer" }, "currency": { "description": "ISO 4217 code", "type": "string" } } }, "filledStake": { "description": "Money amount", "type": "object", "required": [ "amount", "amountCents", "currency" ], "properties": { "amount": { "pattern": "^-?\\d+\\.\\d{2}$", "description": "Decimal string, two decimals", "type": "string" }, "amountCents": { "description": "The same amount in integer cents: amount times 100", "type": "integer" }, "currency": { "description": "ISO 4217 code", "type": "string" } } }, "remainingStake": { "description": "Money amount", "type": "object", "required": [ "amount", "amountCents", "currency" ], "properties": { "amount": { "pattern": "^-?\\d+\\.\\d{2}$", "description": "Decimal string, two decimals", "type": "string" }, "amountCents": { "description": "The same amount in integer cents: amount times 100", "type": "integer" }, "currency": { "description": "ISO 4217 code", "type": "string" } } }, "minPrice": { "description": "Decimal price floor", "type": "string" }, "averageFilledPrice": { "anyOf": [ { "description": "Stake-weighted price of the filled legs", "type": "string" }, { "type": "null" } ] }, "acceptBetterOdds": { "type": "boolean" }, "acceptPartialStake": { "type": "boolean" }, "expiresAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "createdAt": { "format": "date-time", "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" }, "version": { "description": "Goes up by one at every change of the order or one of its bets", "type": "integer" }, "bets": { "type": "array", "items": { "type": "object", "required": [ "id", "orderId", "bookmaker", "status", "requestedStake", "filledStake", "filledPrice", "declineReason", "placedAt", "filledAt", "settlement" ], "properties": { "id": { "format": "uuid", "type": "string" }, "orderId": { "format": "uuid", "type": "string" }, "bookmaker": { "type": "string" }, "status": { "type": "string", "enum": [ "PENDING", "WAITING", "PARTIALLY_PLACED", "PLACED", "REJECTED", "CANCELLED", "SETTLED" ] }, "requestedStake": { "description": "Money amount", "type": "object", "required": [ "amount", "amountCents", "currency" ], "properties": { "amount": { "pattern": "^-?\\d+\\.\\d{2}$", "description": "Decimal string, two decimals", "type": "string" }, "amountCents": { "description": "The same amount in integer cents: amount times 100", "type": "integer" }, "currency": { "description": "ISO 4217 code", "type": "string" } } }, "filledStake": { "anyOf": [ { "description": "Money amount", "type": "object", "required": [ "amount", "amountCents", "currency" ], "properties": { "amount": { "pattern": "^-?\\d+\\.\\d{2}$", "description": "Decimal string, two decimals", "type": "string" }, "amountCents": { "description": "The same amount in integer cents: amount times 100", "type": "integer" }, "currency": { "description": "ISO 4217 code", "type": "string" } } }, { "type": "null" } ] }, "filledPrice": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "declineReason": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placedAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "filledAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "settlement": { "type": "object", "required": [ "status", "amount", "settledAt" ], "properties": { "status": { "type": "string", "enum": [ "UNSETTLED", "WON", "LOST", "VOID", "HALF_WON", "HALF_LOST", "PUSH", "CASHOUT" ] }, "amount": { "description": "Profit or loss of the account on this bet", "anyOf": [ { "description": "Money amount", "type": "object", "required": [ "amount", "amountCents", "currency" ], "properties": { "amount": { "pattern": "^-?\\d+\\.\\d{2}$", "description": "Decimal string, two decimals", "type": "string" }, "amountCents": { "description": "The same amount in integer cents: amount times 100", "type": "integer" }, "currency": { "description": "ISO 4217 code", "type": "string" } } }, { "type": "null" } ] }, "settledAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] } } } } } } } }, { "type": "object", "required": [ "clientOrderId", "status", "selection", "side", "bookmakers", "requestedStake", "filledStake", "remainingStake", "minPrice", "averageFilledPrice", "acceptBetterOdds", "acceptPartialStake", "expiresAt", "bets" ], "properties": { "clientOrderId": { "type": "string" }, "status": { "type": "string", "enum": [ "PREVIEW" ] }, "selection": { "type": "object", "required": [ "fixtureId", "outcomeId", "playerId", "sportId", "tournamentId", "marketId" ], "properties": { "fixtureId": { "type": "string" }, "outcomeId": { "type": "integer" }, "playerId": { "type": "integer" }, "sportId": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "tournamentId": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "marketId": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] } } }, "side": { "description": "Only back is supported in v1", "type": "string", "enum": [ "back" ] }, "bookmakers": { "description": "Bookmakers the stake was split across", "type": "array", "items": { "type": "string" } }, "requestedStake": { "description": "Money amount", "type": "object", "required": [ "amount", "amountCents", "currency" ], "properties": { "amount": { "pattern": "^-?\\d+\\.\\d{2}$", "description": "Decimal string, two decimals", "type": "string" }, "amountCents": { "description": "The same amount in integer cents: amount times 100", "type": "integer" }, "currency": { "description": "ISO 4217 code", "type": "string" } } }, "filledStake": { "description": "Money amount", "type": "object", "required": [ "amount", "amountCents", "currency" ], "properties": { "amount": { "pattern": "^-?\\d+\\.\\d{2}$", "description": "Decimal string, two decimals", "type": "string" }, "amountCents": { "description": "The same amount in integer cents: amount times 100", "type": "integer" }, "currency": { "description": "ISO 4217 code", "type": "string" } } }, "remainingStake": { "description": "Money amount", "type": "object", "required": [ "amount", "amountCents", "currency" ], "properties": { "amount": { "pattern": "^-?\\d+\\.\\d{2}$", "description": "Decimal string, two decimals", "type": "string" }, "amountCents": { "description": "The same amount in integer cents: amount times 100", "type": "integer" }, "currency": { "description": "ISO 4217 code", "type": "string" } } }, "minPrice": { "description": "Decimal price floor", "type": "string" }, "averageFilledPrice": { "anyOf": [ { "description": "Stake-weighted price of the filled legs", "type": "string" }, { "type": "null" } ] }, "acceptBetterOdds": { "type": "boolean" }, "acceptPartialStake": { "type": "boolean" }, "expiresAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "bets": { "type": "array", "items": { "type": "object", "required": [ "bookmaker", "status", "requestedStake", "filledStake", "filledPrice", "declineReason" ], "properties": { "bookmaker": { "type": "string" }, "status": { "type": "string", "enum": [ "PENDING", "WAITING", "PARTIALLY_PLACED", "PLACED", "REJECTED", "CANCELLED", "SETTLED" ] }, "requestedStake": { "description": "Money amount", "type": "object", "required": [ "amount", "amountCents", "currency" ], "properties": { "amount": { "pattern": "^-?\\d+\\.\\d{2}$", "description": "Decimal string, two decimals", "type": "string" }, "amountCents": { "description": "The same amount in integer cents: amount times 100", "type": "integer" }, "currency": { "description": "ISO 4217 code", "type": "string" } } }, "filledStake": { "anyOf": [ { "description": "Money amount", "type": "object", "required": [ "amount", "amountCents", "currency" ], "properties": { "amount": { "pattern": "^-?\\d+\\.\\d{2}$", "description": "Decimal string, two decimals", "type": "string" }, "amountCents": { "description": "The same amount in integer cents: amount times 100", "type": "integer" }, "currency": { "description": "ISO 4217 code", "type": "string" } } }, { "type": "null" } ] }, "filledPrice": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "declineReason": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } } } } } } ] } } } }, "201": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "clientOrderId", "status", "selection", "side", "bookmakers", "requestedStake", "filledStake", "remainingStake", "minPrice", "averageFilledPrice", "acceptBetterOdds", "acceptPartialStake", "expiresAt", "createdAt", "updatedAt", "version", "bets" ], "properties": { "id": { "format": "uuid", "type": "string" }, "clientOrderId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "status": { "type": "string", "enum": [ "PENDING", "PARTIALLY_FILLED", "FILLED", "EXPIRED", "CANCELLED", "REJECTED" ] }, "selection": { "type": "object", "required": [ "fixtureId", "outcomeId", "playerId", "sportId", "tournamentId", "marketId" ], "properties": { "fixtureId": { "type": "string" }, "outcomeId": { "type": "integer" }, "playerId": { "type": "integer" }, "sportId": { "type": "integer" }, "tournamentId": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "marketId": { "type": "integer" } } }, "side": { "description": "Only back is supported in v1", "type": "string", "enum": [ "back" ] }, "bookmakers": { "description": "Bookmakers the stake was split across", "type": "array", "items": { "type": "string" } }, "requestedStake": { "description": "Money amount", "type": "object", "required": [ "amount", "amountCents", "currency" ], "properties": { "amount": { "pattern": "^-?\\d+\\.\\d{2}$", "description": "Decimal string, two decimals", "type": "string" }, "amountCents": { "description": "The same amount in integer cents: amount times 100", "type": "integer" }, "currency": { "description": "ISO 4217 code", "type": "string" } } }, "filledStake": { "description": "Money amount", "type": "object", "required": [ "amount", "amountCents", "currency" ], "properties": { "amount": { "pattern": "^-?\\d+\\.\\d{2}$", "description": "Decimal string, two decimals", "type": "string" }, "amountCents": { "description": "The same amount in integer cents: amount times 100", "type": "integer" }, "currency": { "description": "ISO 4217 code", "type": "string" } } }, "remainingStake": { "description": "Money amount", "type": "object", "required": [ "amount", "amountCents", "currency" ], "properties": { "amount": { "pattern": "^-?\\d+\\.\\d{2}$", "description": "Decimal string, two decimals", "type": "string" }, "amountCents": { "description": "The same amount in integer cents: amount times 100", "type": "integer" }, "currency": { "description": "ISO 4217 code", "type": "string" } } }, "minPrice": { "description": "Decimal price floor", "type": "string" }, "averageFilledPrice": { "anyOf": [ { "description": "Stake-weighted price of the filled legs", "type": "string" }, { "type": "null" } ] }, "acceptBetterOdds": { "type": "boolean" }, "acceptPartialStake": { "type": "boolean" }, "expiresAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "createdAt": { "format": "date-time", "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" }, "version": { "description": "Goes up by one at every change of the order or one of its bets", "type": "integer" }, "bets": { "type": "array", "items": { "type": "object", "required": [ "id", "orderId", "bookmaker", "status", "requestedStake", "filledStake", "filledPrice", "declineReason", "placedAt", "filledAt", "settlement" ], "properties": { "id": { "format": "uuid", "type": "string" }, "orderId": { "format": "uuid", "type": "string" }, "bookmaker": { "type": "string" }, "status": { "type": "string", "enum": [ "PENDING", "WAITING", "PARTIALLY_PLACED", "PLACED", "REJECTED", "CANCELLED", "SETTLED" ] }, "requestedStake": { "description": "Money amount", "type": "object", "required": [ "amount", "amountCents", "currency" ], "properties": { "amount": { "pattern": "^-?\\d+\\.\\d{2}$", "description": "Decimal string, two decimals", "type": "string" }, "amountCents": { "description": "The same amount in integer cents: amount times 100", "type": "integer" }, "currency": { "description": "ISO 4217 code", "type": "string" } } }, "filledStake": { "anyOf": [ { "description": "Money amount", "type": "object", "required": [ "amount", "amountCents", "currency" ], "properties": { "amount": { "pattern": "^-?\\d+\\.\\d{2}$", "description": "Decimal string, two decimals", "type": "string" }, "amountCents": { "description": "The same amount in integer cents: amount times 100", "type": "integer" }, "currency": { "description": "ISO 4217 code", "type": "string" } } }, { "type": "null" } ] }, "filledPrice": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "declineReason": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placedAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "filledAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "settlement": { "type": "object", "required": [ "status", "amount", "settledAt" ], "properties": { "status": { "type": "string", "enum": [ "UNSETTLED", "WON", "LOST", "VOID", "HALF_WON", "HALF_LOST", "PUSH", "CASHOUT" ] }, "amount": { "description": "Profit or loss of the account on this bet", "anyOf": [ { "description": "Money amount", "type": "object", "required": [ "amount", "amountCents", "currency" ], "properties": { "amount": { "pattern": "^-?\\d+\\.\\d{2}$", "description": "Decimal string, two decimals", "type": "string" }, "amountCents": { "description": "The same amount in integer cents: amount times 100", "type": "integer" }, "currency": { "description": "ISO 4217 code", "type": "string" } } }, { "type": "null" } ] }, "settledAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] } } } } } } } } } } }, "400": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "401": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "403": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "409": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "429": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "502": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "503": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } } } } }, "/v1/orders/{id}": { "get": { "summary": "Get an order", "tags": [ "Orders" ], "description": "One of the account's orders with its bets. Orders placed from the dashboard are included.", "parameters": [ { "schema": { "format": "uuid", "type": "string" }, "in": "path", "name": "id", "required": true } ], "security": [ { "apiKey": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "clientOrderId", "status", "selection", "side", "bookmakers", "requestedStake", "filledStake", "remainingStake", "minPrice", "averageFilledPrice", "acceptBetterOdds", "acceptPartialStake", "expiresAt", "createdAt", "updatedAt", "version", "bets" ], "properties": { "id": { "format": "uuid", "type": "string" }, "clientOrderId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "status": { "type": "string", "enum": [ "PENDING", "PARTIALLY_FILLED", "FILLED", "EXPIRED", "CANCELLED", "REJECTED" ] }, "selection": { "type": "object", "required": [ "fixtureId", "outcomeId", "playerId", "sportId", "tournamentId", "marketId" ], "properties": { "fixtureId": { "type": "string" }, "outcomeId": { "type": "integer" }, "playerId": { "type": "integer" }, "sportId": { "type": "integer" }, "tournamentId": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "marketId": { "type": "integer" } } }, "side": { "description": "Only back is supported in v1", "type": "string", "enum": [ "back" ] }, "bookmakers": { "description": "Bookmakers the stake was split across", "type": "array", "items": { "type": "string" } }, "requestedStake": { "description": "Money amount", "type": "object", "required": [ "amount", "amountCents", "currency" ], "properties": { "amount": { "pattern": "^-?\\d+\\.\\d{2}$", "description": "Decimal string, two decimals", "type": "string" }, "amountCents": { "description": "The same amount in integer cents: amount times 100", "type": "integer" }, "currency": { "description": "ISO 4217 code", "type": "string" } } }, "filledStake": { "description": "Money amount", "type": "object", "required": [ "amount", "amountCents", "currency" ], "properties": { "amount": { "pattern": "^-?\\d+\\.\\d{2}$", "description": "Decimal string, two decimals", "type": "string" }, "amountCents": { "description": "The same amount in integer cents: amount times 100", "type": "integer" }, "currency": { "description": "ISO 4217 code", "type": "string" } } }, "remainingStake": { "description": "Money amount", "type": "object", "required": [ "amount", "amountCents", "currency" ], "properties": { "amount": { "pattern": "^-?\\d+\\.\\d{2}$", "description": "Decimal string, two decimals", "type": "string" }, "amountCents": { "description": "The same amount in integer cents: amount times 100", "type": "integer" }, "currency": { "description": "ISO 4217 code", "type": "string" } } }, "minPrice": { "description": "Decimal price floor", "type": "string" }, "averageFilledPrice": { "anyOf": [ { "description": "Stake-weighted price of the filled legs", "type": "string" }, { "type": "null" } ] }, "acceptBetterOdds": { "type": "boolean" }, "acceptPartialStake": { "type": "boolean" }, "expiresAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "createdAt": { "format": "date-time", "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" }, "version": { "description": "Goes up by one at every change of the order or one of its bets", "type": "integer" }, "bets": { "type": "array", "items": { "type": "object", "required": [ "id", "orderId", "bookmaker", "status", "requestedStake", "filledStake", "filledPrice", "declineReason", "placedAt", "filledAt", "settlement" ], "properties": { "id": { "format": "uuid", "type": "string" }, "orderId": { "format": "uuid", "type": "string" }, "bookmaker": { "type": "string" }, "status": { "type": "string", "enum": [ "PENDING", "WAITING", "PARTIALLY_PLACED", "PLACED", "REJECTED", "CANCELLED", "SETTLED" ] }, "requestedStake": { "description": "Money amount", "type": "object", "required": [ "amount", "amountCents", "currency" ], "properties": { "amount": { "pattern": "^-?\\d+\\.\\d{2}$", "description": "Decimal string, two decimals", "type": "string" }, "amountCents": { "description": "The same amount in integer cents: amount times 100", "type": "integer" }, "currency": { "description": "ISO 4217 code", "type": "string" } } }, "filledStake": { "anyOf": [ { "description": "Money amount", "type": "object", "required": [ "amount", "amountCents", "currency" ], "properties": { "amount": { "pattern": "^-?\\d+\\.\\d{2}$", "description": "Decimal string, two decimals", "type": "string" }, "amountCents": { "description": "The same amount in integer cents: amount times 100", "type": "integer" }, "currency": { "description": "ISO 4217 code", "type": "string" } } }, { "type": "null" } ] }, "filledPrice": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "declineReason": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placedAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "filledAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "settlement": { "type": "object", "required": [ "status", "amount", "settledAt" ], "properties": { "status": { "type": "string", "enum": [ "UNSETTLED", "WON", "LOST", "VOID", "HALF_WON", "HALF_LOST", "PUSH", "CASHOUT" ] }, "amount": { "description": "Profit or loss of the account on this bet", "anyOf": [ { "description": "Money amount", "type": "object", "required": [ "amount", "amountCents", "currency" ], "properties": { "amount": { "pattern": "^-?\\d+\\.\\d{2}$", "description": "Decimal string, two decimals", "type": "string" }, "amountCents": { "description": "The same amount in integer cents: amount times 100", "type": "integer" }, "currency": { "description": "ISO 4217 code", "type": "string" } } }, { "type": "null" } ] }, "settledAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] } } } } } } } } } } }, "400": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "401": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "403": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "404": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "429": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "503": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } } } } }, "/v1/orders/{id}/cancel": { "post": { "summary": "Cancel an order", "tags": [ "Orders" ], "description": "Stops the expiry remainder and asks the bookmaker to cancel every bet it has not accepted yet. A bet the bookmaker accepted cannot be recalled. Each bet is tagged with its outcome; cancelling again gives the same answer. Not counted against any per-key rate limit.", "parameters": [ { "schema": { "format": "uuid", "type": "string" }, "in": "path", "name": "id", "required": true } ], "security": [ { "apiKey": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "clientOrderId", "status", "selection", "side", "bookmakers", "requestedStake", "filledStake", "remainingStake", "minPrice", "averageFilledPrice", "acceptBetterOdds", "acceptPartialStake", "expiresAt", "createdAt", "updatedAt", "version", "remainder", "bets" ], "properties": { "id": { "format": "uuid", "type": "string" }, "clientOrderId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "status": { "type": "string", "enum": [ "PENDING", "PARTIALLY_FILLED", "FILLED", "EXPIRED", "CANCELLED", "REJECTED" ] }, "selection": { "type": "object", "required": [ "fixtureId", "outcomeId", "playerId", "sportId", "tournamentId", "marketId" ], "properties": { "fixtureId": { "type": "string" }, "outcomeId": { "type": "integer" }, "playerId": { "type": "integer" }, "sportId": { "type": "integer" }, "tournamentId": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "marketId": { "type": "integer" } } }, "side": { "description": "Only back is supported in v1", "type": "string", "enum": [ "back" ] }, "bookmakers": { "description": "Bookmakers the stake was split across", "type": "array", "items": { "type": "string" } }, "requestedStake": { "description": "Money amount", "type": "object", "required": [ "amount", "amountCents", "currency" ], "properties": { "amount": { "pattern": "^-?\\d+\\.\\d{2}$", "description": "Decimal string, two decimals", "type": "string" }, "amountCents": { "description": "The same amount in integer cents: amount times 100", "type": "integer" }, "currency": { "description": "ISO 4217 code", "type": "string" } } }, "filledStake": { "description": "Money amount", "type": "object", "required": [ "amount", "amountCents", "currency" ], "properties": { "amount": { "pattern": "^-?\\d+\\.\\d{2}$", "description": "Decimal string, two decimals", "type": "string" }, "amountCents": { "description": "The same amount in integer cents: amount times 100", "type": "integer" }, "currency": { "description": "ISO 4217 code", "type": "string" } } }, "remainingStake": { "description": "Money amount", "type": "object", "required": [ "amount", "amountCents", "currency" ], "properties": { "amount": { "pattern": "^-?\\d+\\.\\d{2}$", "description": "Decimal string, two decimals", "type": "string" }, "amountCents": { "description": "The same amount in integer cents: amount times 100", "type": "integer" }, "currency": { "description": "ISO 4217 code", "type": "string" } } }, "minPrice": { "description": "Decimal price floor", "type": "string" }, "averageFilledPrice": { "anyOf": [ { "description": "Stake-weighted price of the filled legs", "type": "string" }, { "type": "null" } ] }, "acceptBetterOdds": { "type": "boolean" }, "acceptPartialStake": { "type": "boolean" }, "expiresAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "createdAt": { "format": "date-time", "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" }, "version": { "description": "Goes up by one at every change of the order or one of its bets", "type": "integer" }, "remainder": { "type": "string", "enum": [ "cancelled", "alreadyTerminal", "none" ] }, "bets": { "type": "array", "items": { "type": "object", "required": [ "id", "orderId", "bookmaker", "status", "requestedStake", "filledStake", "filledPrice", "declineReason", "placedAt", "filledAt", "settlement", "cancellation" ], "properties": { "id": { "format": "uuid", "type": "string" }, "orderId": { "format": "uuid", "type": "string" }, "bookmaker": { "type": "string" }, "status": { "type": "string", "enum": [ "PENDING", "WAITING", "PARTIALLY_PLACED", "PLACED", "REJECTED", "CANCELLED", "SETTLED" ] }, "requestedStake": { "description": "Money amount", "type": "object", "required": [ "amount", "amountCents", "currency" ], "properties": { "amount": { "pattern": "^-?\\d+\\.\\d{2}$", "description": "Decimal string, two decimals", "type": "string" }, "amountCents": { "description": "The same amount in integer cents: amount times 100", "type": "integer" }, "currency": { "description": "ISO 4217 code", "type": "string" } } }, "filledStake": { "anyOf": [ { "description": "Money amount", "type": "object", "required": [ "amount", "amountCents", "currency" ], "properties": { "amount": { "pattern": "^-?\\d+\\.\\d{2}$", "description": "Decimal string, two decimals", "type": "string" }, "amountCents": { "description": "The same amount in integer cents: amount times 100", "type": "integer" }, "currency": { "description": "ISO 4217 code", "type": "string" } } }, { "type": "null" } ] }, "filledPrice": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "declineReason": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placedAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "filledAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "settlement": { "type": "object", "required": [ "status", "amount", "settledAt" ], "properties": { "status": { "type": "string", "enum": [ "UNSETTLED", "WON", "LOST", "VOID", "HALF_WON", "HALF_LOST", "PUSH", "CASHOUT" ] }, "amount": { "description": "Profit or loss of the account on this bet", "anyOf": [ { "description": "Money amount", "type": "object", "required": [ "amount", "amountCents", "currency" ], "properties": { "amount": { "pattern": "^-?\\d+\\.\\d{2}$", "description": "Decimal string, two decimals", "type": "string" }, "amountCents": { "description": "The same amount in integer cents: amount times 100", "type": "integer" }, "currency": { "description": "ISO 4217 code", "type": "string" } } }, { "type": "null" } ] }, "settledAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] } } }, "cancellation": { "type": "string", "enum": [ "cancelled", "alreadyTerminal", "notRecallable" ] } } } } } } } } }, "400": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "401": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "403": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "404": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "409": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "429": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "502": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "503": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } } } } }, "/v1/orders/by-client-id/{clientOrderId}": { "get": { "summary": "Get an order by its clientOrderId", "tags": [ "Orders" ], "description": "One of the account's orders, found by the clientOrderId it was placed with.", "parameters": [ { "schema": { "minLength": 1, "maxLength": 200, "type": "string" }, "in": "path", "name": "clientOrderId", "required": true } ], "security": [ { "apiKey": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "clientOrderId", "status", "selection", "side", "bookmakers", "requestedStake", "filledStake", "remainingStake", "minPrice", "averageFilledPrice", "acceptBetterOdds", "acceptPartialStake", "expiresAt", "createdAt", "updatedAt", "version", "bets" ], "properties": { "id": { "format": "uuid", "type": "string" }, "clientOrderId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "status": { "type": "string", "enum": [ "PENDING", "PARTIALLY_FILLED", "FILLED", "EXPIRED", "CANCELLED", "REJECTED" ] }, "selection": { "type": "object", "required": [ "fixtureId", "outcomeId", "playerId", "sportId", "tournamentId", "marketId" ], "properties": { "fixtureId": { "type": "string" }, "outcomeId": { "type": "integer" }, "playerId": { "type": "integer" }, "sportId": { "type": "integer" }, "tournamentId": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "marketId": { "type": "integer" } } }, "side": { "description": "Only back is supported in v1", "type": "string", "enum": [ "back" ] }, "bookmakers": { "description": "Bookmakers the stake was split across", "type": "array", "items": { "type": "string" } }, "requestedStake": { "description": "Money amount", "type": "object", "required": [ "amount", "amountCents", "currency" ], "properties": { "amount": { "pattern": "^-?\\d+\\.\\d{2}$", "description": "Decimal string, two decimals", "type": "string" }, "amountCents": { "description": "The same amount in integer cents: amount times 100", "type": "integer" }, "currency": { "description": "ISO 4217 code", "type": "string" } } }, "filledStake": { "description": "Money amount", "type": "object", "required": [ "amount", "amountCents", "currency" ], "properties": { "amount": { "pattern": "^-?\\d+\\.\\d{2}$", "description": "Decimal string, two decimals", "type": "string" }, "amountCents": { "description": "The same amount in integer cents: amount times 100", "type": "integer" }, "currency": { "description": "ISO 4217 code", "type": "string" } } }, "remainingStake": { "description": "Money amount", "type": "object", "required": [ "amount", "amountCents", "currency" ], "properties": { "amount": { "pattern": "^-?\\d+\\.\\d{2}$", "description": "Decimal string, two decimals", "type": "string" }, "amountCents": { "description": "The same amount in integer cents: amount times 100", "type": "integer" }, "currency": { "description": "ISO 4217 code", "type": "string" } } }, "minPrice": { "description": "Decimal price floor", "type": "string" }, "averageFilledPrice": { "anyOf": [ { "description": "Stake-weighted price of the filled legs", "type": "string" }, { "type": "null" } ] }, "acceptBetterOdds": { "type": "boolean" }, "acceptPartialStake": { "type": "boolean" }, "expiresAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "createdAt": { "format": "date-time", "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" }, "version": { "description": "Goes up by one at every change of the order or one of its bets", "type": "integer" }, "bets": { "type": "array", "items": { "type": "object", "required": [ "id", "orderId", "bookmaker", "status", "requestedStake", "filledStake", "filledPrice", "declineReason", "placedAt", "filledAt", "settlement" ], "properties": { "id": { "format": "uuid", "type": "string" }, "orderId": { "format": "uuid", "type": "string" }, "bookmaker": { "type": "string" }, "status": { "type": "string", "enum": [ "PENDING", "WAITING", "PARTIALLY_PLACED", "PLACED", "REJECTED", "CANCELLED", "SETTLED" ] }, "requestedStake": { "description": "Money amount", "type": "object", "required": [ "amount", "amountCents", "currency" ], "properties": { "amount": { "pattern": "^-?\\d+\\.\\d{2}$", "description": "Decimal string, two decimals", "type": "string" }, "amountCents": { "description": "The same amount in integer cents: amount times 100", "type": "integer" }, "currency": { "description": "ISO 4217 code", "type": "string" } } }, "filledStake": { "anyOf": [ { "description": "Money amount", "type": "object", "required": [ "amount", "amountCents", "currency" ], "properties": { "amount": { "pattern": "^-?\\d+\\.\\d{2}$", "description": "Decimal string, two decimals", "type": "string" }, "amountCents": { "description": "The same amount in integer cents: amount times 100", "type": "integer" }, "currency": { "description": "ISO 4217 code", "type": "string" } } }, { "type": "null" } ] }, "filledPrice": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "declineReason": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placedAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "filledAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "settlement": { "type": "object", "required": [ "status", "amount", "settledAt" ], "properties": { "status": { "type": "string", "enum": [ "UNSETTLED", "WON", "LOST", "VOID", "HALF_WON", "HALF_LOST", "PUSH", "CASHOUT" ] }, "amount": { "description": "Profit or loss of the account on this bet", "anyOf": [ { "description": "Money amount", "type": "object", "required": [ "amount", "amountCents", "currency" ], "properties": { "amount": { "pattern": "^-?\\d+\\.\\d{2}$", "description": "Decimal string, two decimals", "type": "string" }, "amountCents": { "description": "The same amount in integer cents: amount times 100", "type": "integer" }, "currency": { "description": "ISO 4217 code", "type": "string" } } }, { "type": "null" } ] }, "settledAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] } } } } } } } } } } }, "400": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "401": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "403": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "404": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "429": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "503": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } } } } }, "/v1/orders/cancel-all": { "post": { "summary": "Cancel working orders", "tags": [ "Orders" ], "description": "Cancels the working orders of the account, of one fixture, or the listed orders. One call handles at most 200 orders: while nextCursor is not null, call again with it to continue. Listed ids that match no order of the account (under fixtureId when given) come back in notFound. Orders busy with a placement come back in busy: cancel them again shortly. Not counted against any per-key rate limit.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "fixtureId": { "minLength": 1, "maxLength": 255, "type": "string" }, "orderIds": { "minItems": 1, "maxItems": 200, "type": "array", "items": { "format": "uuid", "type": "string" } }, "cursor": { "minLength": 1, "maxLength": 512, "description": "nextCursor of the previous call; not with orderIds", "type": "string" } } } } } }, "security": [ { "apiKey": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "orders", "notFound", "busy", "nextCursor" ], "properties": { "orders": { "type": "array", "items": { "type": "object", "required": [ "id", "clientOrderId", "status", "selection", "side", "bookmakers", "requestedStake", "filledStake", "remainingStake", "minPrice", "averageFilledPrice", "acceptBetterOdds", "acceptPartialStake", "expiresAt", "createdAt", "updatedAt", "version", "remainder", "bets" ], "properties": { "id": { "format": "uuid", "type": "string" }, "clientOrderId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "status": { "type": "string", "enum": [ "PENDING", "PARTIALLY_FILLED", "FILLED", "EXPIRED", "CANCELLED", "REJECTED" ] }, "selection": { "type": "object", "required": [ "fixtureId", "outcomeId", "playerId", "sportId", "tournamentId", "marketId" ], "properties": { "fixtureId": { "type": "string" }, "outcomeId": { "type": "integer" }, "playerId": { "type": "integer" }, "sportId": { "type": "integer" }, "tournamentId": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "marketId": { "type": "integer" } } }, "side": { "description": "Only back is supported in v1", "type": "string", "enum": [ "back" ] }, "bookmakers": { "description": "Bookmakers the stake was split across", "type": "array", "items": { "type": "string" } }, "requestedStake": { "description": "Money amount", "type": "object", "required": [ "amount", "amountCents", "currency" ], "properties": { "amount": { "pattern": "^-?\\d+\\.\\d{2}$", "description": "Decimal string, two decimals", "type": "string" }, "amountCents": { "description": "The same amount in integer cents: amount times 100", "type": "integer" }, "currency": { "description": "ISO 4217 code", "type": "string" } } }, "filledStake": { "description": "Money amount", "type": "object", "required": [ "amount", "amountCents", "currency" ], "properties": { "amount": { "pattern": "^-?\\d+\\.\\d{2}$", "description": "Decimal string, two decimals", "type": "string" }, "amountCents": { "description": "The same amount in integer cents: amount times 100", "type": "integer" }, "currency": { "description": "ISO 4217 code", "type": "string" } } }, "remainingStake": { "description": "Money amount", "type": "object", "required": [ "amount", "amountCents", "currency" ], "properties": { "amount": { "pattern": "^-?\\d+\\.\\d{2}$", "description": "Decimal string, two decimals", "type": "string" }, "amountCents": { "description": "The same amount in integer cents: amount times 100", "type": "integer" }, "currency": { "description": "ISO 4217 code", "type": "string" } } }, "minPrice": { "description": "Decimal price floor", "type": "string" }, "averageFilledPrice": { "anyOf": [ { "description": "Stake-weighted price of the filled legs", "type": "string" }, { "type": "null" } ] }, "acceptBetterOdds": { "type": "boolean" }, "acceptPartialStake": { "type": "boolean" }, "expiresAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "createdAt": { "format": "date-time", "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" }, "version": { "description": "Goes up by one at every change of the order or one of its bets", "type": "integer" }, "remainder": { "type": "string", "enum": [ "cancelled", "alreadyTerminal", "none" ] }, "bets": { "type": "array", "items": { "type": "object", "required": [ "id", "orderId", "bookmaker", "status", "requestedStake", "filledStake", "filledPrice", "declineReason", "placedAt", "filledAt", "settlement", "cancellation" ], "properties": { "id": { "format": "uuid", "type": "string" }, "orderId": { "format": "uuid", "type": "string" }, "bookmaker": { "type": "string" }, "status": { "type": "string", "enum": [ "PENDING", "WAITING", "PARTIALLY_PLACED", "PLACED", "REJECTED", "CANCELLED", "SETTLED" ] }, "requestedStake": { "description": "Money amount", "type": "object", "required": [ "amount", "amountCents", "currency" ], "properties": { "amount": { "pattern": "^-?\\d+\\.\\d{2}$", "description": "Decimal string, two decimals", "type": "string" }, "amountCents": { "description": "The same amount in integer cents: amount times 100", "type": "integer" }, "currency": { "description": "ISO 4217 code", "type": "string" } } }, "filledStake": { "anyOf": [ { "description": "Money amount", "type": "object", "required": [ "amount", "amountCents", "currency" ], "properties": { "amount": { "pattern": "^-?\\d+\\.\\d{2}$", "description": "Decimal string, two decimals", "type": "string" }, "amountCents": { "description": "The same amount in integer cents: amount times 100", "type": "integer" }, "currency": { "description": "ISO 4217 code", "type": "string" } } }, { "type": "null" } ] }, "filledPrice": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "declineReason": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placedAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "filledAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "settlement": { "type": "object", "required": [ "status", "amount", "settledAt" ], "properties": { "status": { "type": "string", "enum": [ "UNSETTLED", "WON", "LOST", "VOID", "HALF_WON", "HALF_LOST", "PUSH", "CASHOUT" ] }, "amount": { "description": "Profit or loss of the account on this bet", "anyOf": [ { "description": "Money amount", "type": "object", "required": [ "amount", "amountCents", "currency" ], "properties": { "amount": { "pattern": "^-?\\d+\\.\\d{2}$", "description": "Decimal string, two decimals", "type": "string" }, "amountCents": { "description": "The same amount in integer cents: amount times 100", "type": "integer" }, "currency": { "description": "ISO 4217 code", "type": "string" } } }, { "type": "null" } ] }, "settledAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] } } }, "cancellation": { "type": "string", "enum": [ "cancelled", "alreadyTerminal", "notRecallable" ] } } } } } } }, "notFound": { "type": "array", "items": { "type": "string" } }, "busy": { "type": "array", "items": { "format": "uuid", "type": "string" } }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } } } } } }, "400": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "401": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "403": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "404": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "409": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "429": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "502": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "503": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } } } } }, "/v1/bets": { "get": { "summary": "List bets", "tags": [ "Bets" ], "description": "The account's bets, newest first, dashboard bets included. Every filter narrows the result.", "parameters": [ { "schema": { "type": "array", "items": { "type": "string", "enum": [ "PENDING", "WAITING", "PARTIALLY_PLACED", "PLACED", "REJECTED", "CANCELLED", "SETTLED" ] } }, "in": "query", "name": "status", "required": false, "description": "Repeat the parameter to ask for several values" }, { "schema": { "type": "array", "items": { "type": "string", "enum": [ "UNSETTLED", "WON", "LOST", "VOID", "HALF_WON", "HALF_LOST", "PUSH", "CASHOUT" ] } }, "in": "query", "name": "settlementStatus", "required": false, "description": "Repeat the parameter to ask for several values" }, { "schema": { "minLength": 1, "maxLength": 255, "type": "string" }, "in": "query", "name": "fixtureId", "required": false }, { "schema": { "type": "array", "items": { "minLength": 1, "maxLength": 64, "type": "string" } }, "in": "query", "name": "bookmaker", "required": false, "description": "Repeat the parameter to ask for several values" }, { "schema": { "format": "date-time", "type": "string" }, "in": "query", "name": "from", "required": false, "description": "createdAt at or after" }, { "schema": { "format": "date-time", "type": "string" }, "in": "query", "name": "to", "required": false, "description": "createdAt before" }, { "schema": { "format": "date-time", "type": "string" }, "in": "query", "name": "settledFrom", "required": false, "description": "settlement.settledAt at or after" }, { "schema": { "format": "date-time", "type": "string" }, "in": "query", "name": "settledTo", "required": false, "description": "settlement.settledAt before" }, { "schema": { "minLength": 1, "maxLength": 512, "type": "string" }, "in": "query", "name": "cursor", "required": false }, { "schema": { "minimum": 1, "maximum": 200, "default": 50, "type": "integer" }, "in": "query", "name": "limit", "required": false } ], "security": [ { "apiKey": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "bets", "nextCursor" ], "properties": { "bets": { "type": "array", "items": { "type": "object", "required": [ "id", "orderId", "bookmaker", "status", "requestedStake", "filledStake", "filledPrice", "declineReason", "placedAt", "filledAt", "settlement", "selection", "createdAt" ], "properties": { "id": { "format": "uuid", "type": "string" }, "orderId": { "description": "Null for a bet placed before orders were recorded", "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ] }, "bookmaker": { "type": "string" }, "status": { "type": "string", "enum": [ "PENDING", "WAITING", "PARTIALLY_PLACED", "PLACED", "REJECTED", "CANCELLED", "SETTLED" ] }, "requestedStake": { "description": "Money amount", "type": "object", "required": [ "amount", "amountCents", "currency" ], "properties": { "amount": { "pattern": "^-?\\d+\\.\\d{2}$", "description": "Decimal string, two decimals", "type": "string" }, "amountCents": { "description": "The same amount in integer cents: amount times 100", "type": "integer" }, "currency": { "description": "ISO 4217 code", "type": "string" } } }, "filledStake": { "anyOf": [ { "description": "Money amount", "type": "object", "required": [ "amount", "amountCents", "currency" ], "properties": { "amount": { "pattern": "^-?\\d+\\.\\d{2}$", "description": "Decimal string, two decimals", "type": "string" }, "amountCents": { "description": "The same amount in integer cents: amount times 100", "type": "integer" }, "currency": { "description": "ISO 4217 code", "type": "string" } } }, { "type": "null" } ] }, "filledPrice": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "declineReason": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placedAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "filledAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "settlement": { "type": "object", "required": [ "status", "amount", "settledAt" ], "properties": { "status": { "type": "string", "enum": [ "UNSETTLED", "WON", "LOST", "VOID", "HALF_WON", "HALF_LOST", "PUSH", "CASHOUT" ] }, "amount": { "description": "Profit or loss of the account on this bet", "anyOf": [ { "description": "Money amount", "type": "object", "required": [ "amount", "amountCents", "currency" ], "properties": { "amount": { "pattern": "^-?\\d+\\.\\d{2}$", "description": "Decimal string, two decimals", "type": "string" }, "amountCents": { "description": "The same amount in integer cents: amount times 100", "type": "integer" }, "currency": { "description": "ISO 4217 code", "type": "string" } } }, { "type": "null" } ] }, "settledAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] } } }, "selection": { "type": "object", "required": [ "fixtureId", "outcomeId", "playerId", "sportId", "tournamentId", "marketId" ], "properties": { "fixtureId": { "type": "string" }, "outcomeId": { "type": "integer" }, "playerId": { "type": "integer" }, "sportId": { "type": "integer" }, "tournamentId": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "marketId": { "type": "integer" } } }, "createdAt": { "format": "date-time", "type": "string" } } } }, "nextCursor": { "anyOf": [ { "description": "Pass it back as cursor for the next page; null on the last page", "type": "string" }, { "type": "null" } ] } } } } } }, "400": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "401": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "403": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "429": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "503": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } } } } }, "/v1/bets/{id}": { "get": { "summary": "Get a bet", "tags": [ "Bets" ], "description": "One of the account's bets. Bets placed from the dashboard are included.", "parameters": [ { "schema": { "format": "uuid", "type": "string" }, "in": "path", "name": "id", "required": true } ], "security": [ { "apiKey": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "orderId", "bookmaker", "status", "requestedStake", "filledStake", "filledPrice", "declineReason", "placedAt", "filledAt", "settlement", "selection", "createdAt" ], "properties": { "id": { "format": "uuid", "type": "string" }, "orderId": { "description": "Null for a bet placed before orders were recorded", "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ] }, "bookmaker": { "type": "string" }, "status": { "type": "string", "enum": [ "PENDING", "WAITING", "PARTIALLY_PLACED", "PLACED", "REJECTED", "CANCELLED", "SETTLED" ] }, "requestedStake": { "description": "Money amount", "type": "object", "required": [ "amount", "amountCents", "currency" ], "properties": { "amount": { "pattern": "^-?\\d+\\.\\d{2}$", "description": "Decimal string, two decimals", "type": "string" }, "amountCents": { "description": "The same amount in integer cents: amount times 100", "type": "integer" }, "currency": { "description": "ISO 4217 code", "type": "string" } } }, "filledStake": { "anyOf": [ { "description": "Money amount", "type": "object", "required": [ "amount", "amountCents", "currency" ], "properties": { "amount": { "pattern": "^-?\\d+\\.\\d{2}$", "description": "Decimal string, two decimals", "type": "string" }, "amountCents": { "description": "The same amount in integer cents: amount times 100", "type": "integer" }, "currency": { "description": "ISO 4217 code", "type": "string" } } }, { "type": "null" } ] }, "filledPrice": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "declineReason": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placedAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "filledAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "settlement": { "type": "object", "required": [ "status", "amount", "settledAt" ], "properties": { "status": { "type": "string", "enum": [ "UNSETTLED", "WON", "LOST", "VOID", "HALF_WON", "HALF_LOST", "PUSH", "CASHOUT" ] }, "amount": { "description": "Profit or loss of the account on this bet", "anyOf": [ { "description": "Money amount", "type": "object", "required": [ "amount", "amountCents", "currency" ], "properties": { "amount": { "pattern": "^-?\\d+\\.\\d{2}$", "description": "Decimal string, two decimals", "type": "string" }, "amountCents": { "description": "The same amount in integer cents: amount times 100", "type": "integer" }, "currency": { "description": "ISO 4217 code", "type": "string" } } }, { "type": "null" } ] }, "settledAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] } } }, "selection": { "type": "object", "required": [ "fixtureId", "outcomeId", "playerId", "sportId", "tournamentId", "marketId" ], "properties": { "fixtureId": { "type": "string" }, "outcomeId": { "type": "integer" }, "playerId": { "type": "integer" }, "sportId": { "type": "integer" }, "tournamentId": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "marketId": { "type": "integer" } } }, "createdAt": { "format": "date-time", "type": "string" } } } } } }, "400": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "401": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "403": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "404": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "429": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "503": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } } } } }, "/v1/pnl": { "get": { "summary": "Get the realised PnL", "tags": [ "Positions and PnL" ], "description": "Settled bets over a window on their settlement time, [from, to). Without `to`, the window ends now; without `from`, it starts 30 days before `to`. At most 366 days.", "parameters": [ { "schema": { "format": "date-time", "type": "string" }, "in": "query", "name": "from", "required": false }, { "schema": { "format": "date-time", "type": "string" }, "in": "query", "name": "to", "required": false }, { "schema": { "default": "day", "type": "string", "enum": [ "day", "bookmaker", "sport", "tournament" ] }, "in": "query", "name": "groupBy", "required": false } ], "security": [ { "apiKey": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "groupBy", "from", "to", "rows", "totals" ], "properties": { "groupBy": { "type": "string", "enum": [ "day", "bookmaker", "sport", "tournament" ] }, "from": { "format": "date-time", "type": "string" }, "to": { "format": "date-time", "type": "string" }, "rows": { "type": "array", "items": { "type": "object", "required": [ "key", "settledBets", "wins", "losses", "voids", "pushes", "staked", "betPnl", "commission", "rebate", "netPnl" ], "properties": { "key": { "description": "UTC date (YYYY-MM-DD), bookmaker slug, sport id or tournament id; null for bets without a tournament", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "settledBets": { "type": "integer" }, "wins": { "description": "WON and HALF_WON", "type": "integer" }, "losses": { "description": "LOST and HALF_LOST", "type": "integer" }, "voids": { "type": "integer" }, "pushes": { "type": "integer" }, "staked": { "description": "Matched stake of the settled bets", "type": "object", "required": [ "amount", "amountCents", "currency" ], "properties": { "amount": { "pattern": "^-?\\d+\\.\\d{2}$", "description": "Decimal string, two decimals", "type": "string" }, "amountCents": { "description": "The same amount in integer cents: amount times 100", "type": "integer" }, "currency": { "description": "ISO 4217 code", "type": "string" } } }, "betPnl": { "description": "The account's result on the bets that won or lost", "type": "object", "required": [ "amount", "amountCents", "currency" ], "properties": { "amount": { "pattern": "^-?\\d+\\.\\d{2}$", "description": "Decimal string, two decimals", "type": "string" }, "amountCents": { "description": "The same amount in integer cents: amount times 100", "type": "integer" }, "currency": { "description": "ISO 4217 code", "type": "string" } } }, "commission": { "description": "Money amount", "type": "object", "required": [ "amount", "amountCents", "currency" ], "properties": { "amount": { "pattern": "^-?\\d+\\.\\d{2}$", "description": "Decimal string, two decimals", "type": "string" }, "amountCents": { "description": "The same amount in integer cents: amount times 100", "type": "integer" }, "currency": { "description": "ISO 4217 code", "type": "string" } } }, "rebate": { "description": "Money amount", "type": "object", "required": [ "amount", "amountCents", "currency" ], "properties": { "amount": { "pattern": "^-?\\d+\\.\\d{2}$", "description": "Decimal string, two decimals", "type": "string" }, "amountCents": { "description": "The same amount in integer cents: amount times 100", "type": "integer" }, "currency": { "description": "ISO 4217 code", "type": "string" } } }, "netPnl": { "description": "betPnl - commission + rebate", "type": "object", "required": [ "amount", "amountCents", "currency" ], "properties": { "amount": { "pattern": "^-?\\d+\\.\\d{2}$", "description": "Decimal string, two decimals", "type": "string" }, "amountCents": { "description": "The same amount in integer cents: amount times 100", "type": "integer" }, "currency": { "description": "ISO 4217 code", "type": "string" } } } } } }, "totals": { "description": "Equal to the dashboard's PnL over the same window", "type": "object", "required": [ "settledBets", "wins", "losses", "voids", "pushes", "staked", "betPnl", "commission", "rebate", "netPnl" ], "properties": { "settledBets": { "type": "integer" }, "wins": { "description": "WON and HALF_WON", "type": "integer" }, "losses": { "description": "LOST and HALF_LOST", "type": "integer" }, "voids": { "type": "integer" }, "pushes": { "type": "integer" }, "staked": { "description": "Matched stake of the settled bets", "type": "object", "required": [ "amount", "amountCents", "currency" ], "properties": { "amount": { "pattern": "^-?\\d+\\.\\d{2}$", "description": "Decimal string, two decimals", "type": "string" }, "amountCents": { "description": "The same amount in integer cents: amount times 100", "type": "integer" }, "currency": { "description": "ISO 4217 code", "type": "string" } } }, "betPnl": { "description": "The account's result on the bets that won or lost", "type": "object", "required": [ "amount", "amountCents", "currency" ], "properties": { "amount": { "pattern": "^-?\\d+\\.\\d{2}$", "description": "Decimal string, two decimals", "type": "string" }, "amountCents": { "description": "The same amount in integer cents: amount times 100", "type": "integer" }, "currency": { "description": "ISO 4217 code", "type": "string" } } }, "commission": { "description": "Money amount", "type": "object", "required": [ "amount", "amountCents", "currency" ], "properties": { "amount": { "pattern": "^-?\\d+\\.\\d{2}$", "description": "Decimal string, two decimals", "type": "string" }, "amountCents": { "description": "The same amount in integer cents: amount times 100", "type": "integer" }, "currency": { "description": "ISO 4217 code", "type": "string" } } }, "rebate": { "description": "Money amount", "type": "object", "required": [ "amount", "amountCents", "currency" ], "properties": { "amount": { "pattern": "^-?\\d+\\.\\d{2}$", "description": "Decimal string, two decimals", "type": "string" }, "amountCents": { "description": "The same amount in integer cents: amount times 100", "type": "integer" }, "currency": { "description": "ISO 4217 code", "type": "string" } } }, "netPnl": { "description": "betPnl - commission + rebate", "type": "object", "required": [ "amount", "amountCents", "currency" ], "properties": { "amount": { "pattern": "^-?\\d+\\.\\d{2}$", "description": "Decimal string, two decimals", "type": "string" }, "amountCents": { "description": "The same amount in integer cents: amount times 100", "type": "integer" }, "currency": { "description": "ISO 4217 code", "type": "string" } } } } } } } } } }, "400": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "401": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "403": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "429": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "503": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } } } } }, "/v1/positions": { "get": { "summary": "Get open positions", "tags": [ "Positions and PnL" ], "description": "The account's open bets, grouped by selection (`outcome`), by `fixture` or by `bookmaker`, largest first. Only the fields of the grouping are set on each position.", "parameters": [ { "schema": { "default": "outcome", "type": "string", "enum": [ "outcome", "fixture", "bookmaker" ] }, "in": "query", "name": "groupBy", "required": false }, { "schema": { "minLength": 1, "maxLength": 255, "type": "string" }, "in": "query", "name": "fixtureId", "required": false }, { "schema": { "type": "array", "items": { "minLength": 1, "maxLength": 64, "type": "string" } }, "in": "query", "name": "bookmaker", "required": false, "description": "Repeat the parameter to ask for several values" } ], "security": [ { "apiKey": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "groupBy", "positions", "totals" ], "properties": { "groupBy": { "type": "string", "enum": [ "outcome", "fixture", "bookmaker" ] }, "positions": { "type": "array", "items": { "type": "object", "required": [ "fixtureId", "marketId", "outcomeId", "playerId", "bookmaker", "openBets", "matchedStake", "pendingStake", "unplacedStake", "averagePrice", "potentialReturn" ], "properties": { "fixtureId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "marketId": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "outcomeId": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "playerId": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "bookmaker": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "openBets": { "description": "Bets not settled yet that hold stake", "type": "integer" }, "matchedStake": { "description": "Stake of the bets accepted by the bookmaker", "type": "object", "required": [ "amount", "amountCents", "currency" ], "properties": { "amount": { "pattern": "^-?\\d+\\.\\d{2}$", "description": "Decimal string, two decimals", "type": "string" }, "amountCents": { "description": "The same amount in integer cents: amount times 100", "type": "integer" }, "currency": { "description": "ISO 4217 code", "type": "string" } } }, "pendingStake": { "description": "Stake of the bets still PENDING or WAITING", "type": "object", "required": [ "amount", "amountCents", "currency" ], "properties": { "amount": { "pattern": "^-?\\d+\\.\\d{2}$", "description": "Decimal string, two decimals", "type": "string" }, "amountCents": { "description": "The same amount in integer cents: amount times 100", "type": "integer" }, "currency": { "description": "ISO 4217 code", "type": "string" } } }, "unplacedStake": { "description": "Remainder of orders with an expiry, not placed yet. It is not held against the balance and belongs to no bookmaker, so it appears only in the totals when grouping by bookmaker, and not at all with a bookmaker filter.", "type": "object", "required": [ "amount", "amountCents", "currency" ], "properties": { "amount": { "pattern": "^-?\\d+\\.\\d{2}$", "description": "Decimal string, two decimals", "type": "string" }, "amountCents": { "description": "The same amount in integer cents: amount times 100", "type": "integer" }, "currency": { "description": "ISO 4217 code", "type": "string" } } }, "averagePrice": { "description": "Stake-weighted price of the matched bets; outcome grouping only", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "potentialReturn": { "description": "Matched stake plus the net profit if the selection wins, as the dashboard shows it; outcome grouping only", "anyOf": [ { "description": "Money amount", "type": "object", "required": [ "amount", "amountCents", "currency" ], "properties": { "amount": { "pattern": "^-?\\d+\\.\\d{2}$", "description": "Decimal string, two decimals", "type": "string" }, "amountCents": { "description": "The same amount in integer cents: amount times 100", "type": "integer" }, "currency": { "description": "ISO 4217 code", "type": "string" } } }, { "type": "null" } ] } } } }, "totals": { "description": "For agent accounts matchedStake + pendingStake equals exposure in GET /v1/balance when no filter is set. Retail exposure is the full betting liability (lay risk, unmatched commitments, commission) and can be higher.", "type": "object", "required": [ "openBets", "matchedStake", "pendingStake", "unplacedStake" ], "properties": { "openBets": { "description": "Bets not settled yet that hold stake", "type": "integer" }, "matchedStake": { "description": "Stake of the bets accepted by the bookmaker", "type": "object", "required": [ "amount", "amountCents", "currency" ], "properties": { "amount": { "pattern": "^-?\\d+\\.\\d{2}$", "description": "Decimal string, two decimals", "type": "string" }, "amountCents": { "description": "The same amount in integer cents: amount times 100", "type": "integer" }, "currency": { "description": "ISO 4217 code", "type": "string" } } }, "pendingStake": { "description": "Stake of the bets still PENDING or WAITING", "type": "object", "required": [ "amount", "amountCents", "currency" ], "properties": { "amount": { "pattern": "^-?\\d+\\.\\d{2}$", "description": "Decimal string, two decimals", "type": "string" }, "amountCents": { "description": "The same amount in integer cents: amount times 100", "type": "integer" }, "currency": { "description": "ISO 4217 code", "type": "string" } } }, "unplacedStake": { "description": "Remainder of orders with an expiry, not placed yet. It is not held against the balance and belongs to no bookmaker, so it appears only in the totals when grouping by bookmaker, and not at all with a bookmaker filter.", "type": "object", "required": [ "amount", "amountCents", "currency" ], "properties": { "amount": { "pattern": "^-?\\d+\\.\\d{2}$", "description": "Decimal string, two decimals", "type": "string" }, "amountCents": { "description": "The same amount in integer cents: amount times 100", "type": "integer" }, "currency": { "description": "ISO 4217 code", "type": "string" } } } } } } } } } }, "400": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "401": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "403": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "429": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } }, "503": { "description": "Error. `code` is stable; `message` is for humans and may change.", "content": { "application/json": { "schema": { "description": "Error. `code` is stable; `message` is for humans and may change.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "VALIDATION_FAILED", "MODE_REQUIRED", "INVALID_STAKE", "INVALID_PRICE", "INVALID_EXPIRY", "CURRENCY_NOT_SUPPORTED", "BOOKMAKER_NOT_AVAILABLE_VIA_API", "BOOKMAKER_NOT_AVAILABLE", "INVALID_API_KEY", "API_ACCESS_DENIED", "ACCOUNT_NOT_ACTIVE", "BETTING_NOT_ALLOWED", "BALANCE_UNAVAILABLE", "INSUFFICIENT_FUNDS", "MAX_STAKE_PER_FIXTURE_EXCEEDED", "PRICE_NOT_AVAILABLE", "PRICE_CHANGED", "NO_LIQUIDITY", "INSUFFICIENT_LIQUIDITY", "CLIENT_ORDER_ID_REUSED", "PREVIOUS_ATTEMPT_UNRESOLVED", "NOT_FOUND", "INVALID_CURSOR", "INVALID_WINDOW", "ORDER_BUSY", "CONFLICT", "FORBIDDEN", "RATE_LIMITED", "BETTING_SUSPENDED", "EXPIRY_NOT_AVAILABLE", "PUBLIC_API_DISABLED", "SERVICE_UNAVAILABLE", "UPSTREAM_UNAVAILABLE", "FEED_UNAVAILABLE", "FEED_TIMEOUT", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} } } } } } } } } }, "servers": [ { "url": "https://api.apexiumbet.com", "description": "Production" } ], "security": [ { "apiKey": [] } ] } ```