Man pages for nhlscraper
Scraper for National Hockey League Data

add_deltasAdd event-to-event deltas to a play-by-play
add_goalie_biometricsAdd goalie biometrics to (a) play-by-play(s)
add_shift_timesAdd on-ice shift times to a play-by-play
add_shooter_biometricsAdd shooter biometrics to (a) play-by-play(s)
attendanceAccess the attendance by season and game type
awardsAccess all the awards
award_winnersAccess all the award winners/finalists
boxscoreAccess the boxscore for a game, team, and position
bracketAccess the playoff bracket for a season
calculate_expected_goalsCalculate the expected goals for all the shots in (a)...
calculate_shift_times_by_situationCalculate shift times by exact situation code
coach_career_statisticsAccess the career statistics for all the coaches
coachesAccess all the coaches
coach_franchise_statisticsAccess the statistics for all the coaches by franchise and...
combine_reportsAccess the draft combine reports
contractsAccess all contracts from packaged internal data
countriesAccess all the countries
dot-add_empty_html_on_ice_columnsInitialize empty on-ice columns
dot-add_html_on_ice_playersAdd HTML-derived on-ice players to play-by-play
dot-add_one_on_one_on_ice_playersAdd one-on-one shooter/goalie assignments
dot-add_on_ice_shift_timing_contextAdd on-ice shift timing context
dot-api_requestBuild a retrying API request
dot-apply_pbp_delta_columnsAttach delta context columns to play-by-play
dot-apply_shot_contextAttach shot context columns to play-by-play
dot-assign_html_on_ice_player_idsAssign resolved HTML on-ice IDs to scalar columns
dot-assign_on_ice_shift_metricAssign scalar on-ice timing metrics
dot-backfill_delayed_penalty_on_ice_playersBackfill unmatched delayed-penalty rows from nearby populated...
dot-build_api_html_match_tableBuild API-side HTML matching features
dot-build_game_roster_lookupBuild a game-roster lookup table
dot-calculate_angleCalculate the Euclidean angle from the attacking net for all...
dot-calculate_distanceCalculate the Euclidean distance from the attacking net for...
dot-calculate_shift_times_by_situation_dataCalculate shift times by situation from supplied data
dot-clean_public_pbp_playsRun shared public play-by-play cleanup
dot-coerce_team_idConvert to the appropriate team ID
dot-coerce_team_tri_codeConvert to the appropriate team three-letter code
dot-compute_on_ice_shift_timing_in_rCompute on-ice shift timings in R
dot-compute_on_ice_shift_timing_matricesCompute on-ice shift timing matrices
dot-compute_pbp_deltasCompute play-by-play deltas with native fallback
dot-compute_pbp_deltas_in_rCompute play-by-play deltas in R
dot-compute_shot_contextCompute shot context summaries
dot-count_goals_shotsCount the as-of-event goal, shots on goal, Fenwick, and Corsi...
dot-covid_round_robin_shootout_game_idsIdentify Return-to-Play round-robin shootout games
dot-dot_to_camelConvert dot-delimited names to camelCase
dot-draw_rink_arcDraw an arc on the rink
dot-draw_rink_circleDraw a circle on the rink
dot-draw_share_cumulative_xgDraw a shareable cumulative xG plot
dot-draw_share_shot_legendsDraw the shot-map legends
dot-draw_share_shot_locationsDraw a shareable shot-location plot
dot-drop_illogical_ordered_eventsRemove illogically ordered boundary events from a...
dot-empty_pbp_delta_contextBuild an empty play-by-play delta context
dot-empty_public_pbp_columnAllocate a missing public play-by-play column
dot-ensure_local_native_symbolEnsure a native symbol is available
dot-espn_apiCall the ESPN API
dot-extract_html_clockExtract an HTML clock token
dot-fetch_html_pbp_on_iceFetch HTML on-ice play-by-play rows
dot-finalize_pbp_outputFinalize public play-by-play output
dot-flag_is_homeFlag if the event belongs to the home team or not for all the...
dot-flag_is_reboundFlag if the shot attempt is a rebound attempt or creates a...
dot-flag_is_rushFlag if the shot attempt is a rush attempt or not for all the...
dot-format_elapsed_clockFormat elapsed seconds as an 'MM:SS' clock
dot-format_html_shift_clockFormat an HTML shift clock
dot-game_period_base_secondsCompute period base seconds for a game
dot-has_any_on_ice_player_idsIdentify populated on-ice player rows
dot-html_clocks_to_secondsConvert clocks to seconds
dot-html_desc_owner_team_idResolve the owner team from an HTML description
dot-html_event_code_to_type_descMap HTML event codes to event type keys
dot-html_extract_actor_player_idsExtract actor player IDs from an HTML event
dot-html_extract_tagged_playersExtract team-tagged player references from HTML
dot-html_pbp_report_urlBuild the HTML play-by-play report URL
dot-html_report_requestBuild an HTML report request
dot-html_shift_report_urlBuild the HTML shift report URL
dot-html_time_to_secondsConvert a clock duration to seconds
dot-lookup_roster_player_idResolve a roster player ID
dot-mask_strength_context_blockMask HTML on-ice columns on unsupported events
dot-match_html_pbp_to_apiMatch HTML play-by-play rows to API rows
dot-nhl_apiCall the NHL API
dot-nhldb_urlBuild a Hugging Face NHL_DB parquet URL
dot-nhl_json_from_responseParse an NHL API response as JSON
dot-nhl_requestBuild an NHL API request
dot-normalize_coordinatesNormalize the x and y coordinates for all the events (plays)...
dot-normalize_html_team_abbrevNormalize an HTML team abbreviation
dot-normalize_locale_namesNormalize locale-style dotted columns to camelCase
dot-normalize_public_pbp_namesNormalize raw/internal play-by-play names to the public...
dot-normalize_roster_personNormalize roster person labels
dot-normalize_situation_code_for_parseNormalize situation codes for parsing
dot-normalize_team_abbrev_colsNormalize team abbreviation columns to team tri-code names
dot-normalize_team_keyNormalize the team key
dot-on_ice_id_scalar_column_namesList on-ice player ID columns
dot-on_ice_int_colExtract an integer on-ice column
dot-on_ice_scalar_column_namesList all scalar on-ice columns
dot-on_ice_skater_slotsReturn the tracked number of on-ice skater slots
dot-on_ice_timing_scalar_column_namesBuild scalar on-ice timing column names
dot-open_share_pngOpen a PNG device for a share plot
dot-optional_html_pbp_rows_from_responseParse optional HTML on-ice rows from a parallel response
dot-pad_public_situation_codePad public situation codes
dot-parallel_request_failedCheck whether a parallel request failed
dot-parse_html_elapsed_clockParse an HTML elapsed clock
dot-parse_html_on_ice_cellParse an HTML on-ice cell
dot-parse_html_pbp_docParse an HTML play-by-play document
dot-parse_html_pbp_responseParse an HTML on-ice play-by-play response
dot-parse_html_period_labelParse an HTML period label
dot-parse_situation_code_componentsParse situation-code components
dot-pbp_delta_public_colsList public delta column names
dot-perform_parallel_requestsPerform multiple requests concurrently
dot-prepare_gc_public_pbp_playsPrepare raw GameCenter rows for public cleanup
dot-prepare_wsc_public_pbp_playsPrepare raw World Showcase rows for public cleanup
dot-public_pbp_is_shootout_eligibleIdentify shootout-eligible games for public play-by-play...
dot-public_pbp_legal_period_secondsDerive the legal period length in seconds
dot-read_remote_parquetDownload and read a remote parquet file
dot-repair_public_pbp_sequenceRepair public play-by-play clock/order defects in...
dot-request_with_retryAdd the package retry policy to a request
dot-require_public_pbp_columnsValidate required public play-by-play columns
dot-require_shift_chart_columnsValidate required shift-chart columns
dot-scope_person_name_colsScope generic person-name columns to an entity
dot-score_html_api_candidatesScore HTML-to-API matching candidates
dot-share_cumulative_titleBuild a cumulative xG title
dot-share_cumulative_xg_seriesBuild cumulative xG series
dot-share_filter_team_shotsFilter share shots to one team
dot-share_game_labelsRead game labels for share plots
dot-share_game_shotsFetch shot attempts with xG for a game
dot-share_plot_specBuild share-plot output settings
dot-share_shot_location_titleBuild a shot-location title
dot-share_team_keyNormalize share-plot team selector
dot-share_xg_scaleBuild xG color scaling metadata
dot-shift_situation_add_metadataAdd team and player metadata
dot-shift_situation_add_totalsAdd situation total columns
dot-shift_situation_base_summarySummarize player-period shift totals
dot-shift_situation_game_teamsIdentify game team IDs
dot-shift_situation_intervalsBuild shift-situation intervals
dot-shift_situation_lookup_colRead lookup column with fallback
dot-shift_situation_order_outputOrder shift-situation output columns
dot-shift_situation_overlapsIntersect shifts with situation intervals
dot-shift_situation_overlaps_in_rCompute shift-situation overlaps in R
dot-shift_situation_perspective_codeConvert situation codes to player-team perspective
dot-shift_situation_player_lookupBuild player metadata lookup
dot-shot_event_maskBuild a shot-event mask
dot-sort_shift_chart_for_timingSort shift data for timing lookups
dot-strip_game_idStrip the game ID into the season ID, game type ID, and game...
dot-strip_situation_codeStrip the situation code into goalie and skater counts, man...
dot-strip_time_periodStrip the timestamp and period number into the time elapsed...
dot-supported_html_on_ice_id_event_typesList HTML on-ice player-ID event types
dot-supported_strength_event_typesList strength-context event types
dot-to_game_type_idConvert to the appropriate game type ID
dot-xg_auto_downloadRead xG auto-download option
dot-xg_bake_matrixBake xG model matrix
dot-xg_booster_urlBuild xG booster URL
dot-xg_build_model_frameBuild xG model frame
dot-xg_build_skater_matrixBuild skater-slot matrix
dot-xg_bundle_pathLocate bundled xG metadata
dot-xg_bundle_versionBuild xG bundle cache version
dot-xg_cache_booster_pathResolve cached xG booster path
dot-xg_cached_booster_pathBuild cached xG booster path
dot-xg_cache_dirLocate xG cache directory
dot-xg_default_model_base_urlGet default xG model base URL
dot-xg_download_boosterDownload xG booster file
dot-xg_encode_categoricalEncode categorical xG feature
dot-xg_expected_booster_sha256Read expected xG booster checksum
dot-xg_extdata_dirLocate xG extdata directory
dot-xg_extract_matched_valueExtract matched skater-slot value
dot-xg_extract_slot_indicesExtract skater slot indices
dot-xg_fetch_shift_dataFetch shift data for xG features
dot-xg_fill_goalie_against_fallbackFill goalie-against fallback columns
dot-xg_is_inner_slot_shotFlag inner-slot shots
dot-xg_is_net_front_shotFlag net-front shots
dot-xg_is_slot_shotFlag slot shots
dot-xg_load_boosterLoad xG booster model
dot-xg_load_bundleLoad xG model bundle
dot-xg_make_type_desc_key_prevBuild previous event type key
dot-xg_model_base_urlRead xG model base URL option
dot-xg_model_index_rowFind xG model index row
dot-xg_model_keyBuild xG model key
dot-xg_normalize_missed_reasonNormalize xG missed-shot reason
dot-xg_normalize_shot_typeNormalize xG shot type
dot-xg_partition_shotsPartition shots by game state
dot-xg_percent_rankCompute xG percentile rank
dot-xg_prepare_play_by_playPrepare play-by-play for xG scoring
dot-xg_remote_booster_pathResolve remote xG booster path
dot-xg_require_current_public_schemaRequire current public play-by-play schema
dot-xg_required_shift_colsIdentify required xG shift columns
dot-xg_resolve_booster_pathResolve xG booster file path
dot-xg_row_maxCompute row maximums with missing values
dot-xg_row_meanCompute row means with missing values
dot-xg_row_medianCompute row medians with missing values
dot-xg_row_minCompute row minimums with missing values
dot-xg_score_xgboostScore shots with xGBoost
dot-xg_select_target_seasonSelect xG target season
dot-xg_to_logicalCoerce xG feature to logical
dot-xg_validate_booster_pathValidate xG booster path
dot-xg_validate_bundleValidate xG model bundle
dot-xg_verify_booster_fileVerify xG booster file checksum
dot-xg_warn_ignored_modelWarn about ignored xG model argument
draft_picksAccess all the draft picks
draft_prospectsAccess all the draft prospects
draft_rankingsAccess the draft rankings for a class and category
draftsAccess all the drafts
draft_trackerAccess the real-time draft tracker
draw_NHL_rinkDraw a full NHL rink
espn_futuresAccess the ESPN futures for a season
espn_game_oddsAccess the ESPN odds for a game
espn_gamesAccess the ESPN games for a season
espn_game_summaryAccess the ESPN summary for a game
espn_injuriesAccess the real-time ESPN injury reports
espn_play_by_playAccess the ESPN play-by-play for a game
espn_playersAccess all the ESPN players
espn_player_summaryAccess the ESPN summary for a player
espn_teamsAccess all the ESPN teams
espn_team_summaryAccess the ESPN summary for a team
espn_transactionsAccess the ESPN transactions for a season
expansion_draft_picksAccess all the expansion draft picks
expansion_draftsAccess all the expansion drafts
franchise_playoff_situational_resultsAccess the playoff series results for all the franchises by...
franchisesAccess all the franchises
franchise_season_statisticsAccess the statistics for all the franchises by season and...
franchise_statisticsAccess the all-time statistics for all the franchises by game...
franchise_team_statisticsAccess the all-time statistics for all the franchises by team...
franchise_versus_franchiseAccess the all-time statistics versus other franchises for...
game_oddsAccess the real-time game odds for a country by partnered...
game_rostersAccess the rosters for a game
gamesAccess all the games
game_type_nowAccess the game type as of now
gc_play_by_playAccess the GameCenter (GC) play-by-play for a game
gc_play_by_play_rawAccess the raw GameCenter (GC) play-by-play for a game
gc_play_by_playsAccess the GameCenter (GC) play-by-plays for a season
gc_play_by_plays_rawAccess the raw GameCenter (GC) play-by-plays for a season
gc_summaryAccess the GameCenter (GC) summary for a game
general_managersAccess all the general managers
get_attendanceAccess the attendance by season and game type
get_awardsAccess all the awards
get_award_winnersAccess all the award winners/finalists
get_bracketAccess the playoff bracket for a season
get_configurationAccess the configurations for team, skater, and goalie...
get_countriesAccess all the countries
get_draft_picksAccess all the draft picks
get_draft_rankingsAccess the draft rankings for a year and player type
get_draftsAccess all the drafts
get_draft_trackerAccess the real-time draft tracker
get_espn_athleteAccess the ESPN summary for an athlete (player) and season
get_espn_athletesAccess all the ESPN athletes (players)
get_espn_coachAccess the ESPN statistics for a coach and (multiple)...
get_espn_coach_careerAccess the career ESPN statistics for a coach
get_espn_coachesAccess the ESPN coaches for a season
get_espn_eventAccess the ESPN summary for an event (game)
get_espn_event_oddsAccess the ESPN odds for an event (game)
get_espn_event_officialsAccess the officials for an ESPN event (game)
get_espn_event_play_by_playAccess the ESPN play-by-play for an event (game)
get_espn_eventsAccess the ESPN events (games) by start and end dates
get_espn_event_starsAccess the three stars for an ESPN event (game)
get_espn_futuresAccess the ESPN futures for a season
get_espn_injuriesAccess the real-time ESPN injury reports
get_espn_teamAccess the ESPN summary for a team and season
get_espn_teamsAccess all the ESPN teams for a season
get_espn_transactionsAccess the ESPN transactions by start and end dates
get_franchisesAccess all the franchises
get_franchise_season_by_seasonAccess the statistics for all the franchises by season and...
get_franchise_team_totalsAccess the all-time statistics for all the franchises by team...
get_franchise_vs_franchiseAccess the all-time statistics versus other franchises for...
get_game_boxscoreAccess the boxscore for a game, team, and player type
get_game_landingAccess the GameCenter (GC) summary for a game
get_gamesAccess all the games
get_game_storyAccess the World Showcase (WSC) summary for a game
get_gc_play_by_playAccess the GameCenter (GC) play-by-play for a game
get_glossaryAccess the glossary
get_goalie_leadersAccess the goalie statistics leaders for a season, game type,...
get_goalie_milestonesAccess the goalies on milestone watch
get_goaliesAccess all the goalies for a range of seasons
get_goalie_statisticsAccess various reports for all the goalies by season or game
get_officialsAccess all the officials
get_partner_oddsAccess the real-time game odds for a country by partnered...
get_player_game_logAccess the game log for a player, season, and game type
get_player_landingAccess the summary for a player
get_playersAccess all the players
get_scheduleAccess the schedule for a date
get_scoreboardsAccess the scoreboards for a date
get_scoresAccess the scores for a date
get_season_nowAccess the season and game type as of now
get_seasonsAccess all the seasons
get_seriesAccess the playoff series for a season and round
get_series_scheduleAccess the playoff schedule for a season and series
get_shift_chartsAccess the shift charts for a game
get_skater_leadersAccess the skater statistics leaders for a season, game type,...
get_skater_milestonesAccess the skaters on milestone watch
get_skatersAccess all the skaters for a range of seasons
get_skater_statisticsAccess various reports for all the skaters by season or game
get_spotlight_playersAccess the spotlight players
get_standingsAccess the standings for a date
get_standings_informationAccess the standings rules by season
get_streamsAccess all the streams
get_team_prospectsAccess the prospects for a team and position
get_team_rosterAccess the roster for a team, season, and player type
get_team_roster_statisticsAccess the roster statistics for a team, season, game type,...
get_teamsAccess all the teams
get_team_scheduleAccess the schedule for a team and season
get_team_scoreboardAccess the team scoreboard as of now
get_team_seasonsAccess the season(s) and game type(s) in which a team played
get_team_statisticsAccess various reports for all the teams by season or game
get_tv_scheduleAccess the NHL Network TV schedule for a date
get_venuesAccess all the venues
get_wsc_play_by_playAccess the World Showcase (WSC) play-by-play for a game
glossaryAccess the glossary
goalie_edge_five_versus_fiveAccess the EDGE 5 vs. 5 statistics for a goalie, season, game...
goalie_edge_leadersAccess the goalie EDGE statistics leaders for a season and...
goalie_edge_save_percentageAccess the EDGE save percentage statistics for a goalie,...
goalie_edge_seasonsAccess the season(s) and game type(s) in which there exists...
goalie_edge_shot_locationAccess the EDGE shot location statistics for a goalie,...
goalie_edge_summaryAccess the EDGE summary for a goalie, season, and game type
goalie_game_reportAccess various reports for a season, game type, and category...
goalie_game_scoringAccess the scoring statistics for all the goalies by game
goalie_game_statisticsAccess the statistics for all the goalies by game
goalie_leadersAccess the goalie statistics leaders for a season, game type,...
goalie_milestonesAccess the goalies on milestone watch
goalie_regular_statisticsAccess the career regular season statistics for all the...
goalie_report_configurationsAccess the configurations for goalie reports
goalie_scoringAccess the career scoring statistics for all the goalies
goalie_season_reportAccess various reports for a season, game type, and category...
goalie_season_statisticsAccess the statistics for all the goalies by season, game...
goalie_series_statisticsAccess the playoff statistics for all the goalies by series
goalie_statisticsAccess the career statistics for all the goalies
ig_game_cumulative_expected_goalsSave an Instagram (IG) shareable cumulative expected goals...
ig_game_shot_locationsSave an Instagram (IG) shareable shot-location plot for a...
locationAccess the location for a zip code
lottery_oddsAccess the draft lottery odds
nhlscrapernhlscraper: Scrape, clean, and visualize NHL data
officialsAccess all the officials
penalty_shotsAccess all the penalty shots
pingPing
player_game_logAccess the game log for a player, season, and game type
playersAccess all the players
player_seasonsAccess the season(s) and game type(s) in which a player...
player_summaryAccess the summary for a player
playoff_season_statisticsAccess the playoff statistics by season
psAccess all the penalty shots
replayAccess the replay for an event
replaysAccess the replays for a season
rosterAccess the roster for a team, season, and position
roster_statisticsAccess the roster statistics for a team, season, game type,...
scheduleAccess the schedule for a date
scoresAccess the scores for a date
season_nowAccess the season as of now
seasonsAccess all the seasons
seriesAccess all the playoff series by game
series_scheduleAccess the playoff schedule for a season and series
shift_chartAccess the shift chart for a game
shift_chartsAccess the shift charts for a season
shift_chart_summariesAccess the shift chart summaries for a season
shift_chart_summaryAccess the shift chart time-on-ice summary for a game
shiftsAccess the shift charts for a game
skater_edge_leadersAccess the skater EDGE statistics leaders for a season and...
skater_edge_seasonsAccess the season(s) and game type(s) in which there exists...
skater_edge_shot_locationAccess the EDGE shot location statistics for a skater,...
skater_edge_shot_speedAccess the EDGE shot speed statistics for a skater, season,...
skater_edge_skating_distanceAccess the EDGE skating distance statistics for a skater,...
skater_edge_skating_speedAccess the EDGE skating speed statistics for a skater,...
skater_edge_summaryAccess the EDGE summary for a skater, season, and game type
skater_edge_zone_timeAccess the EDGE zone time statistics for a skater, season,...
skater_game_reportAccess various reports for a season, game type, and category...
skater_leadersAccess the skater statistics leaders for a season, game type,...
skater_milestonesAccess the skaters on milestone watch
skater_playoff_statisticsAccess the career playoff statistics for all the skaters
skater_regular_statisticsAccess the career regular season statistics for all the...
skater_report_configurationsAccess the configurations for skater reports
skater_season_reportAccess various reports for a season, game type, and category...
skater_season_statisticsAccess the statistics for all the skaters by season, game...
skater_series_statisticsAccess the playoff statistics for all the skaters by series
skater_statisticsAccess the career statistics for all the skaters
spotlight_playersAccess the spotlight players
standingsAccess the standings for a date
standings_rulesAccess the standings rules by season
streamsAccess all the streams
team_edge_leadersAccess the team EDGE statistics leaders for a season and game...
team_edge_seasonsAccess the season(s) and game type(s) in which there exists...
team_edge_shot_locationAccess the EDGE shot location statistics for a team, season,...
team_edge_shot_speedAccess the EDGE shot speed statistics for a team, season,...
team_edge_skating_distanceAccess the EDGE skating distance statistics for a team,...
team_edge_skating_speedAccess the EDGE skating speed statistics for a team, season,...
team_edge_summaryAccess the EDGE summary for a team, season, and game type
team_edge_zone_timeAccess the EDGE zone time statistics for a team, season, game...
team_game_reportAccess various reports for a season, game type, and category...
team_logosAccess all the team logos
team_month_scheduleAccess the schedule for a team and month
team_prospectsAccess the prospects for a team and position
team_report_configurationsAccess the configurations for team reports
teamsAccess all the teams
team_season_reportAccess various reports for a season, game type, and category...
team_seasonsAccess the season(s) and game type(s) in which a team played
team_season_scheduleAccess the schedule for a team and season
team_season_statisticsAccess the statistics for all the teams by season and game...
team_week_scheduleAccess the schedule for a team and week since a date
tv_scheduleAccess the NHL Network TV schedule for a date
venuesAccess all the venues
wsc_play_by_playAccess the World Showcase (WSC) play-by-play for a game
wsc_play_by_play_rawAccess the raw World Showcase (WSC) play-by-play for a game
wsc_play_by_playsAccess the World Showcase (WSC) play-by-plays for a season
wsc_play_by_plays_rawAccess the raw World Showcase (WSC) play-by-plays for a...
wsc_summaryAccess the World Showcase (WSC) summary for a game
x_game_cumulative_expected_goalsSave an X (Twitter) shareable cumulative expected goals (xG)...
x_game_shot_locationsSave an X (Twitter) shareable shot-location plot for a game
nhlscraper documentation built on June 29, 2026, 1:06 a.m.