Get ESPN NHL Athletes Index (core-v2)
Arguments
- active
Filter by active status.
TRUE(default) = active players only;FALSE= inactive only;NULL= no filter.- limit
Number of athletes per page (default
100; max ~200).- page
Page number (default
1). Usepage_countfrom the result to determine the total number of pages.- ...
Reserved for forward compatibility.
Value
A fastRhockey_data tibble with one row per athlete in the requested
page. Surface count and page_count to manage pagination.
| col_name | types | description |
| ref | character | $ref URL for the athlete object. |
| athlete_id | character | ESPN athlete id parsed from the $ref URL. |
| active | logical | The active filter value echoed from arg. |
| page | integer | The page value echoed from arg. |
| count | integer | Total athlete count matching the filter. |
| page_count | integer | Total number of pages. |
See also
Other ESPN NHL Functions:
espn_nhl_award(),
espn_nhl_awards(),
espn_nhl_calendar(),
espn_nhl_calendar_offseason(),
espn_nhl_calendar_ondays(),
espn_nhl_calendar_postseason(),
espn_nhl_calendar_regular_season(),
espn_nhl_coach(),
espn_nhl_coach_record(),
espn_nhl_coach_season(),
espn_nhl_coaches(),
espn_nhl_conferences(),
espn_nhl_countries(),
espn_nhl_draft(),
espn_nhl_franchise(),
espn_nhl_franchises(),
espn_nhl_game(),
espn_nhl_game_all(),
espn_nhl_game_broadcasts(),
espn_nhl_game_competition(),
espn_nhl_game_leaders(),
espn_nhl_game_odds(),
espn_nhl_game_official_detail(),
espn_nhl_game_officials(),
espn_nhl_game_play(),
espn_nhl_game_play_personnel(),
espn_nhl_game_plays(),
espn_nhl_game_powerindex(),
espn_nhl_game_predictor(),
espn_nhl_game_probabilities(),
espn_nhl_game_propbets(),
espn_nhl_game_scoringplays(),
espn_nhl_game_situation(),
espn_nhl_game_status(),
espn_nhl_game_team(),
espn_nhl_game_team_leaders(),
espn_nhl_game_team_linescores(),
espn_nhl_game_team_record(),
espn_nhl_game_team_roster(),
espn_nhl_game_team_statistics(),
espn_nhl_game_teams(),
espn_nhl_games(),
espn_nhl_injuries(),
espn_nhl_leaders(),
espn_nhl_leaders_core(),
espn_nhl_league_notes(),
espn_nhl_league_root(),
espn_nhl_news(),
espn_nhl_pbp(),
espn_nhl_player_awards(),
espn_nhl_player_bio(),
espn_nhl_player_box(),
espn_nhl_player_career_stats(),
espn_nhl_player_contracts(),
espn_nhl_player_core(),
espn_nhl_player_eventlog(),
espn_nhl_player_gamelog(),
espn_nhl_player_info(),
espn_nhl_player_injuries(),
espn_nhl_player_news(),
espn_nhl_player_notes(),
espn_nhl_player_overview(),
espn_nhl_player_records(),
espn_nhl_player_seasons(),
espn_nhl_player_splits(),
espn_nhl_player_statistics(),
espn_nhl_player_statisticslog(),
espn_nhl_player_stats_v3(),
espn_nhl_player_vs_player(),
espn_nhl_players_index(),
espn_nhl_position(),
espn_nhl_positions(),
espn_nhl_providers(),
espn_nhl_schedule(),
espn_nhl_scoreboard(),
espn_nhl_season_athletes(),
espn_nhl_season_awards(),
espn_nhl_season_coaches(),
espn_nhl_season_draft(),
espn_nhl_season_draft_round_picks(),
espn_nhl_season_freeagents(),
espn_nhl_season_futures(),
espn_nhl_season_group(),
espn_nhl_season_group_children(),
espn_nhl_season_group_teams(),
espn_nhl_season_groups(),
espn_nhl_season_info(),
espn_nhl_season_players(),
espn_nhl_season_pointer(),
espn_nhl_season_powerindex(),
espn_nhl_season_powerindex_leaders(),
espn_nhl_season_team(),
espn_nhl_season_teams(),
espn_nhl_season_type(),
espn_nhl_season_type_corrections(),
espn_nhl_season_type_leaders(),
espn_nhl_season_types(),
espn_nhl_season_week(),
espn_nhl_season_week_games(),
espn_nhl_season_weeks(),
espn_nhl_seasons(),
espn_nhl_standings(),
espn_nhl_standings_core(),
espn_nhl_statistics_league(),
espn_nhl_summary(),
espn_nhl_talentpicks(),
espn_nhl_team(),
espn_nhl_team_box(),
espn_nhl_team_core(),
espn_nhl_team_depthcharts(),
espn_nhl_team_history(),
espn_nhl_team_injuries(),
espn_nhl_team_leaders(),
espn_nhl_team_news(),
espn_nhl_team_record(),
espn_nhl_team_roster(),
espn_nhl_team_schedule(),
espn_nhl_team_transactions(),
espn_nhl_teams_core(),
espn_nhl_teams_site(),
espn_nhl_tournaments(),
espn_nhl_transactions(),
espn_nhl_venue(),
espn_nhl_venues()
Examples
# \donttest{
try(espn_nhl_athletes_index(active = TRUE, limit = 10, page = 1))
#> ── NHL Athletes Index data from ESPN core-v2 ────────────── fastRhockey 1.0.0 ──
#> ℹ Data updated: 2026-06-12 14:17:22 UTC
#> # A tibble: 10 × 6
#> ref athlete_id active page count page_count
#> <chr> <chr> <lgl> <int> <int> <int>
#> 1 http://sports.core.api.espn.com/v2/… 2273 TRUE 1 1198 120
#> 2 http://sports.core.api.espn.com/v2/… 2300 TRUE 1 1198 120
#> 3 http://sports.core.api.espn.com/v2/… 2389 TRUE 1 1198 120
#> 4 http://sports.core.api.espn.com/v2/… 2413 TRUE 1 1198 120
#> 5 http://sports.core.api.espn.com/v2/… 2666 TRUE 1 1198 120
#> 6 http://sports.core.api.espn.com/v2/… 2931 TRUE 1 1198 120
#> 7 http://sports.core.api.espn.com/v2/… 3101 TRUE 1 1198 120
#> 8 http://sports.core.api.espn.com/v2/… 3114 TRUE 1 1198 120
#> 9 http://sports.core.api.espn.com/v2/… 3124 TRUE 1 1198 120
#> 10 http://sports.core.api.espn.com/v2/… 3183 TRUE 1 1198 120
# }