NHL — ESPN site API (v2)

sportsdataverse.nhl — 28 endpoints.

espn_nhl_scoreboard

ESPN endpoint.

Endpoint URL: GET https://site.api.espn.com/apis/site/v2/sports/hockey/nhl/scoreboard

Valid URL: https://site.api.espn.com/apis/site/v2/sports/hockey/nhl/scoreboard?dates=20240115

API Parameter	Python	Pattern	Required	Nullable
dates	dates			Y
week	week			Y
seasontype	season_type			Y
groups	groups			Y
limit	limit			Y

Returns

col_name	type	description
game_id	character	ESPN event id.
uid	character
date	character
name	character
short_name	character
season_year	integer
season_type	integer
season_slug	character
status_type_id	character
status_type_name	character
status_type_state	character
status_type_completed	logical
status_type_description	character
status_type_detail	character
status_type_short_detail	character
status_clock	double
status_display_clock	character
status_period	integer
neutral_site	logical
conference_competition	character
attendance	integer
venue_id	character
venue_full_name	character
venue_city	character
venue_state	character
venue_indoor	logical
broadcast	character
note	character
home_id	character
home_name	character
home_abbreviation	character
home_display_name	character
home_location	character
home_color	character
home_alternate_color	character
home_logo	character
home_score	character
home_winner	logical
home_rank	integer
away_id	character
away_name	character
away_abbreviation	character
away_display_name	character
away_location	character
away_color	character
away_alternate_color	character
away_logo	character
away_score	character
away_winner	logical
away_rank	integer

Example

espn_nhl_scoreboard(dates='20240115')

Last validated n/a.

espn_nhl_summary

ESPN endpoint.

Endpoint URL: GET https://site.api.espn.com/apis/site/v2/sports/hockey/nhl/summary

Valid URL: https://site.api.espn.com/apis/site/v2/sports/hockey/nhl/summary

API Parameter	Python	Pattern	Required	Nullable
event	event_id			Y

Returns

boxscore_player

col_name	type	description
team_id	character	Team id.
team_abbreviation	character	Team abbreviation.
team_display_name	character	Team display name.
team_location	character	Team location.
athlete_id	character	Athlete id.
athlete_display_name	character	Athlete display name.
athlete_short_name	character	Athlete short name.
athlete_jersey	character	Athlete jersey.
athlete_position	character	Athlete position.
starter	character	Starter.
active	character	Active.
did_not_play	character	Did not play.
ejected	character	Ejected.
reason	character	Reason.
blocked_shots	character
hits	character
takeaways	character
plus_minus	character	Plus minus.
time_on_ice	character
power_play_time_on_ice	character
short_handed_time_on_ice	character
even_strength_time_on_ice	character
shifts	character
goals	character
ytd_goals	character
assists	character	Assists.
shots_total	character
shots_missed	character
shootout_goals	character
faceoffs_won	character
faceoffs_lost	character
faceoff_percent	character
giveaways	character
penalties	character
penalty_minutes	character
goals_against	character
shots_against	character
shootout_saves	character
shootout_shots_against	character
saves	character
save_pct	character
even_strength_saves	character
power_play_saves	character
short_handed_saves	character

boxscore_team

col_name	type	description
team_id	character	Team id.
team_abbreviation	character	Team abbreviation.
team_display_name	character	Team display name.
home_away	character	Home away.
display_order	integer	Display order.
stat_name	character	Stat name.
stat_label	character	Stat label.
stat_display_value	character	Stat display value.
stat_value	character	Stat value.

plays

col_name	type	description
id	character	Id.
sequence_number	character	Sequence number.
text	character	Text.
away_score	integer	Away score.
home_score	integer	Home score.
scoring_play	logical	Scoring play.
score_value	integer	Score value.
modified	character
wallclock	character	Wallclock.
shooting_play	logical	Shooting play.
type_id	character	Type id.
type_text	character	Type text.
type_abbreviation	character
period_number	integer	Period number.
period_display_value	character	Period display value.
clock_display_value	character	Clock display value.
participants	character	Participants.
team_id	character	Team id.
strength_id	character
strength_text	character
strength_abbreviation	character
coordinate_x	double	Coordinate x.
coordinate_y	double	Coordinate y.
shot_info_id	character
shot_info_text	character
shot_info_abbreviation	character

