API docs by Redocly

NHL, NCAAH API | Highlightly (3.1.2)

Download OpenAPI specification:Download

Get ready for real time NHL and NCAAH live scores, match predictions, live events, highlights, game recaps, fouls, and post-match interviews on a global scale. Integrate a wide spectrum of pre-match and live game odds into your projects for a complete sports data solution.

Contact

For feature requests, questions, private plans or business inquiries you can contact us at [email protected].

You can also contact us via RapidAPI by starting a discussion or by sending us a private message.

Integration

To start using our API services you will first need to create an account via Highlightly or RapidAPI. Both platforms offer you the ability to view the API analytics, manage billing settings, control API keys and much more. However, there are a few differences. RapidAPI does not include custom plans nor does it provide long term plan discounts.

Accounts are not synced across platforms.

Please ensure that your API key is not made public to prevent potential abuse. Your API key can be managed either through Highlightly or RapidAPI.

API usage

Highlightly API base url: https://nhl.highlightly.net

RapidAPI API base url: https://nhl-ncaah-api.p.rapidapi.com

Each API request will be considered valid only if the following headers are present:

Request Header Value
x-rapidapi-key Your Highlightly or RapidAPI API Key
x-rapidapi-host nhl-ncaah-api.p.rapidapi.com - only needed for usage through RapidAPI

These headers are mandatory when requesting API data. They are not needed when requesting other resources such as logos or images.

Each API response will contain additional headers. The following three are considered the most important for developers:

Response Header Value
x-ratelimit-requests-limit This is a static value indicating the number of requests the plan you are currently subscribed to allows you to make.
x-ratelimit-requests-remaining The number of requests remaining (from your plan) before you reach the limit of requests your application is allowed to make. When this reaches zero, you will not be able to make any requests until your daily quota is reset. You can view these limits and quotas on the pricing page of the API in the API Hub.
content-type Value will always be application/json. XML format is not supported.

In the following sections we will guide you through all endpoints and functionalities the API has to offer.

NHL, NCAAH API

NHL, NCAAH.Bookmakers

Get all bookmakers

Refresh interval: Once a day

Retrieve a list of supported bookmakers.

There are two important parameters that are used to navigate through the pagination. The limit parameter defines what the number of returned bookmakers will be. If the number of actual bookmakers is above the limit value you can make subsequent requests by increasing the offset value.

The bookmakers name or id can be used to filter data from the odds endpoint.

query Parameters
name
string
Example: name=Stake.com
limit
number [ 0 .. 100 ]
Default: 20
Example: limit=20
offset
number >= 0
Default: 0
Example: offset=0
header Parameters
x-rapidapi-host
required
string

nhl-ncaah-api.p.rapidapi.com
x-rapidapi-key
required
string

Rapid API Token

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    },
  • "plan": {
    }
}

Get bookmaker by id

Retrieve bookmaker information by specifying the bookmaker id path parameter.

Note: Used to check whether a bookmaker still exists or had its information updated.

path Parameters
id
required
number

Requested bookmaker id.
header Parameters
x-rapidapi-host
required
string

nhl-ncaah-api.p.rapidapi.com
x-rapidapi-key
required
string

Rapid API Token

Responses

Response samples

Content type
application/json
[
  • {
    }
]

NHL, NCAAH.Head 2 Head

Get head 2 head games

Retrieve a list of the last ten head 2 head games between two teams. Compare the two teams to find out who is stronger based on their past match results.

Specify teamIdOne and teamIdTwo query parameters to retrieve the data. The order of team ids does not matter.

Below is an example of what you can achieve with the data:

H2H example

query Parameters
teamIdOne
required
number
Example: teamIdOne=1
teamIdTwo
required
number
Example: teamIdTwo=2
header Parameters
x-rapidapi-host
required
string

nhl-ncaah-api.p.rapidapi.com
x-rapidapi-key
required
string

Rapid API Token

Responses

Response samples

Content type
application/json
[
  • {
    }
]

NHL, NCAAH.Highlights

Get all highlights

Refresh interval: Once a minute

Note: Certain highlights might be uploaded whilst the game is playing. Full game recaps tend to be uploaded anywhere from 1 to 48 hours after a match is finished.

Highlights represent the core of our API. They include various different kinds of clips ranging from real time live events such as insane plays, last minute scores to full game recaps, pre/post match interviews.

Currently we aggregate videos from many different sources. Depending on the source and verification process we divide the clips into two categories:

