# Scraper for National Hockey League Data

## Documentation for package ‘nhlscraper’ version 0.5.0

- DESCRIPTION file
- User guides, package vignettes and other documentation
- Package NEWS
- Package README

## Help Pages

A B C D E F G I L O P R S T V W X

## -- A --

add_goalie_biometrics | Add goalie biometrics to (a) play-by-play(s)
add_on_ice_players | Add on-ice player IDs to a play-by-play by merging with shift charts
add_shooter_biometrics | Add shooter biometrics to (a) play-by-play(s)
attendance | Access the attendance by season and game type
awards | Access all the awards
award_winners | Access all the award winners/finalists

## -- B --

boxscore | Access the boxscore for a game, team, and position
bracket | Access the playoff bracket for a season

## -- C --

calculate_expected_goals | Calculate the expected goals for all the shots in (a) play-by-plays
calculate_speed | Calculate event-to-event deltas and speeds in normalized x/y, distance, and angle for a play-by-play
calculate_xG | Calculate the expected goals for all the shots in (a) play-by-plays
coaches | Access all the coaches
coach_career_statistics | Access the career statistics for all the coaches
coach_career_stats | Access the career statistics for all the coaches
coach_franchise_statistics | Access the statistics for all the coaches by franchise and game type
coach_franchise_stats | Access the statistics for all the coaches by franchise and game type
combine_reports | Access the draft combine reports
contracts | Access all contracts from packaged internal data
countries | Access all the countries

## -- D --

drafts | Access all the drafts
draft_picks | Access all the draft picks
draft_prospects | Access all the draft prospects
draft_rankings | Access the draft rankings for a class and category
draft_tracker | Access the real-time draft tracker
draw_NHL_rink | Draw a full NHL rink

## -- E --

espn_futures | Access the ESPN futures for a season
espn_games | Access the ESPN games for a season
espn_game_odds | Access the ESPN odds for a game
espn_game_summary | Access the ESPN summary for a game
espn_injuries | Access the real-time ESPN injury reports
espn_pbp | Access the ESPN play-by-play for a game
espn_players | Access all the ESPN players
espn_player_summary | Access the ESPN summary for a player
espn_play_by_play | Access the ESPN play-by-play for a game
espn_teams | Access all the ESPN teams
espn_team_summary | Access the ESPN summary for a team
espn_transactions | Access the ESPN transactions for a season
expansion_drafts | Access all the expansion drafts
expansion_draft_picks | Access all the expansion draft picks

## -- F --

franchises | Access all the franchises
franchise_playoff_situational_results | Access the playoff series results for all the franchises by situation
franchise_season_statistics | Access the statistics for all the franchises by season and game type
franchise_season_stats | Access the statistics for all the franchises by season and game type
franchise_statistics | Access the all-time statistics for all the franchises by game type
franchise_stats | Access the all-time statistics for all the franchises by game type
franchise_team_statistics | Access the all-time statistics for all the franchises by team and game type
franchise_team_stats | Access the all-time statistics for all the franchises by team and game type
franchise_versus_franchise | Access the all-time statistics versus other franchises for all the franchises by game type
franchise_vs_franchise | Access the all-time statistics versus other franchises for all the franchises by game type

## -- G --

