NHL — ESPN core API (v2)

sportsdataverse.nhl — 81 endpoints.

espn_nhl_league_root

ESPN endpoint.

Endpoint URL: GET https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl

Valid URL: https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl

API Parameter	Python	Pattern	Required	Nullable	Description

Returns

return_parsed=True (default) — a tidy polars.DataFrame (parser: parse_single_entity); pass return_as_pandas=True for a pandas.DataFrame. return_parsed=False — the raw JSON Dict payload, unparsed.

Example

espn_nhl_league_root()

Last validated n/a.

espn_nhl_season_pointer

ESPN endpoint.

Endpoint URL: GET https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/season

Valid URL: https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/season

API Parameter	Python	Pattern	Required	Nullable	Description

Returns

return_parsed=True (default) — a tidy polars.DataFrame (parser: parse_single_entity); pass return_as_pandas=True for a pandas.DataFrame. return_parsed=False — the raw JSON Dict payload, unparsed.

Example

espn_nhl_season_pointer()

Last validated n/a.

espn_nhl_seasons

ESPN endpoint.

Endpoint URL: GET https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/seasons

Valid URL: https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/seasons

API Parameter	Python	Pattern	Required	Nullable	Description
limit	limit			Y	Maximum number of items to return.

Returns

return_parsed=True (default) — a tidy polars.DataFrame (parser: parse_items); pass return_as_pandas=True for a pandas.DataFrame. return_parsed=False — the raw JSON Dict payload, unparsed.

Example

espn_nhl_seasons()

Last validated n/a.

espn_nhl_season_info

ESPN endpoint.

Endpoint URL: GET https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/seasons/{season}

Valid URL: https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/seasons/2024

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

Returns

return_parsed=True (default) — a tidy polars.DataFrame (parser: parse_single_entity); pass return_as_pandas=True for a pandas.DataFrame. return_parsed=False — the raw JSON Dict payload, unparsed.

Example

espn_nhl_season_info(season=2024)

Last validated n/a.

espn_nhl_season_types

ESPN endpoint.

Endpoint URL: GET https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/seasons/{season}/types

Valid URL: https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/seasons/2024/types

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

Returns

return_parsed=True (default) — a tidy polars.DataFrame (parser: parse_items); pass return_as_pandas=True for a pandas.DataFrame. return_parsed=False — the raw JSON Dict payload, unparsed.

Example

espn_nhl_season_types(season=2024)

Last validated n/a.

espn_nhl_season_type

ESPN endpoint.

Endpoint URL: GET https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/seasons/{season}/types/{season_type}

Valid URL: https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/seasons/2024/types/2

API Parameter	Python	Pattern	Required	Nullable	Description
season	season		Y		season path parameter.
season_type	season_type		Y		season_type path parameter.

Returns

return_parsed=True (default) — a tidy polars.DataFrame (parser: parse_single_entity); pass return_as_pandas=True for a pandas.DataFrame. return_parsed=False — the raw JSON Dict payload, unparsed.

Example

espn_nhl_season_type(season=2024, season_type=2)

Last validated n/a.

espn_nhl_season_group

ESPN endpoint.

Endpoint URL: GET https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/seasons/{season}/types/{season_type}/groups/{group_id}

Valid URL: https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/seasons/2024/types/2/groups/80

API Parameter	Python	Pattern	Required	Nullable	Description
season	season		Y		season path parameter.
season_type	season_type		Y		season_type path parameter.
group_id	group_id		Y		group_id path parameter.

Returns

return_parsed=True (default) — a tidy polars.DataFrame (parser: parse_single_entity); pass return_as_pandas=True for a pandas.DataFrame. return_parsed=False — the raw JSON Dict payload, unparsed.

Example

espn_nhl_season_group(season=2024, season_type=2, group_id=80)

Last validated n/a.

espn_nhl_season_groups

ESPN endpoint.

Endpoint URL: GET https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/seasons/{season}/types/{season_type}/groups

Valid URL: https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/seasons/2024/types/2/groups

API Parameter	Python	Pattern	Required	Nullable	Description
season	season		Y		season path parameter.
season_type	season_type		Y		season_type path parameter.

Returns

return_parsed=True (default) — a tidy polars.DataFrame (parser: parse_items); pass return_as_pandas=True for a pandas.DataFrame. return_parsed=False — the raw JSON Dict payload, unparsed.

Example

espn_nhl_season_groups(season=2024, season_type=2)

Last validated n/a.

espn_nhl_season_group_teams

ESPN endpoint.

Endpoint URL: GET https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/seasons/{season}/types/{season_type}/groups/{group_id}/teams

Valid URL: https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/seasons/2024/types/2/groups/80/teams

API Parameter	Python	Pattern	Required	Nullable	Description
season	season		Y		season path parameter.
season_type	season_type		Y		season_type path parameter.
group_id	group_id		Y		group_id path parameter.
limit	limit			Y	Maximum number of items to return.

Returns

return_parsed=True (default) — a tidy polars.DataFrame (parser: parse_items); pass return_as_pandas=True for a pandas.DataFrame. return_parsed=False — the raw JSON Dict payload, unparsed.

Example

espn_nhl_season_group_teams(season=2024, season_type=2, group_id=80)

Last validated n/a.

espn_nhl_season_group_children

ESPN endpoint.

Endpoint URL: GET https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/seasons/{season}/types/{season_type}/groups/{group_id}/children

Valid URL: https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/seasons/2024/types/2/groups/80/children

API Parameter	Python	Pattern	Required	Nullable	Description
season	season		Y		season path parameter.
season_type	season_type		Y		season_type path parameter.
group_id	group_id		Y		group_id path parameter.

Returns

return_parsed=True (default) — a tidy polars.DataFrame (parser: parse_items); pass return_as_pandas=True for a pandas.DataFrame. return_parsed=False — the raw JSON Dict payload, unparsed.