Type Description
VERIFIED Videos come from reputable sources that have been thoroughly inspected. In most cases the clips are from official authors who own the copyrights to the video itself. The hosting platform can impose geo restrictions or prevent direct embedding (highlights/geo-restrictions/{highlightId} route can be used to check for potential restrictions). Verified highlights are uploaded anywhere from 1 to 48 hours of the match being finished.
UNVERIFIED Highlights vary and might not have gone through the verification process or are considered user uploaded. Videos include a wide spectrum of topics such as last minute scores, memorable plays, game recaps, etc. Unverified highlights are considered more real time and might be uploaded even when the match is still being played. The lifetime of these clips vary and is dependant on the hosting platform.

Each highlight has a title which describes what the video is about. Certain entries will have a description as well which is used to further describe the associated clip. The source field defines where the clip was aggregated from (e.g. would be youtube, twitter, reddit, espn, etc.). For certain sources you will see additional information being present in the channel field. By utilising this information you can further narrow down which videos you want to showcase. Highlights might also have an embedUrl property which is used to directly embed the videos into your website or mobile application.

Below is an example of what you can aim to achieve with our highlights data:

Highlights example

Retrieve highlights

Retrieve a list of highlights based on the requested query parameters.

At least one primary query parameter needs to be specified before you can retrieve the data (timezone, limit, offset are considered secondary).

You can specify the timezone field in combination with the date query parameter to get highlights relevant to your location.

There are two other important parameters. The limit parameter defines what the number of returned highlights will be. If the number of actual highlights is above the limit value you can make subsequent requests by increasing the offset value.

Note: The Basic/Free plan might have certain restrictions in place. More information can be found here.

query Parameters
leagueName
string
Example: leagueName=NCAA
date
string
Example: date=2024-02-10

Date that follows the YYYY-MM-DD format.
timezone
string
Default: "Etc/UTC"
Example: timezone=Europe/London

Valid timezone identifier.
season
number
Example: season=2024
matchId
number
Example: matchId=10523
homeTeamId
number
Example: homeTeamId=494
awayTeamId
number
Example: awayTeamId=15011
homeTeamName
string
Example: homeTeamName=Engineers
awayTeamName
string
Example: awayTeamName=Big Red
homeTeamAbbreviation
string
Example: homeTeamAbbreviation=RPI
awayTeamAbbreviation
string
Example: awayTeamAbbreviation=COR
homeTeamDisplayName
string
Example: homeTeamDisplayName=Rensselaer Engineers
awayTeamDisplayName
string
Example: awayTeamDisplayName=Cornell Big Red
limit
number [ 0 .. 40 ]
Default: 40
Example: limit=40
offset
number >= 0
Default: 0
Example: offset=0
header Parameters
x-rapidapi-host
required
string

nhl-ncaah-api.p.rapidapi.com
x-rapidapi-key
required
string

Rapid API Token

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    },
  • "plan": {
    }
}

Get geo restrictions for highlight

Refresh interval: Once an hour

Note: Endpoint is not available in the Basic/Free plan.

Geo restrictions are a plague that have been around for quite a while. They restrict access to online content based on the viewers geographical location. Trying to show restricted highlights to your users can greatly hinder the viewing experience.

Each highlight has a state property which defines how the geo restrictions are applied.

State Description
No restricitons applied Highlight has no restrictions applied and is available globally.
Allowed countries restriction Highlight is only available to users whose country code is found in the allowedCountries list.
Blocked countries restriction Highlight is blocked to all users whose country code is found in the blockedCountries list.
Unknown restrictions There is no guaranteed way to define all allowed or blocked countries.

As presented before, certain highlights have an embedUrl field which can be used to directly embed the video into your website or application. The embeddable field specifies whether this is allowed or not.

path Parameters
id
required
number

Requested highlight id.
header Parameters
x-rapidapi-host
required
string

nhl-ncaah-api.p.rapidapi.com
x-rapidapi-key
required
string

Rapid API Token

Responses

Response samples

Content type
application/json
{
  • "state": "Allowed countries restriction",
  • "allowedCountries": [
    ],
  • "blockedCountries": [ ],
  • "embeddable": true
}

Get highlight by id

Retrieve highlight information by specifying the highlight id path parameter.

Note: Used to check whether a highlight still exists or had its information updated.

path Parameters
id
required
number

Requested highlight id.
header Parameters
x-rapidapi-host
required
string