games | Access all the games
game_odds | Access the real-time game odds for a country by partnered bookmaker
game_rosters | Access the rosters for a game
game_type_now | Access the game type as of now
gc_pbp | Access the GameCenter (GC) play-by-play for a game
gc_pbps | Access the GameCenter (GC) play-by-plays for a season
gc_play_by_play | Access the GameCenter (GC) play-by-play for a game
gc_play_by_plays | Access the GameCenter (GC) play-by-plays for a season
gc_summary | Access the GameCenter (GC) summary for a game
general_managers | Access all the general managers
get_attendance | Access the attendance by season and game type
get_awards | Access all the awards
get_award_winners | Access all the award winners/finalists
get_bracket | Access the playoff bracket for a season
get_configuration | Access the configurations for team, skater, and goalie reports
get_countries | Access all the countries
get_drafts | Access all the drafts
get_draft_picks | Access all the draft picks
get_draft_rankings | Access the draft rankings for a year and player type
get_draft_tracker | Access the real-time draft tracker
get_espn_athlete | Access the ESPN summary for an athlete (player) and season
get_espn_athletes | Access all the ESPN athletes (players)
get_espn_coach | Access the ESPN statistics for a coach and (multiple) season(s)
get_espn_coaches | Access the ESPN coaches for a season
get_espn_coach_career | Access the career ESPN statistics for a coach
get_espn_event | Access the ESPN summary for an event (game)
get_espn_events | Access the ESPN events (games) by start and end dates
get_espn_event_odds | Access the ESPN odds for an event (game)
get_espn_event_officials | Access the officials for an ESPN event (game)
get_espn_event_play_by_play | Access the ESPN play-by-play for an event (game)
get_espn_event_stars | Access the three stars for an ESPN event (game)
get_espn_futures | Access the ESPN futures for a season
get_espn_injuries | Access the real-time ESPN injury reports
get_espn_team | Access the ESPN summary for a team and season
get_espn_teams | Access all the ESPN teams for a season
get_espn_transactions | Access the ESPN transactions by start and end dates
get_franchises | Access all the franchises
get_franchise_season_by_season | Access the statistics for all the franchises by season and game type
get_franchise_team_totals | Access the all-time statistics for all the franchises by team and game type
get_franchise_vs_franchise | Access the all-time statistics versus other franchises for all the franchises by game type
get_games | Access all the games
get_game_boxscore | Access the boxscore for a game, team, and player type
get_game_landing | Access the GameCenter (GC) summary for a game
get_game_story | Access the World Showcase (WSC) summary for a game
get_gc_play_by_play | Access the GameCenter (GC) play-by-play for a game
get_glossary | Access the glossary
get_goalies | Access all the goalies for a range of seasons
get_goalie_leaders | Access the goalie statistics leaders for a season, game type, and category
get_goalie_milestones | Access the goalies on milestone watch
get_goalie_statistics | Access various reports for all the goalies by season or game
get_officials | Access all the officials
get_partner_odds | Access the real-time game odds for a country by partnered bookmaker
get_players | Access all the players
get_player_game_log | Access the game log for a player, season, and game type
get_player_landing | Access the summary for a player
get_schedule | Access the schedule for a date
get_scoreboards | Access the scoreboards for a date
get_scores | Access the scores for a date
get_seasons | Access all the seasons
get_season_now | Access the season and game type as of now
get_series | Access the playoff series for a season and round
get_series_schedule | Access the playoff schedule for a season and series
get_shift_charts | Access the shift charts for a game
get_skaters | Access all the skaters for a range of seasons
get_skater_leaders | Access the skater statistics leaders for a season, game type, and category
get_skater_milestones | Access the skaters on milestone watch
get_skater_statistics | Access various reports for all the skaters by season or game
get_spotlight_players | Access the spotlight players
get_standings | Access the standings for a date
get_standings_information | Access the standings rules by season
get_streams | Access all the streams
get_teams | Access all the teams
get_team_prospects | Access the prospects for a team and position
get_team_roster | Access the roster for a team, season, and player type
get_team_roster_statistics | Access the roster statistics for a team, season, game type, and player type
get_team_schedule | Access the schedule for a team and season
get_team_scoreboard | Access the team scoreboard as of now
get_team_seasons | Access the season(s) and game type(s) in which a team played
get_team_statistics | Access various reports for all the teams by season or game
get_tv_schedule | Access the NHL Network TV schedule for a date
get_venues | Access all the venues
get_wsc_play_by_play | Access the World Showcase (WSC) play-by-play for a game
glossary | Access the glossary
gms | Access all the general managers
goalie_edge_5_vs_5 | Access the EDGE 5 vs. 5 statistics for a goalie, season, game type, and category
goalie_edge_five_versus_five | Access the EDGE 5 vs. 5 statistics for a goalie, season, game type, and category
goalie_edge_leaders | Access the goalie EDGE statistics leaders for a season and game type
goalie_edge_save_percentage | Access the EDGE save percentage statistics for a goalie, season, game type, and category
goalie_edge_seasons | Access the season(s) and game type(s) in which there exists goalie EDGE statistics
goalie_edge_shot_location | Access the EDGE shot location statistics for a goalie, season, game type, and category
goalie_edge_summary | Access the EDGE summary for a goalie, season, and game type
goalie_game_report | Access various reports for a season, game type, and category for all the goalies by game
goalie_game_scoring | Access the scoring statistics for all the goalies by game
goalie_game_statistics | Access the statistics for all the goalies by game
goalie_game_stats | Access the statistics for all the goalies by game
goalie_leaders | Access the goalie statistics leaders for a season, game type, and category
goalie_milestones | Access the goalies on milestone watch
goalie_regular_statistics | Access the career regular season statistics for all the goalies
goalie_regular_stats | Access the career regular season statistics for all the goalies
goalie_report_configs | Access the configurations for goalie reports
goalie_report_configurations | Access the configurations for goalie reports
goalie_scoring | Access the career scoring statistics for all the goalies
goalie_season_report | Access various reports for a season, game type, and category for all the goalies by season
goalie_season_statistics | Access the statistics for all the goalies by season, game type, and team.
goalie_season_stats | Access the statistics for all the goalies by season, game type, and team.
goalie_series_statistics | Access the playoff statistics for all the goalies by series
goalie_series_stats | Access the playoff statistics for all the goalies by series
goalie_statistics | Access the career statistics for all the goalies
goalie_stats | Access the career statistics for all the goalies

## -- I --

ig_game_cumulative_expected_goals | Save an Instagram (IG) share-able cumulative expected goals (xG) time-series plot for a game
ig_game_cum_xG | Save an Instagram (IG) share-able cumulative expected goals (xG) time-series plot for a game
ig_game_shot_locations | Save an Instagram (IG) share-able shot-location plot for a game
ig_game_shot_locs | Save an Instagram (IG) share-able shot-location plot for a game

## -- L --

location | Access the location for a zip code
lottery_odds | Access the draft lottery odds

## -- O --

officials | Access all the officials

## -- P --

