API for nhlscraper
Scraper for National Hockey League Data

Global functions
.add_empty_html_on_ice_columns Man page Source code
.add_html_on_ice_players Man page Source code
.add_on_ice_shift_timing_context Man page Source code
.add_one_on_one_on_ice_players Man page Source code
.api_request Man page Source code
.apply_pbp_delta_columns Man page Source code
.apply_shot_context Man page Source code
.assign_html_on_ice_player_ids Man page Source code
.assign_on_ice_shift_metric Man page Source code
.backfill_delayed_penalty_on_ice_players Man page Source code
.build_api_html_match_table Man page Source code
.build_game_roster_lookup Man page Source code
.calculate_angle Man page Source code
.calculate_distance Man page Source code
.calculate_shift_times_by_situation_data Man page Source code
.clean_public_pbp_plays Man page Source code
.coerce_team_id Man page Source code
.coerce_team_tri_code Man page Source code
.compute_on_ice_shift_timing_in_r Man page Source code
.compute_on_ice_shift_timing_matrices Man page Source code
.compute_pbp_deltas Man page Source code
.compute_pbp_deltas_in_r Man page Source code
.compute_shot_context Man page Source code
.count_goals_shots Man page Source code
.covid_round_robin_shootout_game_ids Man page Source code
.dot_to_camel Man page Source code
.draw_rink_arc Man page Source code
.draw_rink_circle Man page Source code
.draw_share_cumulative_xg Man page Source code
.draw_share_shot_legends Man page Source code
.draw_share_shot_locations Man page Source code
.drop_illogical_ordered_events Man page Source code
.empty_pbp_delta_context Man page Source code
.empty_public_pbp_column Man page Source code
.ensure_local_native_symbol Man page Source code
.espn_api Man page Source code
.extract_html_clock Man page Source code
.fetch_html_pbp_on_ice Man page Source code
.finalize_pbp_output Man page Source code
.flag_is_home Man page Source code
.flag_is_rebound Man page Source code
.flag_is_rush Man page Source code
.format_elapsed_clock Man page Source code
.format_html_shift_clock Man page Source code
.game_period_base_seconds Man page Source code
.has_any_on_ice_player_ids Man page Source code
.html_clocks_to_seconds Man page Source code
.html_desc_owner_team_id Man page Source code
.html_event_code_to_type_desc Man page Source code
.html_extract_actor_player_ids Man page Source code
.html_extract_tagged_players Man page Source code
.html_pbp_report_url Man page Source code
.html_report_request Man page Source code
.html_shift_report_url Man page Source code
.html_time_to_seconds Man page Source code
.lookup_roster_player_id Man page Source code
.mask_strength_context_block Man page Source code
.match_html_pbp_to_api Man page Source code
.nhl_api Man page Source code
.nhl_json_from_response Man page Source code
.nhl_request Man page Source code
.nhldb_url Man page Source code
.normalize_coordinates Man page Source code
.normalize_html_team_abbrev Man page Source code
.normalize_locale_names Man page Source code
.normalize_public_pbp_names Man page Source code
.normalize_roster_person Man page Source code
.normalize_situation_code_for_parse Man page Source code
.normalize_team_abbrev_cols Man page Source code
.normalize_team_key Man page Source code
.on_ice_id_scalar_column_names Man page Source code
.on_ice_int_col Man page Source code
.on_ice_scalar_column_names Man page Source code
.on_ice_skater_slots Man page Source code
.on_ice_timing_scalar_column_names Man page Source code
.open_share_png Man page Source code
.optional_html_pbp_rows_from_response Man page Source code
.pad_public_situation_code Man page Source code
.parallel_request_failed Man page Source code
.parse_html_elapsed_clock Man page Source code
.parse_html_on_ice_cell Man page Source code
.parse_html_pbp_doc Man page Source code
.parse_html_pbp_response Man page Source code
.parse_html_period_label Man page Source code
.parse_situation_code_components Man page Source code
.pbp_delta_public_cols Man page Source code
.perform_parallel_requests Man page Source code
.prepare_gc_public_pbp_plays Man page Source code
.prepare_wsc_public_pbp_plays Man page Source code
.public_pbp_is_shootout_eligible Man page Source code
.public_pbp_legal_period_seconds Man page Source code
.read_remote_parquet Man page Source code
.repair_public_pbp_sequence Man page Source code
.request_with_retry Man page Source code
.require_public_pbp_columns Man page Source code
.require_shift_chart_columns Man page Source code
.scope_person_name_cols Man page Source code
.score_html_api_candidates Man page Source code
.share_cumulative_title Man page Source code
.share_cumulative_xg_series Man page Source code
.share_filter_team_shots Man page Source code
.share_game_labels Man page Source code
.share_game_shots Man page Source code
.share_plot_spec Man page Source code
.share_shot_location_title Man page Source code
.share_team_key Man page Source code
.share_xg_scale Man page Source code
.shift_situation_add_metadata Man page Source code
.shift_situation_add_totals Man page Source code
.shift_situation_base_summary Man page Source code
.shift_situation_game_teams Man page Source code
.shift_situation_intervals Man page Source code
.shift_situation_lookup_col Man page Source code
.shift_situation_order_output Man page Source code
.shift_situation_overlaps Man page Source code
.shift_situation_overlaps_in_r Man page Source code
.shift_situation_perspective_code Man page Source code
.shift_situation_player_lookup Man page Source code
.shot_event_mask Man page Source code
.sort_shift_chart_for_timing Man page Source code
.strip_game_id Man page Source code
.strip_situation_code Man page Source code
.strip_time_period Man page Source code
.supported_html_on_ice_id_event_types Man page Source code
.supported_strength_event_types Man page Source code
.to_game_type_id Man page Source code
.xg_auto_download Man page Source code
.xg_bake_matrix Man page Source code
.xg_booster_url Man page Source code
.xg_build_model_frame Man page Source code
.xg_build_skater_matrix Man page Source code
.xg_bundle_path Man page Source code
.xg_bundle_version Man page Source code
.xg_cache_booster_path Man page Source code
.xg_cache_dir Man page Source code
.xg_cached_booster_path Man page Source code
.xg_default_model_base_url Man page Source code
.xg_download_booster Man page Source code
.xg_encode_categorical Man page Source code
.xg_expected_booster_sha256 Man page Source code
.xg_extdata_dir Man page Source code
.xg_extract_matched_value Man page Source code
.xg_extract_slot_indices Man page Source code
.xg_fetch_shift_data Man page Source code
.xg_fill_goalie_against_fallback Man page Source code
.xg_is_inner_slot_shot Man page Source code
.xg_is_net_front_shot Man page Source code
.xg_is_slot_shot Man page Source code
.xg_load_booster Man page Source code
.xg_load_bundle Man page Source code
.xg_make_type_desc_key_prev Man page Source code
.xg_model_base_url Man page Source code
.xg_model_index_row Man page Source code
.xg_model_key Man page Source code
.xg_normalize_missed_reason Man page Source code
.xg_normalize_shot_type Man page Source code
.xg_partition_shots Man page Source code
.xg_percent_rank Man page Source code
.xg_prepare_play_by_play Man page Source code
.xg_remote_booster_path Man page Source code
.xg_require_current_public_schema Man page Source code
.xg_required_shift_cols Man page Source code
.xg_resolve_booster_path Man page Source code
.xg_row_max Man page Source code
.xg_row_mean Man page Source code
.xg_row_median Man page Source code
.xg_row_min Man page Source code
.xg_score_xgboost Man page Source code
.xg_select_target_season Man page Source code
.xg_to_logical Man page Source code
.xg_validate_booster_path Man page Source code
.xg_validate_bundle Man page Source code
.xg_verify_booster_file Man page Source code
.xg_warn_ignored_model Man page Source code
add_deltas Man page Source code
add_goalie_biometrics Man page Source code
add_shift_times Man page Source code
add_shooter_biometrics Man page Source code
attendance Man page Source code
award_winners Man page Source code
awards Man page Source code
boxscore Man page Source code
bracket Man page Source code
calculate_expected_goals Man page Source code
calculate_shift_times_by_situation Man page Source code
calculate_xG Man page Source code
coach_career_statistics Man page Source code
coach_career_stats Man page Source code
coach_franchise_statistics Man page Source code
coach_franchise_stats Man page Source code
coaches Man page Source code
combine_reports Man page Source code
contracts Man page Source code
countries Man page Source code
draft_picks Man page Source code
draft_prospects Man page Source code
draft_rankings Man page Source code
draft_tracker Man page Source code
drafts Man page Source code
draw_NHL_rink Man page Source code
espn_futures Man page Source code
espn_game_odds Man page Source code
espn_game_summary Man page Source code
espn_games Man page Source code
espn_injuries Man page Source code
espn_pbp Man page Source code
espn_play_by_play Man page Source code
espn_player_summary Man page Source code
espn_players Man page Source code
espn_team_summary Man page Source code
espn_teams Man page Source code
espn_transactions Man page Source code
expansion_draft_picks Man page Source code
expansion_drafts Man page Source code
franchise_playoff_situational_results Man page Source code
franchise_season_statistics Man page Source code
franchise_season_stats Man page Source code
franchise_statistics Man page Source code
franchise_stats Man page Source code
franchise_team_statistics Man page Source code
franchise_team_stats Man page Source code
franchise_versus_franchise Man page Source code
franchise_vs_franchise Man page Source code
franchises Man page Source code
game_odds Man page Source code
game_rosters Man page Source code
game_type_now Man page Source code
games Man page Source code
gc_pbp Man page Source code
gc_pbp_raw Man page Source code
gc_pbps Man page Source code
gc_pbps_raw Man page Source code
gc_play_by_play Man page Source code
gc_play_by_play_raw Man page Source code
gc_play_by_plays Man page Source code
gc_play_by_plays_raw Man page Source code
gc_summary Man page Source code
general_managers Man page Source code
get_attendance Man page Source code
get_award_winners Man page Source code
get_awards Man page Source code
get_bracket Man page Source code
get_configuration Man page Source code
get_countries Man page Source code
get_draft_picks Man page Source code
get_draft_rankings Man page Source code
get_draft_tracker Man page Source code
get_drafts Man page Source code
get_espn_athlete Man page Source code
get_espn_athletes Man page Source code
get_espn_coach Man page Source code
get_espn_coach_career Man page Source code
get_espn_coaches Man page Source code
get_espn_event Man page Source code
get_espn_event_odds Man page Source code
get_espn_event_officials Man page Source code
get_espn_event_play_by_play Man page Source code
get_espn_event_stars Man page Source code
get_espn_events Man page Source code
get_espn_futures Man page Source code
get_espn_injuries Man page Source code
get_espn_team Man page Source code
get_espn_teams Man page Source code
get_espn_transactions Man page Source code
get_franchise_season_by_season Man page Source code
get_franchise_team_totals Man page Source code
get_franchise_vs_franchise Man page Source code
get_franchises Man page Source code
get_game_boxscore Man page Source code
get_game_landing Man page Source code
get_game_story Man page Source code
get_games Man page Source code
get_gc_play_by_play Man page Source code
get_glossary Man page Source code
get_goalie_leaders Man page Source code
get_goalie_milestones Man page Source code
get_goalie_statistics Man page Source code
get_goalies Man page Source code
get_officials Man page Source code
get_partner_odds Man page Source code
get_player_game_log Man page Source code
get_player_landing Man page Source code
get_players Man page Source code
get_schedule Man page Source code
get_scoreboards Man page Source code
get_scores Man page Source code
get_season_now Man page Source code
get_seasons Man page Source code
get_series Man page Source code
get_series_schedule Man page Source code
get_shift_charts Man page Source code
get_skater_leaders Man page Source code
get_skater_milestones Man page Source code
get_skater_statistics Man page Source code
get_skaters Man page Source code
get_spotlight_players Man page Source code
get_standings Man page Source code
get_standings_information Man page Source code
get_streams Man page Source code
get_team_prospects Man page Source code
get_team_roster Man page Source code
get_team_roster_statistics Man page Source code
get_team_schedule Man page Source code
get_team_scoreboard Man page Source code
get_team_seasons Man page Source code
get_team_statistics Man page Source code
get_teams Man page Source code
get_tv_schedule Man page Source code
get_venues Man page Source code
get_wsc_play_by_play Man page Source code
glossary Man page Source code
gms Man page Source code
goalie_edge_5_vs_5 Man page Source code
goalie_edge_five_versus_five Man page Source code
goalie_edge_leaders Man page Source code
goalie_edge_save_percentage Man page Source code
goalie_edge_seasons Man page Source code
goalie_edge_shot_location Man page Source code
goalie_edge_summary Man page Source code
goalie_game_report Man page Source code
goalie_game_scoring Man page Source code
goalie_game_statistics Man page Source code
goalie_game_stats Man page Source code
goalie_leaders Man page Source code
goalie_milestones Man page Source code
goalie_regular_statistics Man page Source code
goalie_regular_stats Man page Source code
goalie_report_configs Man page Source code
goalie_report_configurations Man page Source code
goalie_scoring Man page Source code
goalie_season_report Man page Source code
goalie_season_statistics Man page Source code
goalie_season_stats Man page Source code
goalie_series_statistics Man page Source code
goalie_series_stats Man page Source code
goalie_statistics Man page Source code
goalie_stats Man page Source code
ig_game_cum_xG Man page Source code
ig_game_cumulative_expected_goals Man page Source code
ig_game_shot_locations Man page Source code
ig_game_shot_locs Man page Source code
location Man page Source code
lottery_odds Man page Source code
nhlscraper Man page
nhlscraper-package Man page
officials Man page Source code
penalty_shots Man page Source code
ping Man page Source code
player_game_log Man page Source code
player_seasons Man page Source code
player_summary Man page Source code
players Man page Source code
playoff_season_statistics Man page Source code
playoff_season_stats Man page Source code
ps Man page Source code
pss Man page Source code
replay Man page Source code
replays Man page Source code
roster Man page Source code
roster_statistics Man page Source code
roster_stats Man page Source code
schedule Man page Source code
scores Man page Source code
season_now Man page Source code
seasons Man page Source code
series Man page Source code
series_schedule Man page Source code
shift_chart Man page Source code
shift_chart_summaries Man page Source code
shift_chart_summary Man page Source code
shift_charts Man page Source code
shifts Man page Source code
skater_edge_leaders Man page Source code
skater_edge_seasons Man page Source code
skater_edge_shot_location Man page Source code
skater_edge_shot_speed Man page Source code
skater_edge_skating_distance Man page Source code
skater_edge_skating_speed Man page Source code
skater_edge_summary Man page Source code
skater_edge_zone_time Man page Source code
skater_game_report Man page Source code
skater_leaders Man page Source code
skater_milestones Man page Source code
skater_playoff_statistics Man page Source code
skater_playoff_stats Man page Source code
skater_regular_statistics Man page Source code
skater_regular_stats Man page Source code
skater_report_configs Man page Source code
skater_report_configurations Man page Source code
skater_season_report Man page Source code
skater_season_statistics Man page Source code
skater_season_stats Man page Source code
skater_series_statistics Man page Source code
skater_series_stats Man page Source code
skater_statistics Man page Source code
skater_stats Man page Source code
spotlight_players Man page Source code
standings Man page Source code
standings_rules Man page Source code
streams Man page Source code
team_edge_leaders Man page Source code
team_edge_seasons Man page Source code
team_edge_shot_location Man page Source code
team_edge_shot_speed Man page Source code
team_edge_skating_distance Man page Source code
team_edge_skating_speed Man page Source code
team_edge_summary Man page Source code
team_edge_zone_time Man page Source code
team_game_report Man page Source code
team_logos Man page Source code
team_month_schedule Man page Source code
team_prospects Man page Source code
team_report_configs Man page Source code
team_report_configurations Man page Source code
team_season_report Man page Source code
team_season_schedule Man page Source code
team_season_statistics Man page Source code
team_season_stats Man page Source code
team_seasons Man page Source code
team_week_schedule Man page Source code
teams Man page Source code
tv_schedule Man page Source code
venues Man page Source code
wsc_pbp Man page Source code
wsc_pbp_raw Man page Source code
wsc_pbps Man page Source code
wsc_pbps_raw Man page Source code
wsc_play_by_play Man page Source code
wsc_play_by_play_raw Man page Source code
wsc_play_by_plays Man page Source code
wsc_play_by_plays_raw Man page Source code
wsc_summary Man page Source code
x_game_cum_xG Man page Source code
x_game_cumulative_expected_goals Man page Source code
x_game_shot_locations Man page Source code
x_game_shot_locs Man page Source code
nhlscraper documentation built on June 29, 2026, 1:06 a.m.