nhl-ncaah-api.p.rapidapi.com
x-rapidapi-key
required
string

Rapid API Token

Responses

Response samples

Content type
application/json
[
  • {
    }
]

NHL, NCAAH.Last Five Games

Get last five finished games for a specific team id

Refresh interval: Immediately once a game is considered finished

Retrieve a list of the last five finished games for a specific team. If a game was not finished (e.g. was cancelled or postponed) it will not be returned.

Specify teamId query parameter to retrieve the data. Endpoint is used to create a form section between two teams that are playing a match. Below is an example of what can be achieved:

Last five games example

query Parameters
teamId
required
number
Example: teamId=1
header Parameters
x-rapidapi-host
required
string

nhl-ncaah-api.p.rapidapi.com
x-rapidapi-key
required
string

Rapid API Token

Responses

Response samples

Content type
application/json
[
  • {
    }
]

NHL, NCAAH.Matches

Get all matches

Refresh interval: Once a minute

Route returns only general match information. For additional match details check the matches/{matchId} route.

Retrieve a list of matches based on the requested query parameters.

At least one primary query parameter needs to be specified before you can retrieve the data (timezone, limit, offset are considered secondary).

You can specify the timezone field in combination with the date query parameter to get matches relevant to your location.

There are two other important parameters. The limit parameter defines what the number of returned matches will be. If the number of actual matches is above the limit value you can make subsequent requests by increasing the offset value.

Matches have different possible states they can be in:

State Description
Postponed Match has been postponed due to certain circumstances that are preventing the game from being played. Event start time will be changed to a moment in the future.
Suspended Match has already been in play but was suspended. In the future the game will resume from the exact point where it was halted.
Cancelled Game will not be played.
Abandoned Considered "abandoned" when it is prematurely ended by the officials and can not be resumed or completed. In the future the game might be resumed from the exact point where it was halted.
Finished Match has been concluded.
Scheduled Match has not been started yet.
End period Break time between periods.
Half time Half time pause between second and third quarter.
In progress Game is currently in progress.
Unknown Unknown match coverage or state.

Below is an example of what you can aim to achieve with the matches endpoint:

NHL matches example

query Parameters
league
string
Example: league=NCAA
date
string
Example: date=2024-02-10

Date that follows the YYYY-MM-DD format.
timezone
string
Default: "Etc/UTC"
Example: timezone=Europe/London

Valid timezone identifier.
season
number
Example: season=2024
homeTeamId
number
Example: homeTeamId=494
awayTeamId
number
Example: awayTeamId=15011
homeTeamName
string
Example: homeTeamName=Engineers
awayTeamName
string
Example: awayTeamName=Big Red
homeTeamAbbreviation
string
Example: homeTeamAbbreviation=RPI
awayTeamAbbreviation
string
Example: awayTeamAbbreviation=COR
homeTeamDisplayName
string
Example: homeTeamDisplayName=Rensselaer Engineers
awayTeamDisplayName
string
Example: awayTeamDisplayName=Cornell Big Red
limit
number [ 0 .. 100 ]
Default: 100
Example: limit=100
offset
number >= 0
Default: 0
Example: offset=0
header Parameters
x-rapidapi-host
required
string

nhl-ncaah-api.p.rapidapi.com
x-rapidapi-key
required
string

Rapid API Token

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    },
  • "plan": {
    }
}

Get match by id

Retrieve detailed match information by specifying the match id path parameter.

Fetched data will have additional information about the venue, weather forecast, overallStatistics for each team, who the game's referees are and events.

Note: Used to retrieve additional match information.

path Parameters
id
required
number

Requested match id.
header Parameters
x-rapidapi-host
required
string

nhl-ncaah-api.p.rapidapi.com
x-rapidapi-key
required
string

Rapid API Token

Responses

Response samples

Content type
application/json
[
  • {
    }
]

NHL, NCAAH.Odds

Get all odds

Prematch odds refresh interval: Multiple times a day

Live odds refresh interval: Once every 10 minutes

Note: Endpoint is not available in the Basic/Free plan.

Retrieve a list of match odds based on the requested query parameters. With oddsType query parameter you can specify whether you want prematch or live odds. If you do not set a specific value prematch odds will be returned.

At least one primary query parameter needs to be specified before you can retrieve the data (timezone, limit, offset, oddsType are considered secondary).

