Skip to contents

Returns a paginated index of NHL athletes from ESPN. This is a site_v2-named parity alias for espn_nhl_athletes_index(); both wrap the same core_v2 /athletes backing endpoint. Prefer espn_nhl_athletes_index() for the established function with the same interface.

Usage

espn_nhl_players_index(active = TRUE, limit = 100, page = 1, ...)

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). Use the page_count column in 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:

col_nametypesdescription
refcharacter$ref URL for the athlete object.
athlete_idcharacterESPN athlete id parsed from the $ref URL.
activelogicalThe active filter value echoed from arg.
pageintegerThe page value echoed from arg.
countintegerTotal athlete count matching the filter.
page_countintegerTotal number of pages.

See also

family_espn_nhl lists every function in this family.

espn_nhl_athletes_index() for the established alias.

Author

Saiem Gilani

Examples

# \donttest{
  try(espn_nhl_players_index(active = TRUE, limit = 10, page = 1))
#> ── NHL Players Index data from ESPN.com ─────────────────── fastRhockey 1.1.0 ──
#> ℹ Data updated: 2026-11-13 21:27:17 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  1077        108
#>  2 http://sports.core.api.espn.com/v2/… 2300       TRUE       1  1077        108
#>  3 http://sports.core.api.espn.com/v2/… 2389       TRUE       1  1077        108
#>  4 http://sports.core.api.espn.com/v2/… 2666       TRUE       1  1077        108
#>  5 http://sports.core.api.espn.com/v2/… 2931       TRUE       1  1077        108
#>  6 http://sports.core.api.espn.com/v2/… 3101       TRUE       1  1077        108
#>  7 http://sports.core.api.espn.com/v2/… 3114       TRUE       1  1077        108
#>  8 http://sports.core.api.espn.com/v2/… 3124       TRUE       1  1077        108
#>  9 http://sports.core.api.espn.com/v2/… 3508       TRUE       1  1077        108
#> 10 http://sports.core.api.espn.com/v2/… 3535       TRUE       1  1077        108
# }