Skip to main content
Version: 0.0.58

🏒 NHL hockey with sportsdataverse-py

Welcome to the show! 🎉 sportsdataverse.nhl gives you the NHL's own modern feed — the same api-web.nhle.com data that powers NHL.com — plus the shiny NHL EDGE puck-and-player tracking layer, the api.nhle.com stats-REST and records flat APIs, an ESPN fallback, and fast parquet loaders. All of it hands you tidy polars DataFrames, ready to model. 🚀

We'll lead with the premium native wrappers (the nhl_* and nhl_edge_* functions) — they're the league's first-party data, no key required — and keep ESPN (espn_nhl_*) as a friendly secondary path.

R user? The companion package is fastRhockey (NHL + PWHL). Let's drop the puck! 🏒

🧰 The toolbox​

Every native call returns a tidy polars DataFrame by default — pass return_as_pandas=True for pandas, or return_parsed=False for the raw JSON. Here's the kit we'll use (click any name for the full reference). The ⭐ rows are the premium native NHL feed — start there.

FunctionWhat it gives youSource
nhl_web_scheduleA day's games + scores, native ids⭐ NHL api-web
nhl_web_pbpEvent-level play-by-play (one row per event)⭐ NHL api-web
nhl_boxscoreOne row per player (skaters + goalies)⭐ NHL api-web
nhl_standingsTeam standings with conference/division⭐ NHL api-web
nhl_rosterA club's roster for a season⭐ NHL api-web
nhl_club_schedule_seasonA team's full-season schedule⭐ NHL api-web
nhl_player_game_logA player's game-by-game line⭐ NHL api-web
nhl_player_landingA player's bio + career snapshot⭐ NHL api-web
nhl_skater_leadersSeason skater leaderboard⭐ NHL api-web
nhl_goalie_leadersSeason goalie leaderboard⭐ NHL api-web
nhl_club_statsA club's full skater + goalie stat lines⭐ NHL api-web
nhl_player_landingA player's bio + career snapshot⭐ NHL api-web
nhl_scoreA day's final scores + series context⭐ NHL api-web
nhl_draft_picksDraft board for a year/round⭐ NHL api-web
nhl_edge_skater_skating_speed_detailA skater's tracked speed vs league avg + percentile⭐ NHL EDGE
nhl_edge_skater_landingEDGE skater leaderboards (hardest shot, top speed…)⭐ NHL EDGE
nhl_edge_team_landingEDGE team-level tracking leaders⭐ NHL EDGE
nhl_edge_goalie_landingEDGE goalie tracking leaders⭐ NHL EDGE
nhl_stats_rest_leaders_skatersStats-REST top-10 skaters by attribute⭐ NHL stats-REST
nhl_stats_rest_leaders_goaliesStats-REST top-10 goalies by attribute⭐ NHL stats-REST
nhl_records_franchisesEvery franchise in NHL history (Records API)⭐ NHL records
nhl_records_franchise_team_totalsAll-time W/L/points per franchise⭐ NHL records
load_nhl_schedulePre-built schedule parquet (offline-friendly)📦 loader
load_nhl_team_boxPre-built team box parquet📦 loader
load_nhl_player_boxPre-built player box parquet📦 loader
espn_nhl_teamsESPN team directoryESPN
espn_nhl_scheduleESPN schedule for a dateESPN
espn_nhl_pbpESPN play-by-play (a dict)ESPN
espn_nhl_standingsESPN standingsESPN

🔌 Setup​

pip install sportsdataverse

No API key needed — the NHL's public feeds ship ready to go. 😊

import polars as pl
import sportsdataverse as sdv
import sportsdataverse.nhl as nhl

The native feeds are live and seasonal (and occasionally throttle), so a tiny safe() helper runs each network call defensively — you get the frame when the feed is up, and a friendly one-liner when it isn't (never a scary traceback). 🛟

We'll reference the 2024 Stanley Cup Final Game 7 throughout: Florida Panthers 2, Edmonton Oilers 1 (June 24, 2024). Note the native game id 2023030417 (season + game-type + sequence) is different from ESPN's 401675111 for the very same game.

