Matches

Retrieve a list of matches.

Refresh interval

Once a minute

Pagination

limit and offset

Detail

General information only

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 matches relevant to your own location rather than UTC.

Teams can be filtered by id, name, abbreviation or display name. league separates professional from college, for example NHL or NCAA.

limit sets how many matches come back. When the number of matching games exceeds it, request the next page by increasing offset. See Pagination and limits.

Match states

Every match carries a state object, and that object is where the live detail sits. state.description holds one of the values below and state.score holds the score. It can also carry the period in play, the clock, which is the current minute of that period, and a report with an additional description such as Final.

So a single call to this endpoint gives you a scoreboard. You do not need the detail route to show the score, the period and the current minute.

Parameters

Request

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

const params = new URLSearchParams({
  league: 'NCAA',
  date: '2024-02-10'
})
const response = await fetch(`https://nhl.highlightly.net/matches?${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/matches',
    params={
        'league': '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,
      "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"
      }
    }
  ],
  "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