NHL — NHL Stats REST API

sportsdataverse.nhl — 21 endpoints.

nhl_stats_rest_ping

Ping the NHL Stats REST API database.

Endpoint URL: GET https://api.nhle.com/stats/rest/ping

Valid URL: https://api.nhle.com/stats/rest/ping

API Parameter	Python	Pattern	Required	Nullable	Description

Returns

Ping the NHL Stats REST API database.

Example

nhl_stats_rest_ping()

Last validated n/a.

nhl_stats_rest_component_season

Retrieve the component-season configuration.

Endpoint URL: GET https://api.nhle.com/stats/rest/{lang}/componentSeason

Valid URL: https://api.nhle.com/stats/rest

API Parameter	Python	Pattern	Required	Nullable	Description
lang	lang			Y	lang path parameter.

Returns

Retrieve the component-season configuration.

Example

nhl_stats_rest_component_season()

Last validated n/a.

nhl_stats_rest_config

Retrieve the Stats REST API configuration payload.

Endpoint URL: GET https://api.nhle.com/stats/rest/{lang}/config

Valid URL: https://api.nhle.com/stats/rest

API Parameter	Python	Pattern	Required	Nullable	Description
lang	lang			Y	lang path parameter.

Returns

Retrieve the Stats REST API configuration payload.

Example

nhl_stats_rest_config()

Last validated n/a.

nhl_stats_rest_content_module

Retrieve a content module by template key.

Endpoint URL: GET https://api.nhle.com/stats/rest/{lang}/content/module/{template_key}

Valid URL: https://api.nhle.com/stats/rest

API Parameter	Python	Pattern	Required	Nullable	Description
template_key	template_key		Y		template_key path parameter.
lang	lang			Y	lang path parameter.

Returns

Retrieve a content module by template key.

Example

nhl_stats_rest_content_module(template_key='X')

Last validated n/a.

nhl_stats_rest_country

Retrieve the list of countries used in NHL data.

Endpoint URL: GET https://api.nhle.com/stats/rest/{lang}/country

Valid URL: https://api.nhle.com/stats/rest

API Parameter	Python	Pattern	Required	Nullable	Description
lang	lang			Y	lang path parameter.

Returns

col_name	type	description
id	character	Id.
country3_code	character
country_code	character	Team/venue country code.
country_name	character
has_player_stats	integer
image_url	character
ioc_code	character
is_active	integer	Whether the team was active in this season.
nationality_name	character
olympic_url	character
thumbnail_url	character

Example

nhl_stats_rest_country()

Last validated n/a.

nhl_stats_rest_draft

Retrieve draft data, optionally filtered with Cayenne expressions.

Endpoint URL: GET https://api.nhle.com/stats/rest/{lang}/draft

Valid URL: https://api.nhle.com/stats/rest

API Parameter	Python	Pattern	Required	Nullable	Description
lang	lang			Y	lang path parameter.

Returns

Retrieve draft data, optionally filtered with Cayenne expressions.

Example

nhl_stats_rest_draft()

Last validated n/a.

nhl_stats_rest_franchise

Retrieve franchise data.

Endpoint URL: GET https://api.nhle.com/stats/rest/{lang}/franchise

Valid URL: https://api.nhle.com/stats/rest

API Parameter	Python	Pattern	Required	Nullable	Description
lang	lang			Y	lang path parameter.

Returns

col_name	type	description
id	integer	Id.
full_name	character	Player's full name.
team_common_name	character
team_place_name	character

Example

nhl_stats_rest_franchise()

Last validated n/a.

nhl_stats_rest_game

Retrieve game-level data.

Endpoint URL: GET https://api.nhle.com/stats/rest/{lang}/game

Valid URL: https://api.nhle.com/stats/rest

API Parameter	Python	Pattern	Required	Nullable	Description
lang	lang			Y	lang path parameter.

Returns

Retrieve game-level data.

Example

nhl_stats_rest_game()

Last validated n/a.

nhl_stats_rest_glossary

Retrieve the NHL Stats glossary of stat definitions.

Endpoint URL: GET https://api.nhle.com/stats/rest/{lang}/glossary

Valid URL: https://api.nhle.com/stats/rest

API Parameter	Python	Pattern	Required	Nullable	Description
lang	lang			Y	lang path parameter.

Returns

col_name	type	description
id	integer	Id.
abbreviation	character	Short abbreviation.
definition	character
first_season_for_stat	double
full_name	character	Player's full name.
language_code	character	Short language code (e.g. 'en', 'xe').
last_updated	character	Last-updated timestamp.

