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 different rates. Prematch odds refresh multiple times a day, and live odds once every 10 minutes.

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 popular approach is matchId. Alternatively use date with timezone to fetch all match odds for a given day. leagueName, bookmakerId and bookmakerName narrow it further, and bookmaker ids come from bookmakers.

Supported markets

How odds are grouped

Each entry in data carries a matchId and an odds list. Every item in that list has a bookmakerId, a type of prematch or live, the market and its values, and may also carry a bookmakerName.

Each value is a value label and an odd price, so a Moneyline market arrives as two of them, Home and Away.

Each market entry names its bookmaker, which is what lets you compare prices. If you only display one bookmaker, filter by bookmakerId or bookmakerName when you request.

Parameters

Request

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

const params = new URLSearchParams({
  oddsType: 'prematch',
  leagueName: 'NFL'
})
const response = await fetch(`https://american-football.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://american-football.highlightly.net/odds',
    params={
        'oddsType': 'prematch',
        'leagueName': 'NFL',
    },
    headers={
        'x-rapidapi-key': os.environ['HIGHLIGHTLY_API_KEY'],
    },
    timeout=10,
)

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

Response

Example response

{
  "data": [
    {
      "matchId": 394,
      "odds": [
        {
          "bookmakerId": 53,
          "bookmakerName": "Megapari Sport",
          "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