Example

espn_nhl_season_group_children(season=2024, season_type=2, group_id=80)

Last validated n/a.

espn_nhl_season_type_leaders

ESPN endpoint.

Endpoint URL: GET https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/seasons/{season}/types/{season_type}/leaders

Valid URL: https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/seasons/2024/types/2/leaders

API Parameter	Python	Pattern	Required	Nullable	Description
season	season		Y		season path parameter.
season_type	season_type		Y		season_type path parameter.

Returns

return_parsed=True (default) — a tidy polars.DataFrame (parser: parse_items); pass return_as_pandas=True for a pandas.DataFrame. return_parsed=False — the raw JSON Dict payload, unparsed.

Example

espn_nhl_season_type_leaders(season=2024, season_type=2)

Last validated n/a.

espn_nhl_season_type_corrections

ESPN endpoint.

Endpoint URL: GET https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/seasons/{season}/types/{season_type}/corrections

Valid URL: https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/seasons/2024/types/2/corrections

API Parameter	Python	Pattern	Required	Nullable	Description
season	season		Y		season path parameter.
season_type	season_type		Y		season_type path parameter.

Returns

return_parsed=True (default) — a tidy polars.DataFrame (parser: parse_items); pass return_as_pandas=True for a pandas.DataFrame. return_parsed=False — the raw JSON Dict payload, unparsed.

Example

espn_nhl_season_type_corrections(season=2024, season_type=2)

Last validated n/a.

espn_nhl_season_weeks

ESPN endpoint.

Endpoint URL: GET https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/seasons/{season}/types/{season_type}/weeks

Valid URL: https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/seasons/2024/types/2/weeks

API Parameter	Python	Pattern	Required	Nullable	Description
season	season		Y		season path parameter.
season_type	season_type		Y		season_type path parameter.

Returns

return_parsed=True (default) — a tidy polars.DataFrame (parser: parse_items); pass return_as_pandas=True for a pandas.DataFrame. return_parsed=False — the raw JSON Dict payload, unparsed.

Example

espn_nhl_season_weeks(season=2024, season_type=2)

Last validated n/a.

espn_nhl_season_week

ESPN endpoint.

Endpoint URL: GET https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/seasons/{season}/types/{season_type}/weeks/{week}

Valid URL: https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/seasons/2024/types/2/weeks/1

API Parameter	Python	Pattern	Required	Nullable	Description
season	season		Y		season path parameter.
season_type	season_type		Y		season_type path parameter.
week	week		Y		week path parameter.

Returns

return_parsed=True (default) — a tidy polars.DataFrame (parser: parse_single_entity); pass return_as_pandas=True for a pandas.DataFrame. return_parsed=False — the raw JSON Dict payload, unparsed.

Example

espn_nhl_season_week(season=2024, season_type=2, week=1)

Last validated n/a.

espn_nhl_season_week_games

ESPN endpoint.

Endpoint URL: GET https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/seasons/{season}/types/{season_type}/weeks/{week}/events

Valid URL: https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/seasons/2024/types/2/weeks/1/events

API Parameter	Python	Pattern	Required	Nullable	Description
season	season		Y		season path parameter.
season_type	season_type		Y		season_type path parameter.
week	week		Y		week path parameter.
limit	limit			Y	Maximum number of items to return.

Returns

return_parsed=True (default) — a tidy polars.DataFrame (parser: parse_items); pass return_as_pandas=True for a pandas.DataFrame. return_parsed=False — the raw JSON Dict payload, unparsed.

Example

espn_nhl_season_week_games(season=2024, season_type=2, week=1)

Last validated n/a.

espn_nhl_season_teams

ESPN endpoint.

Endpoint URL: GET https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/seasons/{season}/teams

Valid URL: https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/seasons/2024/teams

API Parameter	Python	Pattern	Required	Nullable	Description
season	season		Y		season path parameter.
limit	limit			Y	Maximum number of items to return.

Returns

return_parsed=True (default) — a tidy polars.DataFrame (parser: parse_items); pass return_as_pandas=True for a pandas.DataFrame. return_parsed=False — the raw JSON Dict payload, unparsed.

Example

espn_nhl_season_teams(season=2024)

Last validated n/a.

espn_nhl_season_team

ESPN endpoint.

Endpoint URL: GET https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/seasons/{season}/teams/{team_id}

Valid URL: https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/seasons/2024/teams/4

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

Returns

return_parsed=True (default) — a tidy polars.DataFrame (parser: parse_single_entity); pass return_as_pandas=True for a pandas.DataFrame. return_parsed=False — the raw JSON Dict payload, unparsed.

Example

espn_nhl_season_team(season=2024, team_id='4')

Last validated n/a.

espn_nhl_season_players

ESPN endpoint.

Endpoint URL: GET https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/seasons/{season}/athletes

Valid URL: https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/seasons/2024/athletes

API Parameter	Python	Pattern	Required	Nullable	Description
season	season		Y		season path parameter.
limit	limit			Y	Maximum number of items to return.
page	page			Y	page query parameter.

Returns

return_parsed=True (default) — a tidy polars.DataFrame (parser: parse_items); pass return_as_pandas=True for a pandas.DataFrame. return_parsed=False — the raw JSON Dict payload, unparsed.

Example

espn_nhl_season_players(season=2024)

Last validated n/a.

espn_nhl_season_coaches

ESPN endpoint.

Endpoint URL: GET https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/seasons/{season}/coaches

Valid URL: https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/seasons/2024/coaches

API Parameter	Python	Pattern	Required	Nullable	Description
season	season		Y		season path parameter.
limit	limit			Y	Maximum number of items to return.

Returns

return_parsed=True (default) — a tidy polars.DataFrame (parser: parse_coaches); pass return_as_pandas=True for a pandas.DataFrame. return_parsed=False — the raw JSON Dict payload, unparsed.

