Get match by ID
Retrieve detailed information for one match. The response is an array holding that match.
- Detail
- Everything on the list route, plus four blocks
The match id comes from
matches.
This route returns everything the list route does, and adds venue,
referee, forecast and predictions.
Venue, referee and forecast
venue names the city, the arena name, the
country and its capacity. referee carries a
name and a nationality. forecast carries a
status such as cloudy and a temperature already
formatted with its unit, as in 11.97°C.
Predictions
predictions splits into prematch and live, and
each is a list rather than a single entry.
Every prediction carries its type, the modelType that produced
it, a generatedAt timestamp, a readable description and the
probabilities behind it. probabilities holds
home and away as percentage strings, plus
draw where the model has one.
Parameters
| Parameter | Type | Description |
|---|---|---|
idrequired
|
numberpath | Requested match id. |
Request
curl --request GET \
--url 'https://hockey.highlightly.net/matches/{id}' \
--header 'x-rapidapi-key: YOUR_API_KEY'
const response = await fetch('https://hockey.highlightly.net/matches/{id}', {
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://hockey.highlightly.net/matches/{id}',
headers={
'x-rapidapi-key': os.environ['HIGHLIGHTLY_API_KEY'],
},
timeout=10,
)
response.raise_for_status()
data = response.json()
Response
idnumberrequired
weekstring
datestringrequired
countryHockeyCountryResponserequired3 fields
codestringrequiredCountry code specified by the ISO 3166 standard.
namestringrequired
logostringrequired
awayTeamHockeyTeamResponserequired3 fields
idnumberrequired
logostring
namestringrequired
homeTeamHockeyTeamResponserequired3 fields
idnumberrequired
logostring
namestringrequired
leagueHockeyMatchLeagueResponserequired4 fields
idnumberrequired
seasonnumberrequired
namestringrequired
logostring
stateHockeyMatchStateResponserequired8 fields
descriptionstringrequiredCurrent state of the game.Not started1st period2nd period3rd periodOver timePenaltiesBreak timeAwardedPostponedCancelledInterruptedAbandonedFinishedTo be announcedFinished after penaltiesFinished after over timeUnknown
scoreHockeyMatchScoreResponserequired6 fields
currentstringHome - Away score for the match.
overTimestringHome - Away score in overtime.
penaltiesstringHome - Away score in penalties.
firstPeriodstringHome - Away score in 1st period.
secondPeriodstringHome - Away score in 2nd period.
thirdPeriodstringHome - Away score in 3rd period.
venueDetailedMatchVenueResponse4 fields
citystring
namestring
countrystring
capacitystring
refereeDetailedMatchRefereeResponse2 fields
namestring
nationalitystring
forecastDetailedMatchForecastResponse2 fields
statusstring
temperaturestring
predictionsPredictionResponse18 fields
prematchPrediction[]required8 fields
typestringrequired
modelTypestringrequired
generatedAtstringrequired
descriptionstringrequired
probabilitiesPredictionProbabilitiesrequired3 fields
homestringrequired
drawstring
awaystringrequired
livePrediction[]required8 fields
typestringrequired
modelTypestringrequired
generatedAtstringrequired
descriptionstringrequired
probabilitiesPredictionProbabilitiesrequired3 fields
homestringrequired
drawstring
awaystringrequired
Example response
[
{
"id": 308606573,
"week": "Quarter-finals",
"date": "2024-03-30T15:00:00.000Z",
"country": {
"code": "DE",
"name": "Germany",
"logo": "https://example.com/logos/country/DE.png"
},
"awayTeam": {
"id": 223746,
"logo": "https://example.com/logos/team/223746.png",
"name": "Frankfurt Lowen"
},
"homeTeam": {
"id": 223746,
"logo": "https://example.com/logos/team/223746.png",
"name": "Frankfurt Lowen"
},
"league": {
"id": 16953,
"season": 2023,
"name": "DEL",
"logo": "https://example.com/logos/league/16953.png"
},
"state": {
"description": "1st period",
"score": {
"current": "4 - 4",
"overTime": "6 - 4",
"penalties": "17 - 33",
"firstPeriod": "2 - 0",
"secondPeriod": "2 - 1",
"thirdPeriod": "5 - 2"
}
},
"venue": {
"city": "Swansea",
"name": "Liberty Stadium",
"country": "Wales",
"capacity": "20827"
},
"referee": {
"name": "Brace, Andrew",
"nationality": "Ireland"
},
"forecast": {
"status": "cloudy",
"temperature": "11.97°C"
},
"predictions": {
"prematch": [
{
"type": "prematch",
"modelType": "three-way",
"generatedAt": "2025-03-12T19:00:20.000Z",
"description": "Team A is most likely to win the game against Team B.`",
"probabilities": {
"home": "30.22%",
"draw": "0.00%",
"away": "69.78%"
}
}
],
"live": [
{
"type": "prematch",
"modelType": "three-way",
"generatedAt": "2025-03-12T19:00:20.000Z",
"description": "Team A is most likely to win the game against Team B.`",
"probabilities": {
"home": "30.22%",
"draw": "0.00%",
"away": "69.78%"
}
}
]
}
}
]
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. |