NHL — NHL Web API — Player
nhl_player_landing
Pull the player profile / overview.
Endpoint URL: GET https://api-web.nhle.com/v1/player/{player_id}/landing
Valid URL: https://api-web.nhle.com/v1/player/8480801/landing
| API Parameter | Python | Pattern | Required | Nullable | Description |
|---|---|---|---|---|---|
player_id | player_id | Y | player_id path parameter. |
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 |
|---|---|---|
player_id | integer | Unique player identifier. |
is_active | logical | Whether the team is active. |
current_team_id | integer | Player's current team identifier. |
current_team_abbrev | character | Three-letter abbreviation of the NHL team the player is currently rostered on (e.g., 'TOR', 'BOS'). |
badges | character | Serialized list of achievement or milestone badges displayed on the player's NHL api-web profile page. |
team_logo | character | URL to the team logo image. |
sweater_number | integer | Jersey number. |
position | character | Player position. |
headshot | character | URL to the player headshot image. |
hero_image | character | URL to the large hero/banner image of the player displayed at the top of their NHL api-web profile page. |
height_in_inches | integer | Height in inches. |
height_in_centimeters | integer | Height in centimeters. |
weight_in_pounds | integer | Weight in pounds. |
weight_in_kilograms | integer | Weight in kilograms. |
birth_date | character | Player birth date. |
birth_country | character | Player birth country. |
shoots_catches | character | Handedness (shoots/catches). |
player_slug | character | URL slug for the player. |
in_top100_all_time | integer | Flag (1/0) indicating whether the player is recognized among the NHL's Top 100 all-time greatest players. |
in_hhof | integer | Flag (1/0) indicating whether the player has been inducted into the Hockey Hall of Fame. |
shop_link | character | URL to the NHL shop page where merchandise for this player (e.g., jerseys) can be purchased. |
twitter_link | character | URL to the player's official Twitter/X account as listed on their NHL api-web profile. |
watch_link | character | URL to the NHL.tv or league streaming page where the player's games can be watched. |
last5_games | character | Serialized array of stat lines for the player's five most recent NHL games, as returned by the player landing endpoint. |
season_totals | character | Serialized array of per-season stat totals for the player across all regular seasons and playoffs in their NHL career. |
awards | character | Serialized list of NHL awards and honors the player has received, as returned by the NHL api-web player landing endpoint. |
current_team_roster | character | Serialized roster-position metadata for the player's current NHL team assignment, as returned by the player landing endpoint. |
full_team_name_default | character | Full English name of the player's current NHL team (e.g., 'Toronto Maple Leafs'), as returned by the player landing endpoint. |
full_team_name_fr | character | Full French-language name of the player's current NHL team, as returned by the player landing endpoint. |
team_common_name_default | character | Team common name (default language). |
team_place_name_with_preposition_default | character | Team place name with preposition (default). |
team_place_name_with_preposition_fr | character | Team place name with preposition (French). |
first_name_default | character | Player first name (default language). |
last_name_default | character | Player last name (default language). |
birth_city_default | character | Birth city (default localization). |
birth_state_province_default | character | Birth state/province (default localization). |
draft_details_year | integer | Calendar year in which the player was selected in the NHL Entry Draft. |
draft_details_team_abbrev | character | Three-letter abbreviation of the NHL team that drafted the player in the Entry Draft. |
draft_details_round | integer | Round number in which the player was selected during the NHL Entry Draft. |
draft_details_pick_in_round | integer | Pick number within the player's draft round in the NHL Entry Draft. |
draft_details_overall_pick | integer | Overall pick number at which the player was selected in the NHL Entry Draft. |
featured_stats_season | integer | Eight-digit NHL season identifier (e.g., 20232024) indicating which season the featured stats on the player's profile correspond to. |
featured_stats_regular_season_sub_season_assists | integer | Assists recorded by the player in the featured regular-season sub-season (typically the current or most recent season) on their NHL api-web profile. |
featured_stats_regular_season_sub_season_game_winning_goals | integer | Game-winning goals recorded by the player in the featured regular-season sub-season on their NHL api-web profile. |
featured_stats_regular_season_sub_season_games_played | integer | Games played by the player in the featured regular-season sub-season (typically the current or most recent season) on their NHL api-web profile. |
featured_stats_regular_season_sub_season_goals | integer | Goals scored by the player in the featured regular-season sub-season (typically the current or most recent season) on their NHL api-web profile. |
featured_stats_regular_season_sub_season_ot_goals | integer | Overtime goals scored by the player in the featured regular-season sub-season on their NHL api-web profile. |
featured_stats_regular_season_sub_season_pim | integer | Penalty minutes accumulated by the player in the featured regular-season sub-season on their NHL api-web profile. |
featured_stats_regular_season_sub_season_plus_minus | integer | Plus/minus rating for the player in the featured regular-season sub-season on their NHL api-web profile. |
featured_stats_regular_season_sub_season_points | integer | Points (goals + assists) recorded by the player in the featured regular-season sub-season on their NHL api-web profile. |
featured_stats_regular_season_sub_season_power_play_goals | integer | Power-play goals scored by the player in the featured regular-season sub-season on their NHL api-web profile. |
featured_stats_regular_season_sub_season_power_play_points | integer | Power-play points accumulated by the player in the featured regular-season sub-season on their NHL api-web profile. |
featured_stats_regular_season_sub_season_shooting_pctg | double | Shooting percentage for the player in the featured regular-season sub-season on their NHL api-web profile, expressed as a decimal. |
featured_stats_regular_season_sub_season_shorthanded_goals | integer | Shorthanded goals scored by the player in the featured regular-season sub-season on their NHL api-web profile. |
featured_stats_regular_season_sub_season_shorthanded_points | integer | Shorthanded points accumulated by the player in the featured regular-season sub-season on their NHL api-web profile. |
featured_stats_regular_season_sub_season_shots | integer | Shots on goal taken by the player in the featured regular-season sub-season on their NHL api-web profile. |
featured_stats_regular_season_career_assists | integer | Career regular-season assists highlighted on the player's NHL api-web profile for the featured season context. |
featured_stats_regular_season_career_game_winning_goals | integer | Career regular-season game-winning goals highlighted on the player's NHL api-web profile for the featured season context. |
featured_stats_regular_season_career_games_played | integer | Career regular-season games played highlighted on the player's NHL api-web profile for the featured season context. |
featured_stats_regular_season_career_goals | integer | Career regular-season goals highlighted on the player's NHL api-web profile for the featured season context. |
featured_stats_regular_season_career_ot_goals | integer | Career regular-season overtime goals highlighted on the player's NHL api-web profile for the featured season context. |
featured_stats_regular_season_career_pim | integer | Career regular-season penalty minutes highlighted on the player's NHL api-web profile for the featured season context. |
featured_stats_regular_season_career_plus_minus | integer | Career regular-season plus/minus rating highlighted on the player's NHL api-web profile for the featured season context. |
featured_stats_regular_season_career_points | integer | Career regular-season points highlighted on the player's NHL api-web profile for the featured season context. |
featured_stats_regular_season_career_power_play_goals | integer | Career regular-season power-play goals highlighted on the player's NHL api-web profile for the featured season context. |
featured_stats_regular_season_career_power_play_points | integer | Career regular-season power-play points highlighted on the player's NHL api-web profile for the featured season context. |
featured_stats_regular_season_career_shooting_pctg | double | Career regular-season shooting percentage highlighted on the player's NHL api-web profile, expressed as a decimal. |
featured_stats_regular_season_career_shorthanded_goals | integer | Career regular-season shorthanded goals highlighted on the player's NHL api-web profile for the featured season context. |
featured_stats_regular_season_career_shorthanded_points | integer | Career regular-season shorthanded points highlighted on the player's NHL api-web profile for the featured season context. |
featured_stats_regular_season_career_shots | integer | Career regular-season shots on goal highlighted on the player's NHL api-web profile for the featured season context. |
featured_stats_playoffs_sub_season_assists | integer | Assists recorded by the player in the featured playoff sub-season (typically the most recent postseason) on their NHL api-web profile. |
featured_stats_playoffs_sub_season_game_winning_goals | integer | Game-winning goals recorded by the player in the featured playoff sub-season on their NHL api-web profile. |
featured_stats_playoffs_sub_season_games_played | integer | Games played by the player in the featured playoff sub-season (typically the most recent postseason) on their NHL api-web profile. |
featured_stats_playoffs_sub_season_goals | integer | Goals scored by the player in the featured playoff sub-season (typically the most recent postseason) on their NHL api-web profile. |
featured_stats_playoffs_sub_season_ot_goals | integer | Overtime goals scored by the player in the featured playoff sub-season on their NHL api-web profile. |
featured_stats_playoffs_sub_season_pim | integer | Penalty minutes accumulated by the player in the featured playoff sub-season on their NHL api-web profile. |
featured_stats_playoffs_sub_season_plus_minus | integer | Plus/minus rating for the player in the featured playoff sub-season on their NHL api-web profile. |
featured_stats_playoffs_sub_season_points | integer | Points (goals + assists) recorded by the player in the featured playoff sub-season on their NHL api-web profile. |
featured_stats_playoffs_sub_season_power_play_goals | integer | Power-play goals scored by the player in the featured playoff sub-season on their NHL api-web profile. |
featured_stats_playoffs_sub_season_power_play_points | integer | Power-play points accumulated by the player in the featured playoff sub-season on their NHL api-web profile. |
featured_stats_playoffs_sub_season_shooting_pctg | double | Shooting percentage for the player in the featured playoff sub-season on their NHL api-web profile, expressed as a decimal. |
featured_stats_playoffs_sub_season_shorthanded_goals | integer | Shorthanded goals scored by the player in the featured playoff sub-season on their NHL api-web profile. |
featured_stats_playoffs_sub_season_shorthanded_points | integer | Shorthanded points accumulated by the player in the featured playoff sub-season on their NHL api-web profile. |
featured_stats_playoffs_sub_season_shots | integer | Shots on goal taken by the player in the featured playoff sub-season on their NHL api-web profile. |
featured_stats_playoffs_career_assists | integer | Career playoff assists highlighted on the player's NHL api-web profile for the featured season context. |
featured_stats_playoffs_career_game_winning_goals | integer | Career playoff game-winning goals highlighted on the player's NHL api-web profile for the featured season context. |
featured_stats_playoffs_career_games_played | integer | Career playoff games played highlighted on the player's NHL api-web profile for the featured season context. |
featured_stats_playoffs_career_goals | integer | Career playoff goals highlighted on the player's NHL api-web profile for the featured season context. |
featured_stats_playoffs_career_ot_goals | integer | Career playoff overtime goals highlighted on the player's NHL api-web profile for the featured season context. |
featured_stats_playoffs_career_pim | integer | Career playoff penalty minutes highlighted on the player's NHL api-web profile for the featured season context. |
featured_stats_playoffs_career_plus_minus | integer | Career playoff plus/minus rating highlighted on the player's NHL api-web profile for the featured season context. |
featured_stats_playoffs_career_points | integer | Career playoff points highlighted on the player's NHL api-web profile for the featured season context. |
featured_stats_playoffs_career_power_play_goals | integer | Career playoff power-play goals highlighted on the player's NHL api-web profile for the featured season context. |
featured_stats_playoffs_career_power_play_points | integer | Career playoff power-play points highlighted on the player's NHL api-web profile for the featured season context. |
featured_stats_playoffs_career_shooting_pctg | double | Career playoff shooting percentage highlighted on the player's NHL api-web profile, expressed as a decimal. |
featured_stats_playoffs_career_shorthanded_goals | integer | Career playoff shorthanded goals highlighted on the player's NHL api-web profile for the featured season context. |
featured_stats_playoffs_career_shorthanded_points | integer | Career playoff shorthanded points highlighted on the player's NHL api-web profile for the featured season context. |
featured_stats_playoffs_career_shots | integer | Career playoff shots on goal highlighted on the player's NHL api-web profile for the featured season context. |
career_totals_regular_season_assists | integer | Career cumulative assists recorded by the player across all NHL regular-season games. |
career_totals_regular_season_avg_toi | character | Career average time on ice per game in the NHL regular season, expressed as an MM:SS string. |
career_totals_regular_season_faceoff_winning_pctg | double | Career faceoff win percentage for the player across all NHL regular-season games. |
career_totals_regular_season_game_winning_goals | integer | Career total of game-winning goals the player has scored in NHL regular-season games. |
career_totals_regular_season_games_played | integer | Total number of NHL regular-season games the player has appeared in across their career. |
career_totals_regular_season_goals | integer | Career total goals scored by the player in NHL regular-season games. |
career_totals_regular_season_ot_goals | integer | Career total overtime goals scored by the player in NHL regular-season games. |
career_totals_regular_season_pim | integer | Career total penalty minutes accumulated by the player in NHL regular-season games. |
career_totals_regular_season_plus_minus | integer | Career plus/minus rating accumulated by the player across all NHL regular-season games. |
career_totals_regular_season_points | integer | Career total points (goals + assists) accumulated by the player in NHL regular-season games. |
career_totals_regular_season_power_play_goals | integer | Career total power-play goals scored by the player in NHL regular-season games. |
career_totals_regular_season_power_play_points | integer | Career total power-play points (goals + assists on the power play) in NHL regular-season games. |
career_totals_regular_season_shooting_pctg | double | Career shooting percentage for the player in NHL regular-season games, expressed as a decimal. |
career_totals_regular_season_shorthanded_goals | integer | Career total shorthanded goals scored by the player in NHL regular-season games. |
career_totals_regular_season_shorthanded_points | integer | Career total shorthanded points (goals + assists while shorthanded) in NHL regular-season games. |
career_totals_regular_season_shots | integer | Career total shots on goal taken by the player in NHL regular-season games. |
career_totals_playoffs_assists | integer | Career cumulative assists recorded by the player across all NHL playoff appearances. |
career_totals_playoffs_avg_toi | character | Career average time on ice per game in NHL playoff play, expressed as an MM:SS string. |
career_totals_playoffs_faceoff_winning_pctg | double | Career faceoff win percentage for the player across all NHL playoff games. |
career_totals_playoffs_game_winning_goals | integer | Career total of game-winning goals the player has scored in NHL playoff games. |
career_totals_playoffs_games_played | integer | Total number of NHL playoff games the player has appeared in across their career. |
career_totals_playoffs_goals | integer | Career total goals scored by the player in NHL playoff games. |
career_totals_playoffs_ot_goals | integer | Career total overtime goals scored by the player in NHL playoff games. |
career_totals_playoffs_pim | integer | Career total penalty minutes accumulated by the player in NHL playoff games. |
career_totals_playoffs_plus_minus | integer | Career plus/minus rating accumulated by the player across all NHL playoff games. |
career_totals_playoffs_points | integer | Career total points (goals + assists) accumulated by the player in NHL playoff games. |
career_totals_playoffs_power_play_goals | integer | Career total power-play goals scored by the player in NHL playoff games. |
career_totals_playoffs_power_play_points | integer | Career total power-play points (goals + assists on the power play) in NHL playoff games. |
career_totals_playoffs_shooting_pctg | double | Career shooting percentage for the player in NHL playoff games, expressed as a decimal. |
career_totals_playoffs_shorthanded_goals | integer | Career total shorthanded goals scored by the player in NHL playoff games. |
career_totals_playoffs_shorthanded_points | integer | Career total shorthanded points (goals + assists while shorthanded) in NHL playoff games. |
career_totals_playoffs_shots | integer | Career total shots on goal taken by the player in NHL playoff games. |
return_parsed=False — the raw JSON Dict payload, unparsed.
Example
nhl_player_landing(player_id=8480801)
Last validated n/a.
nhl_player_game_log
Pull a player's game-by-game log.
Endpoint URL: GET https://api-web.nhle.com/v1/player/{player_id}/game-log/{season}/{game_type}
Valid URL: https://api-web.nhle.com/v1/player/8480801/game-log/now
| API Parameter | Python | Pattern | Required | Nullable | Description |
|---|---|---|---|---|---|
player_id | player_id | Y | player_id path parameter. | ||
season | season | Y | season path parameter. | ||
game_type | game_type | Y | game_type path parameter. |
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 |
|---|---|---|
game_id | integer | Unique game identifier. |
team_abbrev | character | Team abbreviation. |
home_road_flag | character | Home or road indicator. |
game_date | character | Game date. |
goals | integer | Goals scored. |
assists | integer | Assists. |
points | integer | Total points (goals + assists). |
plus_minus | integer | Plus/minus rating. |
power_play_goals | integer | Power-play goals. |
power_play_points | integer | Power play points. |
game_winning_goals | integer | Game-winning goals. |
ot_goals | integer | Overtime goals. |
shots | integer | Shots on goal. |
shifts | integer | Number of shifts. |
shorthanded_goals | integer | Shorthanded goals. |
shorthanded_points | integer | Shorthanded points. |
opponent_abbrev | character | Opponent team abbreviation. |
pim | integer | Penalty minutes. |
toi | character | Time on ice. |
common_name_default | character | Player's team common name. |
opponent_common_name_default | character | Opponent team common name. |
opponent_common_name_fr | character | French-language common name of the opposing team in the player's individual game log entry from the NHL api-web feed. |
return_parsed=False — the raw JSON Dict payload, unparsed.
Example
nhl_player_game_log(player_id=8480801)
Last validated n/a.
nhl_player_spotlight
Pull the league's currently featured players.
Endpoint URL: GET https://api-web.nhle.com/v1/player-spotlight
Valid URL: https://api-web.nhle.com/v1/player-spotlight
| 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 |
|---|---|---|
player_id | integer | Unique player identifier. |
player_slug | character | URL slug for the player. |
position | character | Player position. |
sweater_number | integer | Jersey number. |
team_id | integer | Unique team identifier. |
headshot | character | URL to the player headshot image. |
team_tri_code | character | Team tri-code abbreviation. |
team_logo | character | URL to the team logo image. |
sort_id | integer | Sort order identifier for the spotlight. |
name_default | character | Player name (default localization). |
name_cs | character | Player name (Czech localization). |
name_fi | character | Player name (Finnish localization). |
name_sk | character | Player name (Slovak localization). |
return_parsed=False — the raw JSON Dict payload, unparsed.
Example
nhl_player_spotlight()
Last validated n/a.