The number of players and positions on a fantasy football roster.

roster_settings(leagueId = ffl_id(), leagueHistory = FALSE, ...)

Arguments

leagueId

Numeric league ID or ESPN fantasy page URL. Defaults to getOption("fflr.leagueId"). Function fails if no ID is found.

leagueHistory

logical; Should the leagueHistory version of the API be called? If TRUE, a list of results is returned, with one element for each historical year of the league.

...

Additional queries passed to httr::GET(). Arguments are converted to a named list and passed to query alongside view.

Value

A data frame of league roster settings by season.

Examples

roster_settings(leagueId = "42654852")
#> # A tibble: 1 × 8
#>   seasonId isBenchUnlimited isUsingUndroppableList lineupLocktimeType
#>      <int> <lgl>            <lgl>                  <chr>             
#> 1     2024 TRUE             TRUE                   INDIVIDUAL_GAME   
#> # ℹ 4 more variables: lineupSlotCounts <list>, moveLimit <int>,
#> #   positionLimits <list>, rosterLocktimeType <chr>