Example

nhl_stats_rest_glossary()

Last validated n/a.

nhl_stats_rest_goalie_report

Retrieve a goalie statistical report.

Endpoint URL: GET https://api.nhle.com/stats/rest/{lang}/goalie/{report}

Valid URL: https://api.nhle.com/stats/rest

API Parameter	Python	Pattern	Required	Nullable	Description
report	report		Y		report path parameter.
lang	lang			Y	lang path parameter.

Returns

col_name	type	description
assists	integer	Total assists.
games_played	integer	Games played.
games_started	integer	Games started.
goalie_full_name	character
goals	integer
goals_against	integer
goals_against_average	double
last_name	character	Player's last name.
losses	integer	Total losses.
ot_losses	integer
penalty_minutes	integer
player_id	integer	Unique player identifier.
points	integer	Points scored.
save_pct	double
saves	integer	Saves.
season_id	integer	Unique season identifier.
shoots_catches	character
shots_against	integer
shutouts	integer	Shutouts.
team_abbrevs	character
ties	character	Number of ties in the series.
time_on_ice	integer
wins	integer	Total wins.

Example

nhl_stats_rest_goalie_report(report='summary')

Last validated n/a.

nhl_stats_rest_leaders_goalies

Retrieve league leaders for a goalie statistical attribute.

Endpoint URL: GET https://api.nhle.com/stats/rest/{lang}/leaders/goalies/{attribute}

Valid URL: https://api.nhle.com/stats/rest

API Parameter	Python	Pattern	Required	Nullable	Description
attribute	attribute		Y		attribute path parameter.
lang	lang			Y	lang path parameter.

Returns

Retrieve league leaders for a goalie statistical attribute.

Example

nhl_stats_rest_leaders_goalies(attribute='X')

Last validated n/a.

nhl_stats_rest_leaders_skaters

Retrieve league leaders for a skater statistical attribute.

Endpoint URL: GET https://api.nhle.com/stats/rest/{lang}/leaders/skaters/{attribute}

Valid URL: https://api.nhle.com/stats/rest

API Parameter	Python	Pattern	Required	Nullable	Description
attribute	attribute		Y		attribute path parameter.
lang	lang			Y	lang path parameter.

Returns

Retrieve league leaders for a skater statistical attribute.

Example

nhl_stats_rest_leaders_skaters(attribute='X')

Last validated n/a.

nhl_stats_rest_milestones_goalies

Retrieve milestone data for goalies.

Endpoint URL: GET https://api.nhle.com/stats/rest/{lang}/milestones/goalies

Valid URL: https://api.nhle.com/stats/rest

API Parameter	Python	Pattern	Required	Nullable	Description
lang	lang			Y	lang path parameter.

Returns

Retrieve milestone data for goalies.

Example

nhl_stats_rest_milestones_goalies()

Last validated n/a.

nhl_stats_rest_milestones_skaters

Retrieve milestone data for skaters.

Endpoint URL: GET https://api.nhle.com/stats/rest/{lang}/milestones/skaters

Valid URL: https://api.nhle.com/stats/rest

API Parameter	Python	Pattern	Required	Nullable	Description
lang	lang			Y	lang path parameter.

Returns

Retrieve milestone data for skaters.

Example

nhl_stats_rest_milestones_skaters()

Last validated n/a.

nhl_stats_rest_players

Retrieve the NHL player registry.

Endpoint URL: GET https://api.nhle.com/stats/rest/{lang}/players

Valid URL: https://api.nhle.com/stats/rest

API Parameter	Python	Pattern	Required	Nullable	Description
lang	lang			Y	lang path parameter.

Returns

Retrieve the NHL player registry.

Example

nhl_stats_rest_players()

Last validated n/a.

nhl_stats_rest_season

Retrieve the list of all NHL seasons.

Endpoint URL: GET https://api.nhle.com/stats/rest/{lang}/season

Valid URL: https://api.nhle.com/stats/rest

API Parameter	Python	Pattern	Required	Nullable	Description
lang	lang			Y	lang path parameter.

Returns

