Man pages for nhlscraper
Scraper for National Hockey League Data

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_angleCalculate the Euclidean angle from the attacking net for all...
calculate_distanceCalculate the Euclidean distance from the attacking net for...
calculate_expected_goals_v1Calculate version 1 of the expected goals for all the events...
calculate_expected_goals_v2Calculate version 2 of the expected goals for all the events...
calculate_expected_goals_v3Calculate version 3 of the expected goals for all the events...
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
count_goals_shotsCount the as-of-event goal, shots on goal, Fenwick, and Corsi...
countriesAccess all the countries
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
draw_rink_arcDraw an arc on the rink
draw_rink_circleDraw a circle on the rink
espn_apiCall the ESPN API with 429 (rate limit) error-handling
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
flag_is_homeFlag if the event belongs to the home team or not for all the...
flag_is_reboundFlag if the shot attempt is a rebound attempt or not for all...
flag_is_rushFlag if the shot attempt is a rush attempt or not for all the...
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_playsAccess the 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) share-able cumulative expected goals...
ig_game_shot_locationsSave an Instagram (IG) share-able shot-location plot for a...
locationAccess the location for a zip code
lottery_oddsAccess the draft lottery odds
nhl_apiCall the NHL API with 429 (rate limit) error-handling
normalize_coordinatesNormalize the x and y coordinates for all the events (plays)...
normalize_team_keyNormalize the team key
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
replayAccess the replay for an event
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
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
strip_game_idStrip the game ID into the season ID, game type ID, and game...
strip_situation_codeStrip the situation code into goalie and skater counts, man...
strip_time_periodStrip the timestamp and period number into the time elapsed...
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
to_game_type_idConvert to the appropriate game type ID
to_team_idConvert to the appropriate team ID
to_team_tri_codeConvert to the appropriate team three-letter code
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_playsAccess the World Showcase (WSC) play-by-plays for a season
wsc_summaryAccess the World Showcase (WSC) summary for a game
x_game_cumulative_expected_goalsSave an X (Twitter) share-able cumulative expected goals (xG)...
x_game_shot_locationsSave an X (Twitter) share-able shot-location plot for a game
nhlscraper documentation built on Dec. 17, 2025, 5:10 p.m.