Odds

Retrieve match odds.

Prematch refresh

Multiple times a day

Live refresh

Once every 10 minutes

Plan

Not available on Basic/Free

Pagination

limit and offset

Prematch or live

oddsType selects between prematch and live odds. Omit it and you get prematch.

The two refresh at very different rates. Prematch odds update multiple times a day, live odds every ten minutes, so polling live odds faster than that spends quota without returning anything new.

Querying

At least one primary query parameter must be specified. timezone, limit, offset and oddsType are secondary and do not count on their own.

The most common approach is matchId, which returns every market for one game. Alternatively use date with timezone to fetch all odds for a given day. League and bookmaker filters, leagueName, bookmakerId and bookmakerName, narrow it further. Bookmaker ids come from bookmakers.

Supported markets

A complex market is split into multiple variants, such as "Total Goals 8" and "Total Goals 8.5", so do not assume one entry per market.

How odds are grouped

Results are grouped by match. Each match then holds a list of priced markets, and every entry names the bookmaker, says whether it is prematch or live, names the market, and carries its selections.

A selection is a label and a price, so a Moneyline market arrives as two of them, Home and Away.

The same market appears once per bookmaker, which is what lets you compare prices. If you only display one bookmaker, filter by its id when you request rather than after, since the unfiltered response multiplies every market by the number of bookmakers covering that game.

Parameters

Request

curl --request GET \
  --url 'https://nhl.highlightly.net/odds?oddsType=prematch&leagueName=NHL' \
  --header 'x-rapidapi-key: YOUR_API_KEY'

const params = new URLSearchParams({
  oddsType: 'prematch',
  leagueName: 'NHL'
})
const response = await fetch(`https://nhl.highlightly.net/odds?${params}`, {
  headers: {
    'x-rapidapi-key': process.env.HIGHLIGHTLY_API_KEY
  }
})

if (!response.ok) {
  throw new Error(`Highlightly responded ${response.status}`)
}

const data = await response.json()

import os
import requests

response = requests.get(
    'https://nhl.highlightly.net/odds',
    params={
        'oddsType': 'prematch',
        'leagueName': 'NHL',
    },
    headers={
        'x-rapidapi-key': os.environ['HIGHLIGHTLY_API_KEY'],
    },
    timeout=10,
)

response.raise_for_status()
data = response.json()

Response

Example response

{
  "data": [
    {
      "matchId": 1,
      "odds": [
        {
          "bookmakerId": 1,
          "bookmakerName": "Stake.com",
          "type": "prematch",
          "market": "Odd or Even",
          "values": [
            {
              "odd": 2.8,
              "value": "Home"
            }
          ]
        }
      ]
    }
  ],
  "pagination": {
    "totalCount": 490,
    "offset": 20,
    "limit": 100
  },
  "plan": {
    "tier": "BASIC",
    "message": "Some results might be hidden with FREE tier. Check your API coverage for more information: https://rapidapi.com/highlightly-api-highlightly-api-default/api/sport-highlights-api/details"
  }
}

Values are the examples declared in the OpenAPI spec, not a captured live response.

Errors