Example

espn_nhl_season_coaches(season=2024)

Last validated n/a.

espn_nhl_season_draft

ESPN endpoint.

Endpoint URL: GET https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/seasons/{season}/draft

Valid URL: https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/seasons/2024/draft

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

Returns

return_parsed=True (default) — a tidy polars.DataFrame (parser: parse_draft); pass return_as_pandas=True for a pandas.DataFrame. return_parsed=False — the raw JSON Dict payload, unparsed.

Example

espn_nhl_season_draft(season=2024)

Last validated n/a.

espn_nhl_season_draft_round_picks

ESPN endpoint.

Endpoint URL: GET https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/seasons/{season}/draft/rounds/{round_num}/picks

Valid URL: https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/seasons/2024/draft/rounds/1/picks

API Parameter	Python	Pattern	Required	Nullable	Description
season	season		Y		season path parameter.
round_num	round_num		Y		round_num path parameter.

Returns

return_parsed=True (default) — a tidy polars.DataFrame (parser: parse_items); pass return_as_pandas=True for a pandas.DataFrame. return_parsed=False — the raw JSON Dict payload, unparsed.

Example

espn_nhl_season_draft_round_picks(season=2024, round_num='1')

Last validated n/a.

espn_nhl_season_futures

ESPN endpoint.

Endpoint URL: GET https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/seasons/{season}/futures

Valid URL: https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/seasons/2024/futures

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

Returns

return_parsed=True (default) — a tidy polars.DataFrame (parser: parse_items); pass return_as_pandas=True for a pandas.DataFrame. return_parsed=False — the raw JSON Dict payload, unparsed.

Example

espn_nhl_season_futures(season=2024)

Last validated n/a.

espn_nhl_season_freeagents

ESPN endpoint.

Endpoint URL: GET https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/seasons/{season}/freeagents

Valid URL: https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/seasons/2024/freeagents

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

Returns

return_parsed=True (default) — a tidy polars.DataFrame (parser: parse_items); pass return_as_pandas=True for a pandas.DataFrame. return_parsed=False — the raw JSON Dict payload, unparsed.

Example

espn_nhl_season_freeagents(season=2024)

Last validated n/a.

espn_nhl_season_powerindex

ESPN endpoint.

Endpoint URL: GET https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/seasons/{season}/powerindex[/{team_id}]

Valid URL: https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/seasons/2024/powerindex

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

Returns

return_parsed=True (default) — a tidy polars.DataFrame (parser: parse_items); pass return_as_pandas=True for a pandas.DataFrame. return_parsed=False — the raw JSON Dict payload, unparsed.

Example

espn_nhl_season_powerindex(season=2024)

Last validated n/a.

espn_nhl_season_powerindex_leaders

ESPN endpoint.

Endpoint URL: GET https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/seasons/{season}/powerindex/leaders

Valid URL: https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/seasons/2024/powerindex/leaders

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

Returns

return_parsed=True (default) — a tidy polars.DataFrame (parser: parse_items); pass return_as_pandas=True for a pandas.DataFrame. return_parsed=False — the raw JSON Dict payload, unparsed.

Example

espn_nhl_season_powerindex_leaders(season=2024)

Last validated n/a.

espn_nhl_season_awards

ESPN endpoint.

Endpoint URL: GET https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/seasons/{season}/awards

Valid URL: https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/seasons/2024/awards

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

Returns

return_parsed=True (default) — a tidy polars.DataFrame (parser: parse_items); pass return_as_pandas=True for a pandas.DataFrame. return_parsed=False — the raw JSON Dict payload, unparsed.

Example

espn_nhl_season_awards(season=2024)

Last validated n/a.

espn_nhl_players_index

ESPN endpoint.

Endpoint URL: GET https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/athletes

Valid URL: https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/athletes

API Parameter	Python	Pattern	Required	Nullable	Description
active	active			Y	active query parameter.
limit	limit			Y	Maximum number of items to return.
page	page			Y	page query parameter.

Returns

return_parsed=True (default) — a tidy polars.DataFrame (parser: parse_items); pass return_as_pandas=True for a pandas.DataFrame. return_parsed=False — the raw JSON Dict payload, unparsed.

Example

espn_nhl_players_index()

Last validated n/a.

espn_nhl_player_core

ESPN endpoint.

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

Valid URL: https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/athletes/4239

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

Returns

return_parsed=True (default) — a tidy polars.DataFrame (parser: parse_single_entity); pass return_as_pandas=True for a pandas.DataFrame. return_parsed=False — the raw JSON Dict payload, unparsed.

Example

espn_nhl_player_core(athlete_id='4239')

Last validated n/a.

espn_nhl_player_career_stats

ESPN endpoint.

Endpoint URL: GET https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/athletes/{athlete_id}/statistics[/{stat_type}]

Valid URL: https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/athletes/4239/statistics

API Parameter	Python	Pattern	Required	Nullable	Description
athlete_id	athlete_id		Y		athlete_id path parameter.
stat_type	stat_type			Y	stat_type path parameter.

Returns

return_parsed=True (default) — a tidy polars.DataFrame (parser: parse_items); pass return_as_pandas=True for a pandas.DataFrame. return_parsed=False — the raw JSON Dict payload, unparsed.

Example

espn_nhl_player_career_stats(athlete_id='4239')

Last validated n/a.

espn_nhl_player_statisticslog

ESPN endpoint.

Endpoint URL: GET https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/athletes/{athlete_id}/statisticslog

Valid URL: https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/athletes/4239/statisticslog

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

Returns

return_parsed=True (default) — a tidy polars.DataFrame (parser: parse_items); pass return_as_pandas=True for a pandas.DataFrame. return_parsed=False — the raw JSON Dict payload, unparsed.

Example

espn_nhl_player_statisticslog(athlete_id='4239')

