mfl_connect: Connect to MFL League

Description Usage Arguments Value Examples

View source: R/mfl_connect.R

Description

This function creates a connection object which stores parameters and gets a login-cookie if available

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
mfl_connect(
  season = NULL,
  league_id = NULL,
  APIKEY = NULL,
  user_name = NULL,
  password = NULL,
  user_agent = NULL,
  rate_limit = TRUE,
  rate_limit_number = NULL,
  rate_limit_seconds = NULL,
  ...
)

Arguments

season

Season to access on MFL - if missing, will guess based on system date (current year if March or later, otherwise previous year)

league_id

league_id Numeric ID parameter for each league, typically found in the URL

APIKEY

APIKEY - optional - allows access to private leagues. Key is unique for each league and accessible from Developer's API page (currently assuming one league at a time)

user_name

MFL user_name - optional - when supplied in conjunction with a password, will attempt to retrieve authentication token

password

MFL password - optional - when supplied in conjunction with user_name, will attempt to retrieve authentication token

user_agent

A string representing the user agent to be used to identify calls - may find improved rate_limits if verified token

rate_limit

TRUE by default, pass FALSE to turn off rate limiting

rate_limit_number

number of calls per rate_limit_seconds, suggested is 60 calls per 60 seconds

rate_limit_seconds

number of seconds as denominator for rate_limit

...

silently swallows up unused arguments

Value

a connection object to be used with ff_* functions

Examples

1
2
mfl_connect(season = 2020, league_id = 54040)
mfl_connect(season = 2019, league_id = 54040, rate_limit = FALSE)

ffscrapr documentation built on Nov. 10, 2021, 9:09 a.m.