leaders

col_name	type	description
team_id	character	Team id.
team_abbreviation	character	Team abbreviation.
category_name	character	Category name.
category_display_name	character	Category display name.
athlete_id	character	Athlete id.
athlete_display_name	character	Athlete display name.
athlete_position	character	Athlete position.
value	double	Value.
display_value	character	Display value.
main_stat	character	Main stat.
summary	character	Summary.

game_info

col_name	type	description
attendance	integer	Attendance.
venue_id	character	Venue id.
venue_guid	character	Venue guid.
venue_full_name	character	Venue full name.
venue_address_city	character	Venue address city.
venue_address_state	character	Venue address state.
venue_address_country	character
venue_grass	logical	Venue grass.

officials

col_name	type	description
full_name	character	Full name.
display_name	character	Display name.
order	integer	Order.
position_name	character	Position name.
position_display_name	character	Position display name.
position_id	character	Position id.

header

col_name	type	description
id	character	Id.
uid	character	Uid.
time_valid	logical	Time valid.
competitions	character	Competitions.
links	character	Links.
game_note	character
standings	character
season_year	integer	Season year.
season_current	logical	Season current.
season_type	integer	Season type.
league_id	character	League id.
league_uid	character	League uid.
league_name	character	League name.
league_abbreviation	character	League abbreviation.
league_slug	character	League slug.
league_is_tournament	logical	League is tournament.
league_links	character	League links.
league_logos	character	League logos.

season_series

col_name	type	description
type	character	Type.
title	character	Title.
description	character	Description.
summary	character	Summary.
completed	logical	Completed.
total_competitions	integer	Total competitions.
series_label	character	Series label.
series_score	character	Series score.
short_summary	character	Short summary.
events	character	Events.
round	character

standings

col_name	type	description
group_header	character	Group header.
conference_header	character	Conference header.
division_header	character	Division header.
team_id	character	Team id.
team_uid	character	Team uid.
team_location	character	Team location.
ot_losses	character
losses	character	Losses.
points	character	Points.
wins	character	Wins.

broadcasts

col_name	type	description
station	character
lang	character
region	character
is_national	logical
type_id	character	Type id.
type_short_name	character
type_long_name	character
type_slug	character
market_id	character
market_type	character
media_call_letters	character
media_name	character
media_short_name	character

format

col_name	type	description
regulation_periods	integer	Regulation periods.
regulation_display_name	character	Regulation display name.
regulation_slug	character	Regulation slug.
regulation_clock	double	Regulation clock.

article

col_name	type	description
id	integer	Id.
now_id	character	Now id.
content_key	character	Content key.
data_source_identifier	character	Data source identifier.
publishedkey	character	Publishedkey.
type	character	Type.
game_id	character	Game id.
headline	character	Headline.
description	character	Description.
link_text	character	Link text.
categorized	character	Categorized.
originally_posted	character	Originally posted.
last_modified	character	Last modified.
published	character	Published.
section	character	Section.
source	character	Source.
images	character	Images.
video	character	Video.
categories	character	Categories.
keywords	character	Keywords.
story	character	Story.
premium	logical	Premium.
is_live_blog	logical	Is live blog.
allow_comments	logical	Allow comments.
allow_search	logical	Allow search.
allow_content_reactions	logical	Allow content reactions.
links_web_href	character	Links web href.
links_mobile_href	character	Links mobile href.
links_api_self_href	character	Links api self href.
links_app_sportscenter_href	character	Links app sportscenter href.

injuries

col_name	type	description
injuries	character	Injuries.
team_id	character	Team id.
team_uid	character	Team uid.
team_display_name	character	Team display name.
team_abbreviation	character	Team abbreviation.
team_links	character	Team links.
team_logo	character	Team logo.
team_logos	character	Team logos.

news

