NHL & NCAAH API / highlights

Get highlight by ID

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

Retrieve one highlight by its id.

Use this to check whether a highlight you have already stored still exists, or whether its information has been updated since you fetched it. Clips are hosted on third party platforms and can be removed or edited after aggregation, so a highlight you cached last week may no longer resolve.

Parameters

Parameter Type Description
idrequired numberpath Requested highlight id.

Request

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

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

Response

idnumberrequired
typestringrequired
imgUrlstringPreview picture of the highlight.
titlestringrequired
descriptionstring
urlstringrequiredUrl location of the video highlight.
embedUrlstringUrl of embeddable video highlight.
matchNhlMatchResponserequired28 fields
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.
channelstringChannel title of a given highlight.
sourcestringAggregation source from social media and other equivalent platforms.
categorystringAssumed highlight category

Example response

200 application/json 
[
  {
    "id": 1,
    "type": "VERIFIED",
    "imgUrl": "https://example.com/images/preview/1.png",
    "title": "NFL: New Orleans Saints vs Kansas City Chiefs",
    "description": "Game recap of the match.",
    "url": "https://example.com/highlight/v23r23fds2cff",
    "embedUrl": "https://example.com/embed/v23r23fds2cff",
    "match": {
      "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"
      }
    },
    "channel": "NHL",
    "source": "youtube",
    "category": "match-highlights"
  }
]

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.