def safe(label, thunk):
    try:
        out = thunk()
        print(f'✅ {label}')
        return out
    except Exception as e:  # noqa: BLE001 -- demo resilience
        print(f'⏭️  {label}: unavailable right now ({type(e).__name__})')
        return None


# Game 7, 2024 Stanley Cup Final — two ids for the same game
NATIVE_GAME = 2023030417   # api-web.nhle.com
ESPN_GAME = 401675111      # ESPN
SEASON = 20232024          # NHL season strings are start+end years

⭐ The premium native feed (nhl_*)​

These wrappers hit the league's own api-web.nhle.com. They're first-party, richly detailed, and return polars directly. Let's tour the headline calls.

📅 Schedule​

nhl_web_schedule(date='YYYY-MM-DD') returns a day's games with home_team_* / away_team_* columns and the native id.

sched = safe('native schedule', lambda: nhl.nhl_web_schedule(date='2024-06-24'))
cols = ['id', 'game_state', 'home_team_abbrev', 'home_team_score',
        'away_team_abbrev', 'away_team_score']
(sched.select([c for c in cols if c in sched.columns]).head()
 if sched is not None else 'schedule unavailable')

🥅 Play-by-play​

nhl_web_pbp(game_id=...) returns one row per event in clean snake_case — type_desc_key, time_in_period, period_descriptor_number, plus shot coordinates details_x_coord / details_y_coord. That coordinate pair is your gateway to shot maps. 🗺️

pbp = safe('native pbp', lambda: nhl.nhl_web_pbp(game_id=NATIVE_GAME))
if pbp is not None:
    print('pbp shape:', pbp.shape)
    show = ['period_descriptor_number', 'time_in_period', 'type_desc_key',
            'details_event_owner_team_id', 'details_x_coord', 'details_y_coord']
    out = pbp.select([c for c in show if c in pbp.columns]).head()
else:
    out = 'pbp unavailable'
out
# Event-type mix for the game — native uses `type_desc_key`
(pbp.group_by('type_desc_key').agg(pl.len().alias('events'))
    .sort('events', descending=True).head(10)
 if pbp is not None else 'pbp unavailable')

📊 Boxscore​

nhl_boxscore(game_id=...) gives one row per player (skaters + goalies) with home_away, position, and the per-player stat line. Let's pull the night's top scorers.

box = safe('native boxscore', lambda: nhl.nhl_boxscore(game_id=NATIVE_GAME))
if box is not None:
    out = (box.filter(pl.col('position') != 'G')
              .select(['name_default', 'home_away', 'position',
                       'goals', 'assists', 'points', 'sog', 'toi'])
              .sort('points', descending=True).head())
else:
    out = 'boxscore unavailable'
out

🏆 Standings​

nhl_standings(date='YYYY-MM-DD') returns one row per team with conference/division context and points — pass any date to get the table as of that day.

standings = safe('native standings', lambda: nhl.nhl_standings(date='2024-04-15'))
if standings is not None:
    out = (standings.select(['team_name_default', 'conference_name', 'division_name',
                             'games_played', 'wins', 'losses', 'points'])
                    .sort('points', descending=True).head())
else:
    out = 'standings unavailable'
out

🛰️ NHL EDGE — player & puck tracking​

EDGE is the league's tracking layer: skating speed, shot speed, zone time, skating distance — all measured by sensors. The *_detail calls return a player's tracked values alongside the league average and percentile, and the *_landing calls return wide leaderboard frames.

FunctionTracking metric
nhl_edge_skater_skating_speed_detailtop speed, speed bursts, vs league avg
nhl_edge_skater_landingskater leaders (hardest shot, top speed…)
nhl_edge_team_landingteam-level tracking leaders

Here's Connor McDavid's (8478402) skating-speed detail for 2023-24 — how does the fastest man in the league stack up? ⚡

edge = safe('EDGE skating speed',
            lambda: nhl.nhl_edge_skater_skating_speed_detail(player_id=8478402, season=SEASON))