The most popular way of getting match odds is by specifying the matchId query parameter. You can also utilise the date parameter alongside the timezone to fetch all match odds for a given day. By specifying league or bookmaker related fields you can further narrow down your search.

As it stands, we currently offer the support for the following markets:

Market Description
3-Way Moneyline The possible outcomes for the three-way moneyline market are Home, Draw or Away.
Moneyline When a match does not have a three-way moneyline it will have a two-way one instead. The possible outcomes for the mentioned market are either Home or Away. There is no possible way for the game to end in a Draw.
Total Goals This is considered a complex market. It is split into multiple possible variants such as "Total Goals 8", "Total Goals 8.5" and so on. The possible outcome of a variant is either Over or Under.
Odd or Even The Odd or Even market defines whether the score of both teams will be either Odd or Even.
Both Teams to Score The market defines whether both teams will score or not. Outcomes can be either Yes or No.
Correct Score This is considered a complex market. It is split into multiple possible variants such as "Correct Score 2 : 0", "Correct Score 1 : 1" and so on. There is only a single possible outcome of the variant.

There are two other important query parameters. The limit parameter defines what the number of returned match odds will be. If the number of actual match odds is above the limit value you can make subsequent requests by increasing the offset value.

Match odds are available up to 28 days after the game finishes and up to 7 days before the game starts.

Below is an example of what can be achieved with bookmaker odds on a match basis:

Odds example

query Parameters
oddsType
string
Example: oddsType=prematch

Defines whether live or prematch odds will be returned.

leagueName
string
Example: leagueName=NHL
timezone
string
Default: "Etc/UTC"
Example: timezone=Europe/London

Valid timezone identifier.
bookmakerId
number
Example: bookmakerId=1
limit
number [ 0 .. 5 ]
Default: 5
Example: limit=5
offset
number >= 0
Default: 0
Example: offset=0
matchId
number
bookmakerName
string
Example: bookmakerName=22Bet
date
string

Date that follows the YYYY-MM-DD format.
header Parameters
x-rapidapi-host
required
string

nhl-ncaah-api.p.rapidapi.com
x-rapidapi-key
required
string

Rapid API Token

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    },
  • "plan": {
    }
}

NHL, NCAAH.Standings

Get standings

Refresh interval: Up to an hour after a match for the associated league and season is finished

Retrieve standings data for a specific league, conference or division.

There are numerous ways on how to fetch the data. You can utilise either abbreviation or leagueName:

League Name Abbreviation
Metro Atlantic Athletic Conference MAAC
Western Conference WEST
College Hockey America CHA
Eastern Conference EAST
East Coast Athletic Conference ECAC
Independent IND
Northeast 10 Conference NE10
Western Collegiate Hockey Association WCHA
Central Collegiate Hockey Association CCHA
Hockey East HE

Additionally you can specify the year parameter to narrow down the the standings for that season.

There are two other important parameters that are used to navigate through the pagination. The limit parameter defines what the number of returned standings will be. If the number of actual standings is above the limit value you can make subsequent requests by increasing the offset value.

Below is an example on how you could render league associated standings

Standings example

query Parameters
leagueType
string
Example: leagueType=NHL
limit
number [ 0 .. 10 ]
Default: 10
Example: limit=5
offset
number >= 0
Default: 0
Example: offset=0
leagueName
string
Example: leagueName=Western Conference
abbreviation
string
Example: abbreviation=WEST
year
number
Example: year=2025
header Parameters
x-rapidapi-host
required
string

nhl-ncaah-api.p.rapidapi.com
x-rapidapi-key
required
string

Rapid API Token

Responses

Response samples

Content type
application/json
{
  • "leagueName": "Eastern Conference",
  • "abbreviation": "EAST",
  • "year": 2024,
  • "leagueType": "NHL",
  • "seasonType": "Regular Season",
  • "startDate": "2023-10-09T07:00:00.000Z",
  • "endDate": "2024-04-19T06:59:00.000Z",
  • "data": [ ]
}

NHL, NCAAH.Teams

Get all teams

Retrieve a list of teams that are supported by the API.

By utilising either league, name, displayName or abbreviation query parameters you can check whether a specific team exists or simply retrieve the associated data.

There are two other important query parameters. The limit parameter defines what the number of returned teams will be. If the number of actual teams is above the limit value you can make subsequent requests by increasing the offset value.