Last validated n/a.

espn_nhl_player_eventlog

ESPN endpoint.

Endpoint URL: GET https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/athletes/{athlete_id}/eventlog

Valid URL: https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/athletes/4239/eventlog

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

Returns

return_parsed=True (default) — a tidy polars.DataFrame (parser: parse_items); pass return_as_pandas=True for a pandas.DataFrame. return_parsed=False — the raw JSON Dict payload, unparsed.

Example

espn_nhl_player_eventlog(athlete_id='4239')

Last validated n/a.

espn_nhl_player_contracts

ESPN endpoint.

Endpoint URL: GET https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/athletes/{athlete_id}/contracts

Valid URL: https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/athletes/4239/contracts

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

Returns

return_parsed=True (default) — a tidy polars.DataFrame (parser: parse_items); pass return_as_pandas=True for a pandas.DataFrame. return_parsed=False — the raw JSON Dict payload, unparsed.

Example

espn_nhl_player_contracts(athlete_id='4239')

Last validated n/a.

espn_nhl_player_awards

ESPN endpoint.

Endpoint URL: GET https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/athletes/{athlete_id}/awards

Valid URL: https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/athletes/4239/awards

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

Returns

return_parsed=True (default) — a tidy polars.DataFrame (parser: parse_items); pass return_as_pandas=True for a pandas.DataFrame. return_parsed=False — the raw JSON Dict payload, unparsed.

Example

espn_nhl_player_awards(athlete_id='4239')

Last validated n/a.

espn_nhl_player_seasons

ESPN endpoint.

Endpoint URL: GET https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/athletes/{athlete_id}/seasons

Valid URL: https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/athletes/4239/seasons

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

Returns

return_parsed=True (default) — a tidy polars.DataFrame (parser: parse_items); pass return_as_pandas=True for a pandas.DataFrame. return_parsed=False — the raw JSON Dict payload, unparsed.

Example

espn_nhl_player_seasons(athlete_id='4239')

Last validated n/a.

espn_nhl_player_records

ESPN endpoint.

Endpoint URL: GET https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/athletes/{athlete_id}/records

Valid URL: https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/athletes/4239/records

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

Returns

return_parsed=True (default) — a tidy polars.DataFrame (parser: parse_items); pass return_as_pandas=True for a pandas.DataFrame. return_parsed=False — the raw JSON Dict payload, unparsed.

Example

espn_nhl_player_records(athlete_id='4239')

Last validated n/a.

espn_nhl_player_injuries

ESPN endpoint.

Endpoint URL: GET https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/athletes/{athlete_id}/injuries

Valid URL: https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/athletes/4239/injuries

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

Returns

return_parsed=True (default) — a tidy polars.DataFrame (parser: parse_injuries); pass return_as_pandas=True for a pandas.DataFrame. return_parsed=False — the raw JSON Dict payload, unparsed.

Example

espn_nhl_player_injuries(athlete_id='4239')

Last validated n/a.

espn_nhl_player_notes

ESPN endpoint.

Endpoint URL: GET https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/athletes/{athlete_id}/notes

Valid URL: https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/athletes/4239/notes

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

Returns

return_parsed=True (default) — a tidy polars.DataFrame (parser: parse_items); pass return_as_pandas=True for a pandas.DataFrame. return_parsed=False — the raw JSON Dict payload, unparsed.

Example

espn_nhl_player_notes(athlete_id='4239')

Last validated n/a.

espn_nhl_player_vs_player

ESPN endpoint.

Endpoint URL: GET https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/athletes/{athlete_id}/vsathlete/{opp_id}

Valid URL: https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/athletes/4239/vsathlete/5

API Parameter	Python	Pattern	Required	Nullable	Description
athlete_id	athlete_id		Y		athlete_id path parameter.
opp_id	opp_id		Y		opp_id path parameter.

Returns

return_parsed=True (default) — a tidy polars.DataFrame (parser: parse_single_entity); pass return_as_pandas=True for a pandas.DataFrame. return_parsed=False — the raw JSON Dict payload, unparsed.

Example

espn_nhl_player_vs_player(athlete_id='4239', opp_id='5')

Last validated n/a.

espn_nhl_games

ESPN endpoint.

Endpoint URL: GET https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/events

Valid URL: https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/events

API Parameter	Python	Pattern	Required	Nullable	Description
dates	dates			Y	Date or date range filter (YYYYMMDD or YYYYMMDD-YYYYMMDD).
limit	limit			Y	Maximum number of items to return.

Returns

return_parsed=True (default) — a tidy polars.DataFrame (parser: parse_items); pass return_as_pandas=True for a pandas.DataFrame. return_parsed=False — the raw JSON Dict payload, unparsed.

Example

espn_nhl_games()

Last validated n/a.

espn_nhl_game

ESPN endpoint.

Endpoint URL: GET https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/events/{event_id}

Valid URL: https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/events/401584793

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

Returns

return_parsed=True (default) — a tidy polars.DataFrame (parser: parse_single_entity); pass return_as_pandas=True for a pandas.DataFrame. return_parsed=False — the raw JSON Dict payload, unparsed.

Example

espn_nhl_game(event_id='401584793')

Last validated n/a.

espn_nhl_game_competition

ESPN endpoint.

Endpoint URL: GET https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/events/{event_id}/competitions/{cid}

Valid URL: https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/events/401584793/competitions

API Parameter	Python	Pattern	Required	Nullable	Description
event_id	event_id		Y		event_id path parameter.
cid	cid			Y	cid path parameter.

Returns

return_parsed=True (default) — a tidy polars.DataFrame (parser: parse_single_entity); pass return_as_pandas=True for a pandas.DataFrame. return_parsed=False — the raw JSON Dict payload, unparsed.

Example

espn_nhl_game_competition(event_id='401584793')

Last validated n/a.