if edge is not None:
    keep = [c for c in (
        'skating_speed_details_max_skating_speed_imperial',
        'skating_speed_details_max_skating_speed_league_avg_imperial',
        'skating_speed_details_max_skating_speed_percentile',
        'skating_speed_details_bursts_over22_value',
        'skating_speed_details_bursts_over22_percentile',
    ) if c in edge.columns]
    out = edge.select(keep) if keep else edge.head()
else:
    out = 'EDGE detail unavailable'
out

📈 Stats-REST & Records flat APIs​

Two more first-party surfaces round out the kit:

leaders = safe('stats-rest goal leaders',
               lambda: nhl.nhl_stats_rest_leaders_skaters(attribute='goals'))
if leaders is not None:
    keep = ['player_full_name', 'player_position_code', 'team_tri_code', 'goals']
    out = leaders.select([c for c in keep if c in leaders.columns]).head(10)
else:
    out = 'leaders unavailable'
out

🍳 Cookbook: common NHL tasks​

Now the fun part — a dozen recipes you'll reach for constantly, almost all built on the premium native feed. Each one is a copy-paste starting point: a game pull, a team view, a player line, leaderboards, splits, joins, season-to-date aggregates, the draft board, franchise history, and EDGE tracking — every call wrapped in safe() so an offseason or a throttle never costs you a traceback. 🍳

Recipe 1 — A game's boxscore + play-by-play 🎯​

Grab a game_id from nhl_web_schedule, then pull the nhl_boxscore and nhl_web_pbp together — the box for the line score, the pbp for the event stream.

if sched is not None and sched.height:
    gid = int(sched['id'][0])
    r_box = safe(f'boxscore {gid}', lambda: nhl.nhl_boxscore(game_id=gid))
    r_pbp = safe(f'pbp {gid}', lambda: nhl.nhl_web_pbp(game_id=gid))
    print('players in box:', None if r_box is None else r_box.height,
          '| pbp events:', None if r_pbp is None else r_pbp.height)
else:
    print('no schedule rows to pick a game_id from')

Recipe 2 — A team, its schedule & its roster 👥​

Use the team tri-code (e.g. FLA) with nhl_club_schedule_season for the full slate and nhl_roster for the player list.

TEAM = 'FLA'
club_sched = safe(f'{TEAM} schedule',
                  lambda: nhl.nhl_club_schedule_season(team=TEAM, season=SEASON))
roster = safe(f'{TEAM} roster', lambda: nhl.nhl_roster(team=TEAM, season=SEASON))
print('games:', None if club_sched is None else club_sched.height,
      '| roster size:', None if roster is None else roster.height)
if roster is not None and roster.height:
    cols = ['id', 'first_name_default', 'last_name_default',
            'sweater_number', 'position_code', 'shoots_catches']
    out = roster.select([c for c in cols if c in roster.columns]).head()
else:
    out = 'roster unavailable'
out

Recipe 3 — A player's game log + the league leaderboard ⚡​

Pair a single player's nhl_player_game_log (game-by-game) with the season-wide nhl_skater_leaders board to see where they rank. McDavid is 8478402.

gamelog = safe('McDavid game log',
               lambda: nhl.nhl_player_game_log(player_id=8478402, season=SEASON))
if gamelog is not None and gamelog.height:
    cols = ['game_date', 'opponent_abbrev', 'goals', 'assists', 'points', 'shots', 'toi']
    out = gamelog.select([c for c in cols if c in gamelog.columns]).head()
else:
    out = 'game log unavailable'
out
board = safe('skater leaders', lambda: nhl.nhl_skater_leaders(season=SEASON))
if board is not None and board.height:
    cols = ['category', 'first_name_default', 'last_name_default', 'team_abbrev', 'value']
    out = board.select([c for c in cols if c in board.columns]).head(10)
else:
    out = 'leaders unavailable'
out

Recipe 4 — An EDGE tracking leaderboard 🛰️​

nhl_edge_skater_landing returns a wide single-row frame of EDGE leaders — hardest shot, fastest skater, and more. Here we surface who owned the hardest shot in 2023-24.

