espn_connect: Connect to ESPN League

In dynastyprocess/ffscrapr: API Client for Fantasy Football League Platforms

Connect to ESPN League

Description

This function creates a connection object which stores parameters and a user ID if available.

Usage

espn_connect(
  season = NULL,
  league_id = NULL,
  swid = NULL,
  espn_s2 = NULL,
  user_agent = NULL,
  rate_limit = TRUE,
  rate_limit_number = NULL,
  rate_limit_seconds = NULL,
  ...
)

Arguments

season	Season to access on Fleaflicker - if missing, will guess based on system date (current year if March or later, otherwise previous year)
league_id	League ID
swid	SWID parameter for accessing private leagues - see vignette for details
espn_s2	ESPN_S2 parameter for accessing private leagues - see vignette for details
user_agent	User agent to self-identify (optional)
rate_limit	TRUE by default - turn off rate limiting with FALSE
rate_limit_number	number of calls per rate_limit_seconds, suggested is under 1000 calls per 60 seconds
rate_limit_seconds	number of seconds as denominator for rate_limit
...	other arguments (for other methods, for R compat)

Value

a list that stores ESPN connection objects

Examples

conn <- espn_connect(
  season = 2018,
  league_id = 1178049,
  espn_s2 = Sys.getenv("TAN_ESPN_S2"),
  swid = Sys.getenv("TAN_SWID")
)

dynastyprocess/ffscrapr documentation built on Nov. 3, 2024, 3:58 a.m.