Odds

One event from the raw board

One raw event by id, every venue (a plan with a bookmaker list sees those venues and the region's exchanges; an account scope sees its raw venue list and markets only, no exchange added). Checks: the key and scope as raw, the parameters and their values, the raw board (503 raw_not_enabled), the id (404 unknown_event), the event's sport in your account's raw scope (403 sport_not_in_plan), quote=true, the price (402). The price is the whole event's, whatever the scope cuts. Priced by the event's share of the region's raw prices. Gzip unless refused (over 1 kB).

get/v2/odds/event/{id}

Request

  • Base URL: https://api.oddsrelay.io
  • URL: https://api.oddsrelay.io/v2/odds/event/{id}
  • Auth: one of:
    • HTTP bearer
    • API key in header x-api-key

Path parameters

idstring required

An event id (or_evt_…) from raw, a matched board or /v2/events. Not on the raw board now is 404 unknown_event.

Query parameters

regionstring

ONE lowercase region code (/v2/regions lists yours). Missing means uk: on a data route only when your key covers uk, else 400 region_required naming a code your key has; on discovery and keyless routes always. A comma list, the parameter sent twice or an uppercase code is 400 bad_request; an unknown code, or one with no live bookmaker here, is 404 unknown_region.

oddsFormat'decimal' | 'american'

decimal (default) or american (a signed integer; null for a price at or below 1.0). standard and dutching serve decimal only: anything else is 400.

dateFormat'iso' | 'unix'

iso (default, ISO-8601 UTC) or unix (integer epoch seconds) for commence_time, processed_at and last_update. standard and dutching serve iso only: anything else is 400.

includeLinks'true' | 'false'

true: each venue's link (its primary event page; left out when it has none). Default false. true or false, else 400.

includeLiquidity'true' | 'false'

false: leave out available beside an exchange's lay_price. Default true. true or false, else 400.

quotestring

true (also 1, yes, on): price this exact request instead of serving it. 200 {cost, remaining, rate_card}, free, every check before the price still applies; any other value is an ordinary request.

Response

The event, or under quote=true its price.

OR

Changes

No recorded changes to this operation across all 1 revision of this API.