espn_nhl_game_teams

ESPN endpoint.

Endpoint URL: GET https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/events/{event_id}/competitions/{cid}/competitors

Valid URL: https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/events/401584793/competitions

API Parameter	Python	Pattern	Required	Nullable	Description
event_id	event_id		Y		event_id path parameter.
cid	cid			Y	cid path parameter.

Returns

return_parsed=True (default) — a tidy polars.DataFrame (parser: parse_items); pass return_as_pandas=True for a pandas.DataFrame. return_parsed=False — the raw JSON Dict payload, unparsed.

Example

espn_nhl_game_teams(event_id='401584793')

Last validated n/a.

espn_nhl_game_team

ESPN endpoint.

Endpoint URL: GET https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/events/{event_id}/competitions/{cid}/competitors/{team_id}

Valid URL: https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/events/401584793/competitions

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

Returns

return_parsed=True (default) — a tidy polars.DataFrame (parser: parse_single_entity); pass return_as_pandas=True for a pandas.DataFrame. return_parsed=False — the raw JSON Dict payload, unparsed.

Example

espn_nhl_game_team(event_id='401584793', team_id='4')

Last validated n/a.

espn_nhl_game_team_roster

ESPN endpoint.

Endpoint URL: GET https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/events/{event_id}/competitions/{cid}/competitors/{team_id}/roster

Valid URL: https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/events/401584793/competitions

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

Returns

return_parsed=True (default) — a tidy polars.DataFrame (parser: parse_event_competitor_roster); pass return_as_pandas=True for a pandas.DataFrame. return_parsed=False — the raw JSON Dict payload, unparsed.

Example

espn_nhl_game_team_roster(event_id='401584793', team_id='4')

Last validated n/a.

espn_nhl_game_team_linescores

ESPN endpoint.

Endpoint URL: GET https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/events/{event_id}/competitions/{cid}/competitors/{team_id}/linescores

Valid URL: https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/events/401584793/competitions

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

Returns

return_parsed=True (default) — a tidy polars.DataFrame (parser: parse_event_competitor_linescores); pass return_as_pandas=True for a pandas.DataFrame. return_parsed=False — the raw JSON Dict payload, unparsed.

Example

espn_nhl_game_team_linescores(event_id='401584793', team_id='4')

Last validated n/a.

espn_nhl_game_team_statistics

ESPN endpoint.

Endpoint URL: GET https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/events/{event_id}/competitions/{cid}/competitors/{team_id}/statistics

Valid URL: https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/events/401584793/competitions

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

Returns

return_parsed=True (default) — a tidy polars.DataFrame (parser: parse_event_competitor_statistics); pass return_as_pandas=True for a pandas.DataFrame. return_parsed=False — the raw JSON Dict payload, unparsed.

Example

espn_nhl_game_team_statistics(event_id='401584793', team_id='4')

Last validated n/a.

espn_nhl_game_team_record

ESPN endpoint.

Endpoint URL: GET https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/events/{event_id}/competitions/{cid}/competitors/{team_id}/record

Valid URL: https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/events/401584793/competitions

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

Returns

return_parsed=True (default) — a tidy polars.DataFrame (parser: parse_single_entity); pass return_as_pandas=True for a pandas.DataFrame. return_parsed=False — the raw JSON Dict payload, unparsed.

Example

espn_nhl_game_team_record(event_id='401584793', team_id='4')

Last validated n/a.

espn_nhl_game_team_leaders

ESPN endpoint.

Endpoint URL: GET https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/events/{event_id}/competitions/{cid}/competitors/{team_id}/leaders

Valid URL: https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/events/401584793/competitions

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

Returns

return_parsed=True (default) — a tidy polars.DataFrame (parser: parse_items); pass return_as_pandas=True for a pandas.DataFrame. return_parsed=False — the raw JSON Dict payload, unparsed.

Example

espn_nhl_game_team_leaders(event_id='401584793', team_id='4')

Last validated n/a.

espn_nhl_game_odds

ESPN endpoint.

Endpoint URL: GET https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/events/{event_id}/competitions/{cid}/odds

Valid URL: https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/events/401584793/competitions

API Parameter	Python	Pattern	Required	Nullable	Description
event_id	event_id		Y		event_id path parameter.
cid	cid			Y	cid path parameter.

Returns

return_parsed=True (default) — a tidy polars.DataFrame (parser: parse_items); pass return_as_pandas=True for a pandas.DataFrame. return_parsed=False — the raw JSON Dict payload, unparsed.

Example

espn_nhl_game_odds(event_id='401584793')

Last validated n/a.

espn_nhl_game_probabilities

ESPN endpoint.

Endpoint URL: GET https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/events/{event_id}/competitions/{cid}/probabilities

Valid URL: https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/events/401584793/competitions

API Parameter	Python	Pattern	Required	Nullable	Description
event_id	event_id		Y		event_id path parameter.
cid	cid			Y	cid path parameter.
limit	limit			Y	Maximum number of items to return.

Returns

return_parsed=True (default) — a tidy polars.DataFrame (parser: parse_items); pass return_as_pandas=True for a pandas.DataFrame. return_parsed=False — the raw JSON Dict payload, unparsed.

Example

espn_nhl_game_probabilities(event_id='401584793')

Last validated n/a.

espn_nhl_game_plays

ESPN endpoint.

Endpoint URL: GET https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/events/{event_id}/competitions/{cid}/plays

Valid URL: https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/events/401584793/competitions

API Parameter	Python	Pattern	Required	Nullable	Description
event_id	event_id		Y		event_id path parameter.
cid	cid			Y	cid path parameter.
limit	limit			Y	Maximum number of items to return.

Returns

return_parsed=True (default) — a tidy polars.DataFrame (parser: parse_event_plays); pass return_as_pandas=True for a pandas.DataFrame. return_parsed=False — the raw JSON Dict payload, unparsed.

