NHL & NCAAH API / matches

Get match by ID

GET https://nhl.highlightly.net/matches/{id} NHL & NCAAH API
GET https://sports.highlightly.net/nhl/matches/{id} All Sports API

Retrieve detailed information for one match.

This is the detail view. Matches returns general information for a list of games, and this route fills in everything that route leaves out.

Parameters

Parameter Type Description
idrequired numberpath Requested match id.

Request

curl --request GET \
  --url 'https://nhl.highlightly.net/matches/{id}' \
  --header 'x-rapidapi-key: YOUR_API_KEY'
const response = await fetch('https://nhl.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://nhl.highlightly.net/matches/{id}',
    headers={
        'x-rapidapi-key': os.environ['HIGHLIGHTLY_API_KEY'],
    },
    timeout=10,
)

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

Response

idnumberrequired
roundstringrequired
datestringrequired
leaguestringrequired
seasonnumberrequired
awayTeamNhlMatchTeamResponserequired5 fields
idnumberrequired
logostring
namestring
displayNamestringrequired
abbreviationstringrequired
homeTeamNhlMatchTeamResponserequired5 fields
idnumberrequired
logostring
namestring
displayNamestringrequired
abbreviationstringrequired
stateNhlMatchStateResponserequired10 fields
periodnumberCurrent in play period.
clocknumberCurrent minute of the in play period.
descriptionstringrequiredCurrent status/description of the match.SuspendedPostponedCancelledAbandonedFinishedIn progressEnd periodHalf timeUnknownScheduled
scoreNhlMatchScoreResponserequired5 fields
currentstringHome - Away score for the match.
firstPeriodstringHome - Away score in 1st period.
secondPeriodstringHome - Away score in 2nd period.
thirdPeriodstringHome - Away score in 3rd period.
overtimePeriodstringHome - Away score in the overtime period.
reportstringAdditional description of the match state.
venueNhlMatchVenueResponse3 fields
citystringrequired
namestringrequired
statestringrequired
refereesNhlDetailedMatchReferees[]2 fields
namestringrequired
positionstringrequired
forecastDetailedMatchForecastResponse2 fields
statusstring
temperaturestring
overallStatisticsNhlOverallStatsResponse[]10 fields
dataNhlOverallStatsItemResponse[]required2 fields
valuestringrequired
displayNamestringrequired
teamNhlTeamResponserequired6 fields
idnumberrequired
logostring
namestring
displayNamestringrequired
abbreviationstringrequired
leaguestringrequired
eventsNhlDetailedMatchEvent[]11 fields
typestringrequired
clockstringrequired
periodnumberrequired
isScoringPlaybooleanrequired
teamNhlTeamResponse6 fields
idnumberrequired
logostring
namestring
displayNamestringrequired
abbreviationstringrequired
leaguestringrequired
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

200 application/json 
[
  {
    "id": 1,
    "round": "Regular Season - 14",
    "date": "2023-05-20T15:30:00.000Z",
    "league": "NHL",
    "season": 2023,
    "awayTeam": {
      "id": 1,
      "logo": "https://example.com/logos/team/1.png",
      "name": "Panthers",
      "displayName": "Florida Panthers",
      "abbreviation": "FLA"
    },
    "homeTeam": {
      "id": 1,
      "logo": "https://example.com/logos/team/1.png",
      "name": "Panthers",
      "displayName": "Florida Panthers",
      "abbreviation": "FLA"
    },
    "state": {
      "period": 2,
      "clock": 8,
      "description": "In progress",
      "score": {
        "current": "1 - 1",
        "firstPeriod": "0 - 0",
        "secondPeriod": "1 - 1",
        "thirdPeriod": "2 - 2",
        "overtimePeriod": "1 - 0"
      },
      "report": "Final"
    },
    "venue": {
      "city": "Sudbury",
      "name": "Sudbury Community Arena",
      "state": "ON"
    },
    "referees": [
      {
        "name": "Jonathan  Parra",
        "position": "Home Plate Umpire"
      }
    ],
    "forecast": {
      "status": "cloudy",
      "temperature": "11.97°C"
    },
    "overallStatistics": [
      {
        "data": [
          {
            "value": "10",
            "displayName": "Blocked Shots"
          }
        ],
        "team": {
          "id": 1,
          "logo": "https://example.com/logos/team/1.png",
          "name": "Stars",
          "displayName": "Dallas Stars",
          "abbreviation": "DAL",
          "league": "NHL"
        }
      }
    ],
    "events": [
      {
        "type": "Shot",
        "clock": "0:32",
        "period": 1,
        "isScoringPlay": false,
        "team": {
          "id": 1,
          "logo": "https://example.com/logos/team/1.png",
          "name": "Stars",
          "displayName": "Dallas Stars",
          "abbreviation": "DAL",
          "league": "NHL"
        }
      }
    ],
    "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.