penalty_shots | Access all the penalty shots
ping | Ping
players | Access all the players
player_game_log | Access the game log for a player, season, and game type
player_seasons | Access the season(s) and game type(s) in which a player played
player_summary | Access the summary for a player
playoff_season_statistics | Access the playoff statistics by season
playoff_season_stats | Access the playoff statistics by season
ps | Access all the penalty shots
pss | Access all the penalty shots

## -- R --

replay | Access the replay for an event
roster | Access the roster for a team, season, and position
roster_statistics | Access the roster statistics for a team, season, game type, and position
roster_stats | Access the roster statistics for a team, season, game type, and position

## -- S --

schedule | Access the schedule for a date
scores | Access the scores for a date
seasons | Access all the seasons
season_now | Access the season as of now
series | Access all the playoff series by game
series_schedule | Access the playoff schedule for a season and series
shifts | Access the shift charts for a game
shift_chart | Access the shift chart for a game
shift_charts | Access the shift charts for a season
skater_edge_leaders | Access the skater EDGE statistics leaders for a season and game type
skater_edge_seasons | Access the season(s) and game type(s) in which there exists skater EDGE statistics
skater_edge_shot_location | Access the EDGE shot location statistics for a skater, season, game type, and category
skater_edge_shot_speed | Access the EDGE shot speed statistics for a skater, season, game type, and category
skater_edge_skating_distance | Access the EDGE skating distance statistics for a skater, season, game type, and category
skater_edge_skating_speed | Access the EDGE skating speed statistics for a skater, season, game type, and category
skater_edge_summary | Access the EDGE summary for a skater, season, and game type
skater_edge_zone_time | Access the EDGE zone time statistics for a skater, season, game type, and category
skater_game_report | Access various reports for a season, game type, and category for all the skaters by game
skater_leaders | Access the skater statistics leaders for a season, game type, and category
skater_milestones | Access the skaters on milestone watch
skater_playoff_statistics | Access the career playoff statistics for all the skaters
skater_playoff_stats | Access the career playoff statistics for all the skaters
skater_regular_statistics | Access the career regular season statistics for all the skaters
skater_regular_stats | Access the career regular season statistics for all the skaters
skater_report_configs | Access the configurations for skater reports
skater_report_configurations | Access the configurations for skater reports
skater_season_report | Access various reports for a season, game type, and category for all the skaters by season
skater_season_statistics | Access the statistics for all the skaters by season, game type, and team
skater_season_stats | Access the statistics for all the skaters by season, game type, and team
skater_series_statistics | Access the playoff statistics for all the skaters by series
skater_series_stats | Access the playoff statistics for all the skaters by series
skater_statistics | Access the career statistics for all the skaters
skater_stats | Access the career statistics for all the skaters
spotlight_players | Access the spotlight players
standings | Access the standings for a date
standings_rules | Access the standings rules by season
streams | Access all the streams

## -- T --

teams | Access all the teams
team_edge_leaders | Access the team EDGE statistics leaders for a season and game type
team_edge_seasons | Access the season(s) and game type(s) in which there exists team EDGE statistics
team_edge_shot_location | Access the EDGE shot location statistics for a team, season, game type, and category
team_edge_shot_speed | Access the EDGE shot speed statistics for a team, season, game type, and category
team_edge_skating_distance | Access the EDGE skating distance statistics for a team, season, game type, and category
team_edge_skating_speed | Access the EDGE skating speed statistics for a team, season, game type, and category
team_edge_summary | Access the EDGE summary for a team, season, and game type
team_edge_zone_time | Access the EDGE zone time statistics for a team, season, game type, and category
team_game_report | Access various reports for a season, game type, and category for all the teams by game
team_logos | Access all the team logos
team_month_schedule | Access the schedule for a team and month
team_prospects | Access the prospects for a team and position
team_report_configs | Access the configurations for team reports
team_report_configurations | Access the configurations for team reports
team_seasons | Access the season(s) and game type(s) in which a team played
team_season_report | Access various reports for a season, game type, and category for all the teams by season
team_season_schedule | Access the schedule for a team and season
team_season_statistics | Access the statistics for all the teams by season and game type
team_season_stats | Access the statistics for all the teams by season and game type
team_week_schedule | Access the schedule for a team and week since a date
tv_schedule | Access the NHL Network TV schedule for a date

## -- V --

venues | Access all the venues

## -- W --

wsc_pbp | Access the World Showcase (WSC) play-by-play for a game
wsc_pbps | Access the World Showcase (WSC) play-by-plays for a season
wsc_play_by_play | Access the World Showcase (WSC) play-by-play for a game
wsc_play_by_plays | Access the World Showcase (WSC) play-by-plays for a season
wsc_summary | Access the World Showcase (WSC) summary for a game

## -- X --

x_game_cumulative_expected_goals | Save an X (Twitter) share-able cumulative expected goals (xG) time-series plot for a game
x_game_cum_xG | Save an X (Twitter) share-able cumulative expected goals (xG) time-series plot for a game
x_game_shot_locations | Save an X (Twitter) share-able shot-location plot for a game
x_game_shot_locs | Save an X (Twitter) share-able shot-location plot for a game