Example

espn_nhl_game_plays(event_id='401584793')

Last validated n/a.

espn_nhl_game_play

ESPN endpoint.

Endpoint URL: GET https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/events/{event_id}/competitions/{cid}/plays/{play_id}

Valid URL: https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/events/401584793/competitions

API Parameter	Python	Pattern	Required	Nullable	Description
event_id	event_id		Y		event_id path parameter.
play_id	play_id		Y		play_id path parameter.
cid	cid			Y	cid path parameter.

Returns

return_parsed=True (default) — a tidy polars.DataFrame (parser: parse_single_entity); pass return_as_pandas=True for a pandas.DataFrame. return_parsed=False — the raw JSON Dict payload, unparsed.

Example

espn_nhl_game_play(event_id='401584793', play_id='1')

Last validated n/a.

espn_nhl_game_play_personnel

ESPN endpoint.

Endpoint URL: GET https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/events/{event_id}/competitions/{cid}/plays/{play_id}/personnel

Valid URL: https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/events/401584793/competitions

API Parameter	Python	Pattern	Required	Nullable	Description
event_id	event_id		Y		event_id path parameter.
play_id	play_id		Y		play_id path parameter.
cid	cid			Y	cid path parameter.

Returns

return_parsed=True (default) — a tidy polars.DataFrame (parser: parse_items); pass return_as_pandas=True for a pandas.DataFrame. return_parsed=False — the raw JSON Dict payload, unparsed.

Example

espn_nhl_game_play_personnel(event_id='401584793', play_id='1')

Last validated n/a.

espn_nhl_game_situation

ESPN endpoint.

Endpoint URL: GET https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/events/{event_id}/competitions/{cid}/situation

Valid URL: https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/events/401584793/competitions

API Parameter	Python	Pattern	Required	Nullable	Description
event_id	event_id		Y		event_id path parameter.
cid	cid			Y	cid path parameter.

Returns

return_parsed=True (default) — a tidy polars.DataFrame (parser: parse_single_entity); pass return_as_pandas=True for a pandas.DataFrame. return_parsed=False — the raw JSON Dict payload, unparsed.

Example

espn_nhl_game_situation(event_id='401584793')

Last validated n/a.

espn_nhl_game_status

ESPN endpoint.

Endpoint URL: GET https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/events/{event_id}/competitions/{cid}/status

Valid URL: https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/events/401584793/competitions

API Parameter	Python	Pattern	Required	Nullable	Description
event_id	event_id		Y		event_id path parameter.
cid	cid			Y	cid path parameter.

Returns

return_parsed=True (default) — a tidy polars.DataFrame (parser: parse_single_entity); pass return_as_pandas=True for a pandas.DataFrame. return_parsed=False — the raw JSON Dict payload, unparsed.

Example

espn_nhl_game_status(event_id='401584793')

Last validated n/a.

espn_nhl_game_officials

ESPN endpoint.

Endpoint URL: GET https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/events/{event_id}/competitions/{cid}/officials

Valid URL: https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/events/401584793/competitions

API Parameter	Python	Pattern	Required	Nullable	Description
event_id	event_id		Y		event_id path parameter.
cid	cid			Y	cid path parameter.

Returns

return_parsed=True (default) — a tidy polars.DataFrame (parser: parse_items); pass return_as_pandas=True for a pandas.DataFrame. return_parsed=False — the raw JSON Dict payload, unparsed.

Example

espn_nhl_game_officials(event_id='401584793')

Last validated n/a.

espn_nhl_game_broadcasts

ESPN endpoint.

Endpoint URL: GET https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/events/{event_id}/competitions/{cid}/broadcasts

Valid URL: https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/events/401584793/competitions

API Parameter	Python	Pattern	Required	Nullable	Description
event_id	event_id		Y		event_id path parameter.
cid	cid			Y	cid path parameter.

Returns

return_parsed=True (default) — a tidy polars.DataFrame (parser: parse_items); pass return_as_pandas=True for a pandas.DataFrame. return_parsed=False — the raw JSON Dict payload, unparsed.

Example

espn_nhl_game_broadcasts(event_id='401584793')

Last validated n/a.

espn_nhl_game_predictor

ESPN endpoint.

Endpoint URL: GET https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/events/{event_id}/competitions/{cid}/predictor

Valid URL: https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/events/401584793/competitions

API Parameter	Python	Pattern	Required	Nullable	Description
event_id	event_id		Y		event_id path parameter.
cid	cid			Y	cid path parameter.

Returns

return_parsed=True (default) — a tidy polars.DataFrame (parser: parse_single_entity); pass return_as_pandas=True for a pandas.DataFrame. return_parsed=False — the raw JSON Dict payload, unparsed.

Example

espn_nhl_game_predictor(event_id='401584793')

Last validated n/a.

espn_nhl_game_powerindex

ESPN endpoint.

Endpoint URL: GET https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/events/{event_id}/competitions/{cid}/powerindex

Valid URL: https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/events/401584793/competitions

API Parameter	Python	Pattern	Required	Nullable	Description
event_id	event_id		Y		event_id path parameter.
cid	cid			Y	cid path parameter.

Returns

return_parsed=True (default) — a tidy polars.DataFrame (parser: parse_single_entity); pass return_as_pandas=True for a pandas.DataFrame. return_parsed=False — the raw JSON Dict payload, unparsed.

Example

espn_nhl_game_powerindex(event_id='401584793')

Last validated n/a.

espn_nhl_game_propbets

ESPN endpoint.

Endpoint URL: GET https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/events/{event_id}/competitions/{cid}/propbets

Valid URL: https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/events/401584793/competitions

API Parameter	Python	Pattern	Required	Nullable	Description
event_id	event_id		Y		event_id path parameter.
cid	cid			Y	cid path parameter.

