Skip to main content
Version: 0.1.5

NHL — NHL EDGE API — Cat

nhl_edge_cat_skater_detail​

Pull categorized (cat) EDGE detail stats for a single skater.

Endpoint URL: GET https://api-web.nhle.com/v1/cat/edge/skater-detail/{player_id}/{season}/{game_type}

Valid URL: https://api-web.nhle.com/v1/cat/edge/skater-detail/8480801/now

API ParameterPythonPatternRequiredNullableDescription
player_idplayer_idYplayer_id path parameter.
seasonseasonYseason path parameter.
game_typegame_typeYgame_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_nametypedescription
seasons_with_edge_statscharacterJSON-serialized list of NHL season identifiers for which EDGE puck-and-player tracking data is available for this skater.
sog_summarycharacterJSON-serialized summary of shot-on-goal tracking data aggregated over the tracking period for the skater.
sog_detailscharacterJSON-serialized per-game shot-on-goal tracking details for the skater across the tracking period.
player_idintegerUnique player identifier.
player_first_name_defaultcharacterPlayer first name (default language).
player_last_name_defaultcharacterPlayer last name (default language).
player_birth_datecharacter
player_shoots_catchescharacterSide on which the skater shoots — L (left) or R (right).
player_sweater_numberintegerPlayer jersey number.
player_positioncharacterPrimary player position.
player_slugcharacterURL slug for the player.
player_headshotcharacterURL to the player headshot image.
player_goalsintegerNumber of goals scored by the skater during the relevant tracking period.
player_assistsintegerNumber of assists credited to the skater during the relevant tracking period.
player_pointsinteger
player_games_playedintegerNumber of games in which the skater appeared during the relevant tracking period.
player_team_common_name_defaultcharacterPlayer team common name (default locale).
player_team_place_name_with_preposition_defaultcharacterPlayer team place name with preposition (default locale).
player_team_place_name_with_preposition_frcharacterPlayer team place name with preposition (French locale).
player_team_abbrevcharacterPlayer team abbreviation.
player_team_team_logo_lightcharacterPlayer team light-mode logo URL.
player_team_team_logo_darkcharacterPlayer team dark-mode logo URL.
top_shot_speed_imperialdoubleSkater's highest recorded shot speed in miles per hour during the tracking period.
top_shot_speed_metricdoubleSkater's highest recorded shot speed in kilometers per hour during the tracking period.
top_shot_speed_percentiledoublePercentile rank among all NHL skaters for highest recorded shot speed during the tracking period.
top_shot_speed_league_avg_imperialdoubleLeague-average top shot speed in miles per hour, used as the baseline for this skater's shot-speed percentile.
top_shot_speed_league_avg_metricdoubleLeague-average top shot speed in kilometers per hour, used as the baseline for this skater's shot-speed percentile.
skating_speed_speed_max_imperialdoubleSkater's maximum recorded skating speed in miles per hour during the tracking period.
skating_speed_speed_max_metricdoubleSkater's maximum recorded skating speed in kilometers per hour during the tracking period.
skating_speed_speed_max_percentiledoublePercentile rank among all NHL skaters for maximum skating speed recorded during the tracking period.
skating_speed_speed_max_league_avg_imperialdoubleLeague-average maximum skating speed in miles per hour, used as the baseline for this skater's percentile.
skating_speed_speed_max_league_avg_metricdoubleLeague-average maximum skating speed in kilometers per hour, used as the baseline for this skater's percentile.
skating_speed_speed_max_overlay_player_first_name_defaultcharacterFirst name of the skater who achieved the maximum skating speed in the context of the overlay comparison play.
skating_speed_speed_max_overlay_player_last_name_defaultcharacterLast name of the skater who achieved the maximum skating speed in the context of the overlay comparison play.
skating_speed_speed_max_overlay_time_in_periodcharacterElapsed time within the period (mm:ss) at which the skater's maximum skating speed was recorded.
skating_speed_bursts_over20_valueintegerNumber of skating bursts the skater reached or exceeded 20 mph per game on average during the tracking period.
skating_speed_bursts_over20_percentiledoublePercentile rank among all NHL skaters for frequency of skating speed bursts exceeding 20 mph per game.
skating_speed_bursts_over20_league_avg_valuedoubleLeague-average number of skating speed bursts exceeding 20 mph per game, used as the baseline for this skater's percentile.
total_distance_skated_imperialdoubleTotal cumulative distance skated by the player in miles during the tracking period.
total_distance_skated_metricdoubleTotal cumulative distance skated by the player in kilometers during the tracking period.
total_distance_skated_percentiledoublePercentile rank among all NHL skaters for total distance skated per game during the tracking period.
total_distance_skated_league_avg_imperialdoubleLeague-average total distance skated in miles per game, used as the baseline for this skater's distance percentile.
total_distance_skated_league_avg_metricdoubleLeague-average total distance skated in kilometers per game, used as the baseline for this skater's distance percentile.
zone_time_details_offensive_zone_pctgdoublePercentage of the skater's total on-ice time spent in the offensive zone during the tracking period.
zone_time_details_offensive_zone_percentiledoublePercentile rank among all NHL skaters for percentage of ice time spent in the offensive zone.
zone_time_details_offensive_zone_league_avgdoubleLeague-average percentage of on-ice time skaters spend in the offensive zone, used as the baseline for this player's percentile.
zone_time_details_neutral_zone_pctgdoublePercentage of the skater's total on-ice time spent in the neutral zone during the tracking period.
zone_time_details_neutral_zone_percentiledoublePercentile rank among all NHL skaters for percentage of ice time spent in the neutral zone.
zone_time_details_neutral_zone_league_avgdoubleLeague-average percentage of on-ice time skaters spend in the neutral zone, used as the baseline for this player's percentile.
zone_time_details_defensive_zone_pctgdoublePercentage of the skater's total on-ice time spent in the defensive zone during the tracking period.
zone_time_details_defensive_zone_percentiledoublePercentile rank among all NHL skaters for percentage of ice time spent in the defensive zone.
zone_time_details_defensive_zone_league_avgdoubleLeague-average percentage of on-ice time skaters spend in the defensive zone, used as the baseline for this player's percentile.

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

