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, 5 per page
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
fixture. Alternatively use date with timezone to fetch all
odds for a given day. League and bookmaker filters narrow it further, and bookmaker ids
come from bookmakers.
Supported markets
| Market | Outcomes |
|---|---|
| Full Time Result | Home, Draw or Away. |
| Home/Away |
Home or Away, where there is no way for the game to end
in a draw.
|
| Over/Under |
Complex. Variants such as "Over/Under 62.5" or "Over/Under
57.5" points. Each resolves to Over or Under.
|
| Asian Handicap |
Complex. Variants such as "Asian Handicap -0.5/+0.5" or "Asian
Handicap -4.5/+4.5". Each resolves to Home or Away.
|
| Odd or Even | Whether the score of both teams is Odd or Even. |
A complex market is split into multiple variants, such as "Over/Under 62.5" and "Over/Under 57.5", so do not assume one row per market.
How odds are grouped
Results are grouped by matchId. Each match then holds an
odds list of priced markets. Every entry carries the
bookmakerId, a type saying whether it is prematch or live, the
market name and its values, and may also carry the
bookmakerName.
A selection is a value label and an odd price, so the Full
Time Result market arrives as three of them, Home, Draw and
Away.
Parameters
| Parameter | Type | Description |
|---|---|---|
oddsTypeoptional |
string |
Defines whether live or prematch odds will be returned.e.g. prematch
|
leagueIdoptional |
number | No description in the spec. |
leagueNameoptional
|
string | No description in the spec. |
timezoneoptional |
stringdefault Etc/UTC
|
Valid timezone identifier.e.g. Europe/London
|
bookmakerIdoptional
|
number |
No description in the spec.e.g. 3
|
limitoptional |
numberdefault 5
|
No description in the spec.e.g. 5
|
offsetoptional |
numberdefault 0
|
No description in the spec.e.g. 0
|
matchIdoptional |
number | No description in the spec. |
bookmakerNameoptional
|
string |
No description in the spec.e.g. 22Bet
|
dateoptional |
string | Date that follows the YYYY-MM-DD format. |
Request
curl --request GET \
--url 'https://handball.highlightly.net/odds?oddsType=prematch&bookmakerId=3' \
--header 'x-rapidapi-key: YOUR_API_KEY'
const params = new URLSearchParams({
oddsType: 'prematch',
bookmakerId: '3'
})
const response = await fetch(`https://handball.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://handball.highlightly.net/odds',
params={
'oddsType': 'prematch',
'bookmakerId': '3',
},
headers={
'x-rapidapi-key': os.environ['HIGHLIGHTLY_API_KEY'],
},
timeout=10,
)
response.raise_for_status()
data = response.json()
Response
dataHandballOddsResponse[]required9 fields
matchIdnumberrequired
oddsHandballMarketResponse[]required7 fields
bookmakerIdnumberrequired
bookmakerNamestring
typestringrequired
marketstringrequired
valuesHandballMarketSelectionResponse[]required2 fields
oddnumberrequired
valuestringrequired
paginationPaginationResponserequired3 fields
totalCountnumberrequiredAvailable number of items, relevant to the provided query.
offsetnumberrequired
limitnumberrequired
planPlanResponserequired2 fields
tierstringrequiredYour current API subscription tier.
messagestringrequiredExplanation message regarding your current tier.
Example response
{
"data": [
{
"matchId": 123121762,
"odds": [
{
"bookmakerId": 3,
"bookmakerName": "22Bet",
"type": "prematch",
"market": "Full Time Result",
"values": [
{
"odd": 1.7,
"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
| Status | Description |
|---|---|
400 |
Bad request descriptive error. |
500 |
Internal server error. |