Returns

return_parsed=True (default) — a tidy polars.DataFrame (parser: parse_items); pass return_as_pandas=True for a pandas.DataFrame. return_parsed=False — the raw JSON Dict payload, unparsed.

Example

espn_nhl_game_propbets(event_id='401584793')

Last validated n/a.

espn_nhl_game_leaders

ESPN endpoint.

Endpoint URL: GET https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/events/{event_id}/competitions/{cid}/leaders

Valid URL: https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/events/401584793/competitions

API Parameter	Python	Pattern	Required	Nullable	Description
event_id	event_id		Y		event_id path parameter.
cid	cid			Y	cid path parameter.

Returns

return_parsed=True (default) — a tidy polars.DataFrame (parser: parse_items); pass return_as_pandas=True for a pandas.DataFrame. return_parsed=False — the raw JSON Dict payload, unparsed.

Example

espn_nhl_game_leaders(event_id='401584793')

Last validated n/a.

espn_nhl_game_scoringplays

ESPN endpoint.

Endpoint URL: GET https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/events/{event_id}/competitions/{cid}/scoringplays

Valid URL: https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/events/401584793/competitions

API Parameter	Python	Pattern	Required	Nullable	Description
event_id	event_id		Y		event_id path parameter.
cid	cid			Y	cid path parameter.

Returns

return_parsed=True (default) — a tidy polars.DataFrame (parser: parse_items); pass return_as_pandas=True for a pandas.DataFrame. return_parsed=False — the raw JSON Dict payload, unparsed.

Example

espn_nhl_game_scoringplays(event_id='401584793')

Last validated n/a.

espn_nhl_game_official_detail

ESPN endpoint.

Endpoint URL: GET https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/events/{event_id}/competitions/{cid}/officials/{official_id}

Valid URL: https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/events/401584793/competitions

API Parameter	Python	Pattern	Required	Nullable	Description
event_id	event_id		Y		event_id path parameter.
official_id	official_id		Y		official_id path parameter.
cid	cid			Y	cid path parameter.

Returns

return_parsed=True (default) — a tidy polars.DataFrame (parser: parse_single_entity); pass return_as_pandas=True for a pandas.DataFrame. return_parsed=False — the raw JSON Dict payload, unparsed.

Example

espn_nhl_game_official_detail(event_id='401584793', official_id='1')

Last validated n/a.

espn_nhl_teams_core

ESPN endpoint.

Endpoint URL: GET https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/teams

Valid URL: https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/teams

API Parameter	Python	Pattern	Required	Nullable	Description
limit	limit			Y	Maximum number of items to return.

Returns

return_parsed=True (default) — a tidy polars.DataFrame with the columns below; pass return_as_pandas=True for a pandas.DataFrame.

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).

return_parsed=False — the raw JSON Dict payload, unparsed.

Example

espn_nhl_teams_core()

Last validated n/a.

espn_nhl_team_core

ESPN endpoint.

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

Valid URL: https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/teams/4

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

Returns

return_parsed=True (default) — a tidy polars.DataFrame (parser: parse_single_entity); pass return_as_pandas=True for a pandas.DataFrame. return_parsed=False — the raw JSON Dict payload, unparsed.

Example

espn_nhl_team_core(team_id='4')

Last validated n/a.

espn_nhl_venues

ESPN endpoint.

Endpoint URL: GET https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/venues

Valid URL: https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/venues

API Parameter	Python	Pattern	Required	Nullable	Description
limit	limit			Y	Maximum number of items to return.

Returns

return_parsed=True (default) — a tidy polars.DataFrame (parser: parse_items); pass return_as_pandas=True for a pandas.DataFrame. return_parsed=False — the raw JSON Dict payload, unparsed.

Example

espn_nhl_venues()

Last validated n/a.

espn_nhl_venue

ESPN endpoint.

Endpoint URL: GET https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/venues/{venue_id}

Valid URL: https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/venues/3663

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

Returns

return_parsed=True (default) — a tidy polars.DataFrame (parser: parse_single_entity); pass return_as_pandas=True for a pandas.DataFrame. return_parsed=False — the raw JSON Dict payload, unparsed.

Example

espn_nhl_venue(venue_id='3663')

Last validated n/a.

espn_nhl_franchises

ESPN endpoint.

Endpoint URL: GET https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/franchises

Valid URL: https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/franchises

API Parameter	Python	Pattern	Required	Nullable	Description
limit	limit			Y	Maximum number of items to return.

Returns

return_parsed=True (default) — a tidy polars.DataFrame (parser: parse_items); pass return_as_pandas=True for a pandas.DataFrame. return_parsed=False — the raw JSON Dict payload, unparsed.

Example

espn_nhl_franchises()

Last validated n/a.

espn_nhl_franchise

ESPN endpoint.

Endpoint URL: GET https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/franchises/{franchise_id}

Valid URL: https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/franchises/2

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

Returns

return_parsed=True (default) — a tidy polars.DataFrame (parser: parse_single_entity); pass return_as_pandas=True for a pandas.DataFrame. return_parsed=False — the raw JSON Dict payload, unparsed.

Example

espn_nhl_franchise(franchise_id='2')

Last validated n/a.

espn_nhl_coach

ESPN endpoint.

Endpoint URL: GET https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/coaches/{coach_id}

Valid URL: https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/coaches/1

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

Returns

return_parsed=True (default) — a tidy polars.DataFrame (parser: parse_single_entity); pass return_as_pandas=True for a pandas.DataFrame. return_parsed=False — the raw JSON Dict payload, unparsed.

Example

espn_nhl_coach(coach_id='1')

Last validated n/a.

espn_nhl_coach_record

ESPN endpoint.

Endpoint URL: GET https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/coaches/{coach_id}/record/{record_type}

Valid URL: https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/coaches/1/record