el = safe('EDGE skater leaders', lambda: nhl.nhl_edge_skater_landing(season=SEASON))
if el is not None:
    keep = [c for c in el.columns if c.startswith('leaders_hardest_shot_player_')
            and ('first_name' in c or 'last_name' in c or 'team_abbrev' in c
                 or c.endswith('position'))]
    out = el.select(keep) if keep else el.head()
else:
    out = 'EDGE leaders unavailable'
out

Recipe 5 — Who's hot? Standings by last-10 form 🔥​

The native nhl_standings frame carries rich split columns — l10_* (last ten games) and streak_* — so you can rank teams by recent form instead of season-long points.

hot = safe('standings as-of date',
           lambda: nhl.nhl_standings(date='2024-04-15'))
if hot is not None and hot.height:
    cols = ['team_name_default', 'l10_wins', 'l10_losses', 'l10_ot_losses',
            'l10_points', 'streak_code', 'streak_count', 'points']
    out = (hot.select([c for c in cols if c in hot.columns])
              .sort(['l10_points', 'points'], descending=True).head(8))
else:
    out = 'standings unavailable'
out

Recipe 6 — A whole team's stat lines in one call 📋​

nhl_club_stats returns a dict with skaters and goalies frames — the entire roster's season totals, no looping over players. Here are the Panthers' top point-getters.

cs = safe('FLA club stats',
          lambda: nhl.nhl_club_stats(team='FLA', season=SEASON))
if isinstance(cs, dict) and isinstance(cs.get('skaters'), pl.DataFrame) and cs['skaters'].height:
    sk = cs['skaters']
    cols = ['first_name_default', 'last_name_default', 'position_code',
            'games_played', 'goals', 'assists', 'points', 'shots',
            'avg_time_on_ice_per_game']
    out = (sk.select([c for c in cols if c in sk.columns])
             .sort('points', descending=True).head(8))
else:
    out = 'club stats unavailable'
out

Recipe 7 — Goalie leaderboard + a netminder's bio 🥅​

Pair the season-wide nhl_goalie_leaders board (it bundles wins, save %, GAA and shutouts in one frame, tagged by category) with a single goalie's nhl_player_landing bio card.

gboard = safe('goalie leaders', lambda: nhl.nhl_goalie_leaders(season=SEASON))
if gboard is not None and gboard.height:
    cols = ['category', 'first_name_default', 'last_name_default',
            'team_abbrev', 'value']
    out = (gboard.filter(pl.col('category') == 'wins')
                 .select([c for c in cols if c in gboard.columns])
                 .sort('value', descending=True).head(5)
           if 'category' in gboard.columns else gboard.head())
else:
    out = 'goalie leaders unavailable'
out
# Bobrovsky's bio card (player_id 8475683) — one wide row
bio = safe('goalie landing', lambda: nhl.nhl_player_landing(player_id=8475683))
if bio is not None and bio.height:
    cols = ['first_name_default', 'last_name_default', 'position',
            'current_team_abbrev', 'height_in_inches', 'weight_in_pounds',
            'birth_city_default', 'birth_country', 'draft_details_year',
            'draft_details_overall_pick']
    out = bio.select([c for c in cols if c in bio.columns])
else:
    out = 'player landing unavailable'
out

Recipe 8 — Home vs road splits, derived from a schedule 🏠✈️​

No splits endpoint? No problem — pull a club's full season with nhl_club_schedule_season, tag each finished game as home or road, and let polars roll up goals-for / goals-against per game. A pattern you'll reuse everywhere.

TEAM = 'FLA'
cs2 = safe(f'{TEAM} season schedule',
           lambda: nhl.nhl_club_schedule_season(team=TEAM, season=SEASON))