col_name	type	description
id	integer	Id.
now_id	character	Now id.
content_key	character	Content key.
data_source_identifier	character	Data source identifier.
type	character	Type.
headline	character	Headline.
description	character	Description.
last_modified	character	Last modified.
published	character	Published.
images	character	Images.
categories	character	Categories.
premium	logical	Premium.
byline	character	Byline.
links_web_href	character	Links web href.
links_mobile_href	character	Links mobile href.
links_api_self_href	character	Links api self href.
links_app_sportscenter_href	character	Links app sportscenter href.

Example

espn_nhl_summary()

Last validated n/a.

espn_nhl_calendar

ESPN endpoint.

Endpoint URL: GET https://site.api.espn.com/apis/site/v2/sports/hockey/nhl/calendar

Valid URL: https://site.api.espn.com/apis/site/v2/sports/hockey/nhl/calendar

API Parameter	Python	Pattern	Required	Nullable

Returns

Raw JSON Dict (no parser registered).

Example

espn_nhl_calendar()

Last validated n/a.

espn_nhl_calendar_offseason

ESPN endpoint.

Endpoint URL: GET https://site.api.espn.com/apis/site/v2/sports/hockey/nhl/calendar/offseason

Valid URL: https://site.api.espn.com/apis/site/v2/sports/hockey/nhl/calendar/offseason

API Parameter	Python	Pattern	Required	Nullable

Returns

Raw JSON Dict (no parser registered).

Example

espn_nhl_calendar_offseason()

Last validated n/a.

espn_nhl_calendar_regular_season

ESPN endpoint.

Endpoint URL: GET https://site.api.espn.com/apis/site/v2/sports/hockey/nhl/calendar/regular-season

Valid URL: https://site.api.espn.com/apis/site/v2/sports/hockey/nhl/calendar/regular-season

API Parameter	Python	Pattern	Required	Nullable

Returns

Raw JSON Dict (no parser registered).

Example

espn_nhl_calendar_regular_season()

Last validated n/a.

espn_nhl_calendar_postseason

ESPN endpoint.

Endpoint URL: GET https://site.api.espn.com/apis/site/v2/sports/hockey/nhl/calendar/postseason

Valid URL: https://site.api.espn.com/apis/site/v2/sports/hockey/nhl/calendar/postseason

API Parameter	Python	Pattern	Required	Nullable

Returns

Raw JSON Dict (no parser registered).

Example

espn_nhl_calendar_postseason()

Last validated n/a.

espn_nhl_calendar_ondays

ESPN endpoint.

Endpoint URL: GET https://site.api.espn.com/apis/site/v2/sports/hockey/nhl/calendar/ondays

Valid URL: https://site.api.espn.com/apis/site/v2/sports/hockey/nhl/calendar/ondays

API Parameter	Python	Pattern	Required	Nullable

Returns

Raw JSON Dict (no parser registered).

Example

espn_nhl_calendar_ondays()

Last validated n/a.

espn_nhl_news

ESPN endpoint.

Endpoint URL: GET https://site.api.espn.com/apis/site/v2/sports/hockey/nhl/news

Valid URL: https://site.api.espn.com/apis/site/v2/sports/hockey/nhl/news

API Parameter	Python	Pattern	Required	Nullable
limit	limit			Y

Returns

Raw JSON Dict (no parser registered).

Example

espn_nhl_news()

Last validated n/a.

espn_nhl_injuries

ESPN endpoint.

Endpoint URL: GET https://site.api.espn.com/apis/site/v2/sports/hockey/nhl/injuries

Valid URL: https://site.api.espn.com/apis/site/v2/sports/hockey/nhl/injuries

API Parameter	Python	Pattern	Required	Nullable

Returns

Raw JSON Dict (no parser registered).

Example

espn_nhl_injuries()

Last validated n/a.

espn_nhl_transactions

ESPN endpoint.

Endpoint URL: GET https://site.api.espn.com/apis/site/v2/sports/hockey/nhl/transactions

Valid URL: https://site.api.espn.com/apis/site/v2/sports/hockey/nhl/transactions

API Parameter	Python	Pattern	Required	Nullable

Returns

Raw JSON Dict (no parser registered).

Example

espn_nhl_transactions()

Last validated n/a.

espn_nhl_conferences

ESPN endpoint.

