Highlights

Highlights are the core of the NHL & NCAAH API. They cover everything from a single goal through to full game recaps, press conferences and post game interviews.

Refresh interval

Once a minute

Plan

Might have restrictions on Basic/Free

Pagination

limit and offset

Verified and unverified clips

Clips are aggregated from many different platforms. Depending on the source and what verification it has been through, each one falls into one of two types.

Reading a highlight

Every highlight carries a title describing what the video shows. Many also carry a description that expands on it.

The source field records where the clip was aggregated from, for example youtube, twitter, reddit or espn. For some sources a channel is present as well, which is the uploading channel's title. Together these let you narrow down which videos you want to show. Where embedUrl is present you can embed the video directly in your own site or app.

Categories

The category field describes what kind of content the clip contains. Categorisation happens automatically when a highlight is aggregated. A clip that cannot be placed confidently is labelled other rather than being forced into a category it does not belong to, so filtering on category in your own code will not return unrelated content. /highlights has no category query parameter.

Plan coverage

On the Basic plan, NHL highlights are excluded. A Pro plan or higher removes the restriction and returns highlights from every league this API covers.

Querying

At least one primary query parameter must be specified before you can retrieve data. timezone, limit and offset are secondary and do not count on their own.

Combine timezone with date to get highlights relevant to your own location rather than UTC. leagueName filters by league, for example NHL or NCAA. Teams can be filtered by id, name, abbreviation or display name, so homeTeamAbbreviation works without resolving an id first.

limit sets how many highlights come back. When the number of matching highlights exceeds it, request the next page by increasing offset. The pagination object in every response tells you the totalCount to page through.

Parameters

Request

curl --request GET \
  --url 'https://nhl.highlightly.net/highlights?leagueName=NCAA&date=2024-02-10' \
  --header 'x-rapidapi-key: YOUR_API_KEY'

const params = new URLSearchParams({
  leagueName: 'NCAA',
  date: '2024-02-10'
})
const response = await fetch(`https://nhl.highlightly.net/highlights?${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://nhl.highlightly.net/highlights',
    params={
        'leagueName': 'NCAA',
        'date': '2024-02-10',
    },
    headers={
        'x-rapidapi-key': os.environ['HIGHLIGHTLY_API_KEY'],
    },
    timeout=10,
)

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

Response

Example response

{
  "data": [
    {
      "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"
    }
  ],
  "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