query Parameters
name
string
Example: name=Big Red
displayName
string
Example: displayName=Cornell Big Red
abbreviation
string
Example: abbreviation=COR
league
string
Example: league=NCAA
header Parameters
x-rapidapi-host
required
string

nhl-ncaah-api.p.rapidapi.com
x-rapidapi-key
required
string

Rapid API Token

Responses

Response samples

Content type
application/json
[ ]

Get team statistics

Refresh interval: Immediately once a match is finished.

Retrieve team stats for each league and season by specifying the team's id path parameter. Requires fromDate query parameter to be specified in the YYYY-MM-DD format. Additionally, the timezone query parameter can be specified to futher narrow down the search results based on your location.

path Parameters
id
required
number

Requested team id.
query Parameters
fromDate
required
string
Example: fromDate=2023-08-06

Date that follows the YYYY-MM-DD format.
timezone
string
Default: "Etc/UTC"
Example: timezone=Europe/London

Valid timezone identifier.
header Parameters
x-rapidapi-host
required
string

nhl-ncaah-api.p.rapidapi.com
x-rapidapi-key
required
string

Rapid API Token

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get team by team id

Retrieve team information by specifying the team id path parameter.

Note: Used to check whether a team still exists or had its information updated.

path Parameters
id
required
number

Requested team id.
header Parameters
x-rapidapi-host
required
string

nhl-ncaah-api.p.rapidapi.com
x-rapidapi-key
required
string

Rapid API Token

Responses

Response samples

Content type
application/json
[ ]

NHL, NCAAH.Lineups

Get linups by match id

Lineups should be queried up to a few hours before the game starts.

Retrieve home and away team lineups for a specific match.

Below is an example of what you can aim to achieve with the lineup endpoint:

Nba lineups example

path Parameters
matchId
required
number

Requested match id.
header Parameters
x-rapidapi-host
required
string

nhl-ncaah-api.p.rapidapi.com
x-rapidapi-key
required
string

Rapid API Token

Responses

Response samples

Content type
application/json
{
  • "home": {
    },
  • "away": {
    }
}

NHL, NCAAH.Players

Get all players

Refresh interval: 15 minutes

Route returns only general player information. For additional player details check the players/{playerId} and players/{playerId}/statistics routes.

Retrieve a list of players based on the requested query parameters.

Returned results will be paginated. The limit parameter defines what the number of returned players will be. If the number of actual players is above the limit value you can make subsequent requests by increasing the offset value.

query Parameters
name
string
Example: name=Colin White
limit
number [ 0 .. 1000 ]
Default: 1000
Example: limit=1000
offset
number >= 0
Default: 0
Example: offset=0
header Parameters
x-rapidapi-host
required
string

nhl-ncaah-api.p.rapidapi.com
x-rapidapi-key
required
string

Rapid API Token

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    },
  • "plan": {
    }
}

Get player summary by player id

Refresh interval: Once a day

Retrieve detailed player summary for specified playerId.

Detailed player summary consists of the following information:

Type Description
Profile Provides a structured summary of a player's personal and professional profile. It includes key details such as current team affiliation, physical attributes (height, weight), biographical data (name, birth date, birthplace, citizenship), and playing positions. The data reflects both the player's current career status and positional versatility, offering a higher level overview which is useful for scouting, analysis, or profile display.
path Parameters
id
required
number

Requested player id.
header Parameters
x-rapidapi-host
required
string

nhl-ncaah-api.p.rapidapi.com
x-rapidapi-key
required
string

Rapid API Token

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get player statistics by player id

Refresh interval: Once a day

Retrieve detailed player statistics for specified playerId.

Detailed player statistics are aggregated on a perSeason level. Each season has the following available coverage:

Type Description
Entire Combines both regular season and post-season statistics. Pre-season data is not included.
Season Includes only regular season statistics.

The following stats are available:

Type Description
General Overall player metrics including minutes, games, fouls, shootouts, penalties and so on.
Defense Stats tracking defensive impact such as saves, hits, etc.
Offense Metrics covering goals, shots, shootouts, assists, faceoffs, etc.
Penalties A variety of penalty related metrics such as why the penalties occured and how many times a player scored or missed and so on.

NHL, NCAA Player stats example

path Parameters
id
required
number

Requested player id.
header Parameters
x-rapidapi-host
required
string

nhl-ncaah-api.p.rapidapi.com
x-rapidapi-key
required
string

Rapid API Token

Responses

Response samples

Content type
application/json
[
  • {
    }
]