Endpoint URL: GET https://site.api.espn.com/apis/site/v2/sports/hockey/nhl/groups

Valid URL: https://site.api.espn.com/apis/site/v2/sports/hockey/nhl/groups

API Parameter	Python	Pattern	Required	Nullable

Returns

Raw JSON Dict (no parser registered).

Example

espn_nhl_conferences()

Last validated n/a.

espn_nhl_statistics_league

ESPN endpoint.

Endpoint URL: GET https://site.api.espn.com/apis/site/v2/sports/hockey/nhl/statistics

Valid URL: https://site.api.espn.com/apis/site/v2/sports/hockey/nhl/statistics

API Parameter	Python	Pattern	Required	Nullable

Returns

Raw JSON Dict (no parser registered).

Example

espn_nhl_statistics_league()

Last validated n/a.

espn_nhl_draft

ESPN endpoint.

Endpoint URL: GET https://site.api.espn.com/apis/site/v2/sports/hockey/nhl/draft

Valid URL: https://site.api.espn.com/apis/site/v2/sports/hockey/nhl/draft

API Parameter	Python	Pattern	Required	Nullable

Returns

Raw JSON Dict (no parser registered).

Example

espn_nhl_draft()

Last validated n/a.

espn_nhl_teams_site

ESPN endpoint.

Endpoint URL: GET https://site.api.espn.com/apis/site/v2/sports/hockey/nhl/teams

Valid URL: https://site.api.espn.com/apis/site/v2/sports/hockey/nhl/teams

API Parameter	Python	Pattern	Required	Nullable
limit	limit			Y

Returns

col_name	type	description
team_abbreviation	character	Short team abbreviation (e.g. "BOS").
team_alternate_color	character	Secondary team color as a hex string (no leading '#').
team_color	character	Primary team color as a hex string (no leading '#').
team_display_name	character	Full team display name (location + nickname).
team_id	character	ESPN team id (stable join key across ESPN endpoints).
team_is_active	logical	Whether the team is currently active.
team_is_all_star	logical	Whether the entry is an all-star squad rather than a franchise.
team_location	character	Team location / city (e.g. "Boston").
team_logos	character	Pipe-delimited logo image URLs.
team_name	character	Team nickname/mascot (e.g. "Celtics").
team_nickname	character	Team nickname as ESPN labels it (often equals team_name).
team_short_display_name	character	Abbreviated display name for compact UIs.
team_slug	character	URL slug used in ESPN web paths.
team_uid	character	ESPN global UID (encodes sport/league/team).

Example

espn_nhl_teams_site()

Last validated n/a.

espn_nhl_team

ESPN endpoint.

Endpoint URL: GET https://site.api.espn.com/apis/site/v2/sports/hockey/nhl/teams/{team_id}

Valid URL: https://site.api.espn.com/apis/site/v2/sports/hockey/nhl/teams/4

API Parameter	Python	Pattern	Required	Nullable
team_id	team_id		Y

Returns

Raw JSON Dict (no parser registered).

Example

espn_nhl_team(team_id='4')

Last validated n/a.

espn_nhl_team_roster

ESPN endpoint.

Endpoint URL: GET https://site.api.espn.com/apis/site/v2/sports/hockey/nhl/teams/{team_id}/roster

Valid URL: https://site.api.espn.com/apis/site/v2/sports/hockey/nhl/teams/4/roster

API Parameter	Python	Pattern	Required	Nullable
team_id	team_id		Y

Returns

