The length of a fantasy season and the match periods for each week.

schedule_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 schedule settings by season.

Examples

schedule_settings(leagueId = "42654852")
#> # A tibble: 1 × 12
#>   seasonId divisions    matchupPeriodCount matchupPeriodLength matchupPeriods
#>      <int> <list>                    <int>               <int> <list>        
#> 1     2024 <df [2 × 3]>                 17                   1 <df [17 × 2]> 
#> # ℹ 7 more variables: periodTypeId <int>, playoffMatchupPeriodLength <int>,
#> #   playoffReseed <lgl>, playoffSeedingRule <chr>, playoffSeedingRuleBy <int>,
#> #   playoffTeamCount <int>, variablePlayoffMatchupPeriodLength <lgl>