API Parameter	Python	Pattern	Required	Nullable	Description
coach_id	coach_id		Y		coach_id path parameter.
record_type	record_type			Y	record_type path parameter.

Returns

return_parsed=True (default) — a tidy polars.DataFrame (parser: parse_single_entity); pass return_as_pandas=True for a pandas.DataFrame. return_parsed=False — the raw JSON Dict payload, unparsed.

Example

espn_nhl_coach_record(coach_id='1')

Last validated n/a.

espn_nhl_coach_season

ESPN endpoint.

Endpoint URL: GET https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/coaches/{coach_id}/seasons/{season}

Valid URL: https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/coaches/1/seasons/2024

API Parameter	Python	Pattern	Required	Nullable	Description
coach_id	coach_id		Y		coach_id path parameter.
season	season		Y		season path parameter.

Returns

return_parsed=True (default) — a tidy polars.DataFrame (parser: parse_single_entity); pass return_as_pandas=True for a pandas.DataFrame. return_parsed=False — the raw JSON Dict payload, unparsed.

Example

espn_nhl_coach_season(coach_id='1', season=2024)

Last validated n/a.

espn_nhl_positions

ESPN endpoint.

Endpoint URL: GET https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/positions

Valid URL: https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/positions

API Parameter	Python	Pattern	Required	Nullable	Description

Returns

return_parsed=True (default) — a tidy polars.DataFrame (parser: parse_items); pass return_as_pandas=True for a pandas.DataFrame. return_parsed=False — the raw JSON Dict payload, unparsed.

Example

espn_nhl_positions()

Last validated n/a.

espn_nhl_position

ESPN endpoint.

Endpoint URL: GET https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/positions/{position_id}

Valid URL: https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/positions/1

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

Returns

return_parsed=True (default) — a tidy polars.DataFrame (parser: parse_single_entity); pass return_as_pandas=True for a pandas.DataFrame. return_parsed=False — the raw JSON Dict payload, unparsed.

Example

espn_nhl_position(position_id='1')

Last validated n/a.

espn_nhl_tournaments

ESPN endpoint.

Endpoint URL: GET https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/tournaments

Valid URL: https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/tournaments

API Parameter	Python	Pattern	Required	Nullable	Description

Returns

return_parsed=True (default) — a tidy polars.DataFrame (parser: parse_items); pass return_as_pandas=True for a pandas.DataFrame. return_parsed=False — the raw JSON Dict payload, unparsed.

Example

espn_nhl_tournaments()

Last validated n/a.

espn_nhl_awards

ESPN endpoint.

Endpoint URL: GET https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/awards

Valid URL: https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/awards

API Parameter	Python	Pattern	Required	Nullable	Description

Returns

return_parsed=True (default) — a tidy polars.DataFrame (parser: parse_items); pass return_as_pandas=True for a pandas.DataFrame. return_parsed=False — the raw JSON Dict payload, unparsed.

Example

espn_nhl_awards()

Last validated n/a.

espn_nhl_award

ESPN endpoint.

Endpoint URL: GET https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/awards/{award_id}

Valid URL: https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/awards/1

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

Returns

return_parsed=True (default) — a tidy polars.DataFrame (parser: parse_single_entity); pass return_as_pandas=True for a pandas.DataFrame. return_parsed=False — the raw JSON Dict payload, unparsed.

Example

espn_nhl_award(award_id='1')

Last validated n/a.

espn_nhl_standings_core

ESPN endpoint.

Endpoint URL: GET https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/standings

Valid URL: https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/standings

API Parameter	Python	Pattern	Required	Nullable	Description

Returns

return_parsed=True (default) — a tidy polars.DataFrame with the columns below; pass return_as_pandas=True for a pandas.DataFrame.

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	Overtime losses.
clincher	double	Clincher.
differential	double	Differential.
games_behind	double	Games behind.
games_played	double	Games played.
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	Total overtime losses.
overtime_wins	double	Overtime wins.
points_diff	double
reg_losses	double
reg_wins	double
rot_losses	double
rot_wins	double
shootout_losses	double	Shootout losses.
shootout_wins	double	Shootout wins.
overall	character	Overall.
home	character	Home.
road	character	Road.
last ten games	character	Last ten games.
vs. div.	character	Vs. div..

return_parsed=False — the raw JSON Dict payload, unparsed.

Example

espn_nhl_standings_core()

Last validated n/a.

espn_nhl_leaders_core

ESPN endpoint.

Endpoint URL: GET https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/leaders

Valid URL: https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/leaders

API Parameter	Python	Pattern	Required	Nullable	Description

Returns

return_parsed=True (default) — a tidy polars.DataFrame (parser: parse_items); pass return_as_pandas=True for a pandas.DataFrame. return_parsed=False — the raw JSON Dict payload, unparsed.

Example

espn_nhl_leaders_core()

Last validated n/a.

espn_nhl_league_notes

ESPN endpoint.

Endpoint URL: GET https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/notes

Valid URL: https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/notes

API Parameter	Python	Pattern	Required	Nullable	Description

Returns

return_parsed=True (default) — a tidy polars.DataFrame (parser: parse_items); pass return_as_pandas=True for a pandas.DataFrame. return_parsed=False — the raw JSON Dict payload, unparsed.

Example

espn_nhl_league_notes()

Last validated n/a.

espn_nhl_talentpicks

ESPN endpoint.

Endpoint URL: GET https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/talentpicks

Valid URL: https://sports.core.api.espn.com/v2/sports/hockey/leagues/nhl/talentpicks

API Parameter	Python	Pattern	Required	Nullable	Description

Returns

return_parsed=True (default) — a tidy polars.DataFrame (parser: parse_items); pass return_as_pandas=True for a pandas.DataFrame. return_parsed=False — the raw JSON Dict payload, unparsed.

Example

espn_nhl_talentpicks()

Last validated n/a.