col_name	type	description
position_group	character
id	character	Id.
uid	character	Uid.
guid	character	Guid.
alternate_id	character
first_name	character	First name.
last_name	character	Last name.
full_name	character	Full name.
display_name	character	Display name.
short_name	character	Short name.
weight	double	Weight.
display_weight	character	Display weight.
height	double	Height.
display_height	character	Display height.
age	integer	Age.
date_of_birth	character	Date of birth.
links	character	Links.
slug	character	Slug.
jersey	character	Jersey.
injuries	character	Injuries.
teams	character	Teams.
contracts	character	Contracts.
alternate_ids_sdr	character	Alternate ids sdr.
birth_place_city	character	Birth place city.
birth_place_country	character	Birth place country.
birth_place_display_text	character
birth_country_abbreviation	character
headshot_href	character	Headshot href.
headshot_alt	character	Headshot alt.
hand_type	character	Hand type.
hand_abbreviation	character	Hand abbreviation.
hand_display_value	character	Hand display value.
position_id	character	Position id.
position_name	character	Position name.
position_display_name	character	Position display name.
position_abbreviation	character	Position abbreviation.
position_leaf	logical	Position leaf.
position_parent_id	character
position_parent_name	character
position_parent_display_name	character
position_parent_abbreviation	character
position_parent_leaf	logical
experience_years	integer	Experience years.
status_id	character	Status id.
status_name	character	Status name.
status_type	character	Status type.
status_abbreviation	character	Status abbreviation.
debut_year	double	Debut year.
college_id	character	College id.
college_guid	character	College guid.
college_mascot	character	College mascot.
college_name	character	College name.
college_short_name	character	College short name.
college_abbrev	character	College abbrev.
college_logos	character	College logos.
birth_place_state	character	Birth place state.

Example

espn_nhl_team_roster(team_id='4')

Last validated n/a.

espn_nhl_team_schedule

ESPN endpoint.

Endpoint URL: GET https://site.api.espn.com/apis/site/v2/sports/hockey/nhl/teams/{team_id}/schedule

Valid URL: https://site.api.espn.com/apis/site/v2/sports/hockey/nhl/teams/4/schedule

API Parameter	Python	Pattern	Required	Nullable
team_id	team_id		Y
season	season			Y

Returns

Raw JSON Dict (no parser registered).

Example

espn_nhl_team_schedule(team_id='4')

Last validated n/a.

espn_nhl_team_record

ESPN endpoint.

Endpoint URL: GET https://site.api.espn.com/apis/site/v2/sports/hockey/nhl/teams/{team_id}/record

Valid URL: https://site.api.espn.com/apis/site/v2/sports/hockey/nhl/teams/4/record

API Parameter	Python	Pattern	Required	Nullable
team_id	team_id		Y

Returns

Raw JSON Dict (no parser registered).

Example

espn_nhl_team_record(team_id='4')

Last validated n/a.

espn_nhl_team_depthcharts

ESPN endpoint.

Endpoint URL: GET https://site.api.espn.com/apis/site/v2/sports/hockey/nhl/teams/{team_id}/depthcharts

Valid URL: https://site.api.espn.com/apis/site/v2/sports/hockey/nhl/teams/4/depthcharts

API Parameter	Python	Pattern	Required	Nullable
team_id	team_id		Y

Returns

Raw JSON Dict (no parser registered).

Example

espn_nhl_team_depthcharts(team_id='4')

Last validated n/a.

espn_nhl_team_injuries

ESPN endpoint.

Endpoint URL: GET https://site.api.espn.com/apis/site/v2/sports/hockey/nhl/teams/{team_id}/injuries

Valid URL: https://site.api.espn.com/apis/site/v2/sports/hockey/nhl/teams/4/injuries

API Parameter	Python	Pattern	Required	Nullable
team_id	team_id		Y

Returns

Raw JSON Dict (no parser registered).

Example

espn_nhl_team_injuries(team_id='4')

Last validated n/a.

espn_nhl_team_transactions

ESPN endpoint.

Endpoint URL: GET https://site.api.espn.com/apis/site/v2/sports/hockey/nhl/teams/{team_id}/transactions

Valid URL: https://site.api.espn.com/apis/site/v2/sports/hockey/nhl/teams/4/transactions

API Parameter	Python	Pattern	Required	Nullable
team_id	team_id		Y

Returns

Raw JSON Dict (no parser registered).

Example

espn_nhl_team_transactions(team_id='4')

Last validated n/a.

espn_nhl_team_history

ESPN endpoint.

Endpoint URL: GET https://site.api.espn.com/apis/site/v2/sports/hockey/nhl/teams/{team_id}/history

Valid URL: https://site.api.espn.com/apis/site/v2/sports/hockey/nhl/teams/4/history

API Parameter	Python	Pattern	Required	Nullable
team_id	team_id		Y

Returns