need = {'home_team_abbrev', 'away_team_abbrev', 'home_team_score', 'away_team_score'}
if cs2 is not None and need.issubset(cs2.columns):
    g = cs2.filter(pl.col('home_team_score').is_not_null())
    if 'game_type' in g.columns:
        g = g.filter(pl.col('game_type') == 2)  # regular season only
    g = g.with_columns([
        pl.when(pl.col('home_team_abbrev') == TEAM).then(pl.lit('home'))
          .otherwise(pl.lit('road')).alias('venue'),
        pl.when(pl.col('home_team_abbrev') == TEAM)
          .then(pl.col('home_team_score')).otherwise(pl.col('away_team_score')).alias('gf'),
        pl.when(pl.col('home_team_abbrev') == TEAM)
          .then(pl.col('away_team_score')).otherwise(pl.col('home_team_score')).alias('ga'),
    ])
    out = (g.group_by('venue').agg([
        pl.len().alias('gp'),
        (pl.col('gf') > pl.col('ga')).sum().alias('wins'),
        pl.col('gf').mean().round(2).alias('gf_per_game'),
        pl.col('ga').mean().round(2).alias('ga_per_game'),
    ]).sort('venue'))
else:
    out = 'club schedule unavailable'
out

Recipe 9 — Pull a draft board 🎟️​

nhl_draft_picks returns one row per selection for a given year (and optional round_) — overall pick, team, position, and the player's amateur club. Here's the 2023 first round.

draft = safe('2023 draft round 1',
             lambda: nhl.nhl_draft_picks(year=2023, round_=1))
if draft is not None and draft.height:
    cols = ['overall_pick', 'team_abbrev', 'first_name_default',
            'last_name_default', 'position_code', 'amateur_club_name',
            'amateur_league']
    out = (draft.select([c for c in cols if c in draft.columns])
                .sort('overall_pick').head(10))
else:
    out = 'draft board unavailable'
out

Recipe 10 — Season-to-date team aggregates (loader + pandas) 📦🐼​

For multi-game rollups, the offline-friendly load_nhl_team_box parquet release is your friend: one row per team per game. Group it in polars, then .to_pandas() to hand the result to the rest of the PyData stack.

tb = safe('team box 2024', lambda: nhl.load_nhl_team_box(seasons=[2024]))
if tb is not None and tb.height and {'tri_code', 'shots', 'hits', 'goals'}.issubset(tb.columns):
    agg = (tb.group_by('tri_code').agg([
        pl.len().alias('games'),
        pl.col('goals').cast(pl.Float64).mean().round(2).alias('goals_pg'),
        pl.col('shots').cast(pl.Float64).mean().round(1).alias('shots_pg'),
        pl.col('hits').cast(pl.Float64).mean().round(1).alias('hits_pg'),
    ]).sort('goals_pg', descending=True).head(8))
    pdf = agg.to_pandas()   # hand off to pandas for plotting/modeling
    print('pandas frame:', type(pdf).__name__, pdf.shape)
    out = agg
else:
    out = 'team box loader unavailable'
out

Recipe 11 — All-time franchise standings (Records API join) 🏛️​

The Records flat API never goes offseason. Join nhl_records_franchise_team_totals (all-time W/L/points, regular season game_type_id == 2) onto nhl_records_franchises for the names — the winningest clubs in league history.

totals = safe('franchise team totals',
              lambda: nhl.nhl_records_franchise_team_totals())
names = safe('franchises', lambda: nhl.nhl_records_franchises())
if (totals is not None and totals.height and names is not None and names.height
        and 'franchise_id' in totals.columns and 'id' in names.columns):
    reg = totals.filter(pl.col('game_type_id') == 2) if 'game_type_id' in totals.columns else totals
    keep_n = [c for c in ('id', 'full_name', 'team_abbrev') if c in names.columns]
    out = (reg.join(names.select(keep_n), left_on='franchise_id', right_on='id', how='left')
              .select([c for c in ('full_name', 'games_played', 'wins',
                                   'losses', 'points', 'cups')
                       if c in reg.columns or c == 'full_name'])
              .sort('wins', descending=True).head(10))
else:
    out = 'franchise records unavailable'
out

Recipe 12 — EDGE tracking leaders: team & goalie 🛰️​

Round out the tour with two more EDGE landing boards. Each is a wide single-row frame of leaders; pluck the columns for one metric to see who tops it. Here: the team that piled up the most 90+ mph shot attempts, and the goalie with the best high-danger save percentage.