Example​

nhl_edge_cat_skater_detail(player_id=8480801)

Last validated n/a.

nhl_edge_cat_goalie_detail​

Pull categorized (cat) EDGE detail stats for a single goalie.

Endpoint URL: GET https://api-web.nhle.com/v1/cat/edge/goalie-detail/{player_id}/{season}/{game_type}

Valid URL: https://api-web.nhle.com/v1/cat/edge/goalie-detail/8480801/now

API ParameterPythonPatternRequiredNullableDescription
player_idplayer_idYplayer_id path parameter.
seasonseasonYseason path parameter.
game_typegame_typeYgame_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_nametypedescription
seasons_with_edge_statscharacterJSON-serialized list of NHL season identifiers for which EDGE puck-and-player tracking data is available for this goalie.
shot_location_summarycharacterJSON-serialized summary of shot-location tracking data aggregated across all zones for the goalie.
shot_location_detailscharacterJSON-serialized per-zone shot-location tracking breakdown showing where shots were attempted against the goalie.
player_idintegerUnique player identifier.
player_first_name_defaultcharacterPlayer first name (default language).
player_last_name_defaultcharacterPlayer last name (default language).
player_birth_datecharacter
player_shoots_catchescharacterSide on which the goalie catches — L (left) or R (right).
player_sweater_numberintegerPlayer jersey number.
player_slugcharacterURL slug for the player.
player_headshotcharacterURL to the player headshot image.
player_winsintegerNumber of regulation and overtime wins credited to the goalie during the tracking period.
player_lossesintegerNumber of regulation losses credited to the goalie during the tracking period.
player_overtime_lossesintegerNumber of overtime or shootout losses credited to the goalie during the tracking period.
player_goals_against_avgdoubleGoalie's goals-against average — goals allowed per 60 minutes of ice time — for the tracking period.
player_save_pctgdoubleGoalie's save percentage, expressed as the proportion of shots on goal stopped.
player_games_playedintegerNumber of games in which the goalie appeared during the relevant tracking period.
player_team_common_name_defaultcharacterPlayer team common name (default locale).
player_team_place_name_with_preposition_defaultcharacterPlayer team place name with preposition (default locale).
player_team_place_name_with_preposition_frcharacterPlayer team place name with preposition (French locale).
player_team_abbrevcharacterPlayer team abbreviation.
player_team_team_logo_lightcharacterPlayer team light-mode logo URL.
player_team_team_logo_darkcharacterPlayer team dark-mode logo URL.
stats_goals_against_avg_valuedoubleGoalie's goals-against average for the tracking period.
stats_goals_against_avg_percentiledoublePercentile rank among all NHL goalies for goals-against average (lower GAA = higher percentile).
stats_goals_against_avg_league_avgdoubleLeague-average goals-against average used as the baseline for this goalie's GAA percentile calculation.
stats_games_above900_valuedoubleNumber of games the goalie posted a save percentage above .900 during the tracking period.
stats_games_above900_percentiledoublePercentile rank among all NHL goalies for games played in which the goalie posted a save percentage above .900.
stats_games_above900_league_avgdoubleLeague-average games-above-.900-save-percentage rate used as the baseline for this goalie's percentile calculation.
stats_goal_differential_per60_valuedoubleGoalie's goals-saved-above-expected per 60 minutes, measuring performance relative to shot quality faced.
stats_goal_differential_per60_percentiledoublePercentile rank among all NHL goalies for goals-saved-above-expected per 60 minutes of ice time.
stats_goal_differential_per60_league_avgdoubleLeague-average goals-saved-above-expected per 60 minutes used as the baseline for this goalie's percentile.
stats_goal_support_avg_valuedoubleAverage number of goals scored for the goalie per game started during the tracking period.
stats_goal_support_avg_percentiledoublePercentile rank among all NHL goalies for average offensive goal support received per game started.
stats_goal_support_avg_league_avgdoubleLeague-average goal support (goals scored for the goalie per game) used as the baseline for percentile calculation.
stats_point_pctg_valuedoubleFraction of available standings points the goalie's team earned in games the goalie started.
stats_point_pctg_percentiledoublePercentile rank among all NHL goalies for team point percentage in games the goalie started.
stats_point_pctg_league_avgdoubleLeague-average team point percentage in games the goalie started, used as the baseline for percentile calculation.

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

Example​

nhl_edge_cat_goalie_detail(player_id=8480801)

Last validated n/a.