Raw JSON Dict (no parser registered).

Example

espn_nhl_team_history(team_id='4')

Last validated n/a.

espn_nhl_team_news

ESPN endpoint.

Endpoint URL: GET https://site.api.espn.com/apis/site/v2/sports/hockey/nhl/teams/{team_id}/news

Valid URL: https://site.api.espn.com/apis/site/v2/sports/hockey/nhl/teams/4/news

API Parameter	Python	Pattern	Required	Nullable
team_id	team_id		Y
limit	limit			Y

Returns

Raw JSON Dict (no parser registered).

Example

espn_nhl_team_news(team_id='4')

Last validated n/a.

espn_nhl_team_leaders

ESPN endpoint.

Endpoint URL: GET https://site.api.espn.com/apis/site/v2/sports/hockey/nhl/teams/{team_id}/leaders

Valid URL: https://site.api.espn.com/apis/site/v2/sports/hockey/nhl/teams/4/leaders

API Parameter	Python	Pattern	Required	Nullable
team_id	team_id		Y

Returns

Raw JSON Dict (no parser registered).

Example

espn_nhl_team_leaders(team_id='4')

Last validated n/a.

espn_nhl_player_info

ESPN endpoint.

Endpoint URL: GET https://site.api.espn.com/apis/site/v2/sports/hockey/nhl/athletes/{athlete_id}

Valid URL: https://site.api.espn.com/apis/site/v2/sports/hockey/nhl/athletes/4239

API Parameter	Python	Pattern	Required	Nullable
athlete_id	athlete_id		Y

Returns

Raw JSON Dict (no parser registered).

Example

espn_nhl_player_info(athlete_id='4239')

Last validated n/a.

espn_nhl_player_bio

ESPN endpoint.

Endpoint URL: GET https://site.api.espn.com/apis/site/v2/sports/hockey/nhl/athletes/{athlete_id}/bio

Valid URL: https://site.api.espn.com/apis/site/v2/sports/hockey/nhl/athletes/4239/bio

API Parameter	Python	Pattern	Required	Nullable
athlete_id	athlete_id		Y

Returns

Raw JSON Dict (no parser registered).

Example

espn_nhl_player_bio(athlete_id='4239')

Last validated n/a.

espn_nhl_player_news

ESPN endpoint.

Endpoint URL: GET https://site.api.espn.com/apis/site/v2/sports/hockey/nhl/athletes/{athlete_id}/news

Valid URL: https://site.api.espn.com/apis/site/v2/sports/hockey/nhl/athletes/4239/news

API Parameter	Python	Pattern	Required	Nullable
athlete_id	athlete_id		Y

Returns

Raw JSON Dict (no parser registered).

Example

espn_nhl_player_news(athlete_id='4239')

Last validated n/a.

espn_nhl_standings

ESPN endpoint.

Endpoint URL: GET https://site.api.espn.com/apis/v2/sports/hockey/nhl/standings

Valid URL: https://site.api.espn.com/apis/v2/sports/hockey/nhl/standings

API Parameter	Python	Pattern	Required	Nullable
season	season			Y
group	group			Y
type	standings_type			Y

Returns

col_name	type	description
group_name	character	Group name.
group_abbreviation	character	Group abbreviation.
team_id	character	Team id.
team_name	character	Team name.
team_abbreviation	character	Team abbreviation.
team_display_name	character	Team display name.
team_location	character	Team location.
team_logo	character	Team logo.
ot_losses	double
clincher	double	Clincher.
differential	double	Differential.
games_behind	double	Games behind.
games_played	double
losses	double	Losses.
playoff_seed	double	Playoff seed.
point_differential	double	Point differential.
points	double	Points.
points_against	double	Points against.
points_for	double	Points for.
streak	double	Streak.
wins	double	Wins.
overtime_losses	double
overtime_wins	double
points_diff	double
reg_losses	double
reg_wins	double
rot_losses	double
rot_wins	double
shootout_losses	double
shootout_wins	double
overall	character	Overall.
home	character	Home.
road	character	Road.
last ten games	character	Last ten games.
vs. div.	character	Vs. div..

Example

espn_nhl_standings()

Last validated n/a.