league_info: League information

View source: R/settings.R

league_infoR Documentation

League information

Description

Basic information on a ESPN fantasy football league, like the name, size, and season length.

Usage

league_info(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 information by season.

See Also

Other league settings functions: acquisition_settings(), draft_settings(), finance_settings(), league_name(), league_size(), roster_settings(), schedule_settings(), scoring_settings(), trade_settings()

Examples

league_info(leagueId = "42654852")

fflr documentation built on Sept. 14, 2023, 9:10 a.m.