col_name	type	description
id	integer	Id.
all_star_game_in_use	integer
conferences_in_use	integer
divisions_in_use	integer
end_date	character	End date (YYYY-MM-DD).
entry_draft_in_use	integer
formatted_season_id	character
minimum_playoff_minutes_for_goalie_stats_leaders	integer
minimum_regular_games_for_goalie_stats_leaders	integer
nhl_stanley_cup_owner	integer
number_of_games	integer
olympics_participation	integer
point_for_ot_loss_in_use	integer
preseason_startdate	character
regular_season_end_date	character	Regular season end date.
row_in_use	integer
season_ordinal	integer
start_date	character	Start date (YYYY-MM-DD).
supplemental_draft_in_use	integer
ties_in_use	integer
total_playoff_games	integer
total_regular_season_games	integer
wildcard_in_use	integer

Example

nhl_stats_rest_season()

Last validated n/a.

nhl_stats_rest_shiftcharts

Retrieve shift-chart data.

Endpoint URL: GET https://api.nhle.com/stats/rest/{lang}/shiftcharts

Valid URL: https://api.nhle.com/stats/rest

API Parameter	Python	Pattern	Required	Nullable	Description
lang	lang			Y	lang path parameter.

Returns

Retrieve shift-chart data.

Example

nhl_stats_rest_shiftcharts()

Last validated n/a.

nhl_stats_rest_skater_report

Retrieve a skater statistical report.

Endpoint URL: GET https://api.nhle.com/stats/rest/{lang}/skater/{report}

Valid URL: https://api.nhle.com/stats/rest

API Parameter	Python	Pattern	Required	Nullable	Description
report	report		Y		report path parameter.
lang	lang			Y	lang path parameter.

Returns

col_name	type	description
assists	integer	Total assists.
ev_goals	integer
ev_points	integer
faceoff_win_pct	double
game_winning_goals	integer
games_played	integer	Games played.
goals	integer
last_name	character	Player's last name.
ot_goals	integer
penalty_minutes	integer
player_id	integer	Unique player identifier.
plus_minus	integer	Plus/minus point differential while on court.
points	integer	Points scored.
points_per_game	double
position_code	character	Numeric scorekeeping position code.
pp_goals	integer
pp_points	integer
season_id	integer	Unique season identifier.
sh_goals	integer
sh_points	integer
shooting_pct	double
shoots_catches	character
shots	integer
skater_full_name	character
team_abbrevs	character
time_on_ice_per_game	double

Example

nhl_stats_rest_skater_report(report='summary')

Last validated n/a.

nhl_stats_rest_team

Retrieve the list of all NHL teams.

Endpoint URL: GET https://api.nhle.com/stats/rest/{lang}/team

Valid URL: https://api.nhle.com/stats/rest

API Parameter	Python	Pattern	Required	Nullable	Description
lang	lang			Y	lang path parameter.

Returns

Retrieve the list of all NHL teams.

Example

nhl_stats_rest_team()

Last validated n/a.

nhl_stats_rest_team_by_id

Retrieve a single team by its numeric ID.

Endpoint URL: GET https://api.nhle.com/stats/rest/{lang}/team/id/{team_id}

Valid URL: https://api.nhle.com/stats/rest

API Parameter	Python	Pattern	Required	Nullable	Description
team_id	team_id		Y		team_id path parameter.
lang	lang			Y	lang path parameter.

Returns

Retrieve a single team by its numeric ID.

Example

nhl_stats_rest_team_by_id(team_id=10)

Last validated n/a.

nhl_stats_rest_team_report

Retrieve a team statistical report.

Endpoint URL: GET https://api.nhle.com/stats/rest/{lang}/team/{report}

Valid URL: https://api.nhle.com/stats/rest

API Parameter	Python	Pattern	Required	Nullable	Description
report	report		Y		report path parameter.
lang	lang			Y	lang path parameter.

Returns

col_name	type	description
faceoff_win_pct	double
games_played	integer	Games played.
goals_against	integer
goals_against_per_game	double
goals_for	integer
goals_for_per_game	double
losses	integer	Total losses.
ot_losses	integer
penalty_kill_net_pct	double
penalty_kill_pct	double
point_pct	double
points	integer	Points scored.
power_play_net_pct	double
power_play_pct	double
regulation_and_ot_wins	integer
season_id	integer	Unique season identifier.
shots_against_per_game	double
shots_for_per_game	double
team_full_name	character	Full team name.
team_id	integer	Unique team identifier.
team_shutouts	integer
ties	character	Number of ties in the series.
wins	integer	Total wins.
wins_in_regulation	integer
wins_in_shootout	integer

Example

nhl_stats_rest_team_report(report='summary')

Last validated n/a.