tl = safe('EDGE team leaders', lambda: nhl.nhl_edge_team_landing(season=SEASON))
if tl is not None and tl.height:
    keep = [c for c in tl.columns
            if c.startswith('leaders_shot_attempts_over90_')
            and ('team_abbrev' in c or 'common_name_default' in c
                 or c.endswith('_attempts'))]
    out = tl.select(keep) if keep else tl.head()
else:
    out = 'EDGE team leaders unavailable'
out
gl = safe('EDGE goalie leaders', lambda: nhl.nhl_edge_goalie_landing(season=SEASON))
if gl is not None and gl.height:
    keep = [c for c in gl.columns
            if c.startswith('leaders_high_danger_save_pctg_')
            and ('player_first_name_default' in c
                 or 'player_last_name_default' in c
                 or 'player_team_abbrev' in c
                 or c.endswith('_save_pctg'))]
    out = gl.select(keep) if keep else gl.head()
else:
    out = 'EDGE goalie leaders unavailable'
out

🛟 ESPN NHL (espn_nhl_*) — the secondary path​

Prefer the native feed above, but ESPN is a handy fallback and matches the conventions used across every other league in the package. Team names are home_display_name / away_display_name, scores come back as strings (cast before arithmetic), and espn_nhl_pbp returns a dict whose plays use raw ESPN dot-notation. ESPN game ids look like 401675111.

FunctionWhat it gives you
espn_nhl_teamsESPN team directory
espn_nhl_scheduleschedule for a date
espn_nhl_pbpplay-by-play (a dict)
espn_nhl_standingsstandings
teams = safe('ESPN teams', lambda: nhl.espn_nhl_teams())
if teams is not None:
    cols = ['team_id', 'team_location', 'team_name', 'team_abbreviation', 'team_display_name']
    out = teams.select([c for c in cols if c in teams.columns]).head()
else:
    out = 'ESPN teams unavailable'
out
espn_pbp = safe(f'ESPN pbp {ESPN_GAME}', lambda: nhl.espn_nhl_pbp(game_id=ESPN_GAME))
if espn_pbp is not None and espn_pbp.get('plays'):
    plays = pl.DataFrame(espn_pbp['plays'], infer_schema_length=None)
    show = [c for c in ['period.number', 'clock.displayValue', 'text', 'type.text', 'scoringPlay']
            if c in plays.columns]
    print('ESPN plays:', plays.height)
    out = plays.select(show).head()
else:
    out = 'ESPN pbp unavailable'
out

📦 Parquet loaders (load_nhl_*)​

When you want multi-season data fast and offline-friendly, the load_nhl_* loaders read pre-built parquet data releases (fastRhockey-era schema) and return polars frames. Pass seasons=[...]; add return_as_pandas=True for pandas.

FunctionRelease
load_nhl_scheduleschedules
load_nhl_team_boxteam box
load_nhl_player_boxplayer box
load_nhl_pbpplay-by-play
rel = safe('load schedule 2024', lambda: nhl.load_nhl_schedule(seasons=[2024]))
if rel is not None:
    print('release schedule shape:', rel.shape)
    cols = ['game_id', 'game_date', 'home_team_name', 'away_team_name', 'home_score', 'away_score']
    out = rel.select([c for c in cols if c in rel.columns]).head()
else:
    out = 'release loader unavailable'
out

🎉 Where to next​

You just toured the premium native NHL feed end to end — schedule, play-by-play, boxscores, standings, rosters, leaderboards, EDGE tracking, the stats-REST and Records flat APIs — plus the ESPN fallback and the parquet loaders. A few parting tips:

  • Pass return_as_pandas=True on any native call for a pandas frame, or return_parsed=False for the raw JSON.
  • Native game ids (2023030417) ≠ ESPN game ids (401675111) — same game, different namespaces. 🧭
  • Full reference, by source: NHL Web API · NHL EDGE · Stats-REST · Records · loaders · additional / ESPN
  • Women's pro hockey? See the PWHL tutorial (10_pwhl_intro.ipynb).
  • R user? The same surface lives in fastRhockey.

Now go build something great — and may your save percentage be ever high! 🥅