An R Client for Fantasy Football League APIs
Helps access various Fantasy Football APIs (i.e. MFL, Sleeper, Fleaflicker, ESPN, Yahoo, potentially other platforms) by handling authentication and rate-limiting, forming appropriate calls, and returning tidy dataframes which can be easily connected to other data sources.
Installation
Version 1.0.0 is now on CRAN 🎉 and can be installed with:
install.packages("ffscrapr") # or from GitHub release remotes::install_github("dynastyprocess/ffscrapr",ref = "v1.0.0")
Install the development version from GitHub with:
# install.packages("devtools") OR install.packages("remotes") ## remotes is a subpackage of devtools remotes::install_github("dynastyprocess/ffscrapr")
The dev version has a separate documentation site here.
Usage
All ffscrapr functions start with a connection object created by ff_connect, which stores connection, authentication, and other user-defined parameters. This object is used by all other functions to help return the correct data.
library(ffscrapr) ssb <- ff_connect(platform = "mfl", league_id = "54040", season = 2020) # Get a summary of league settings ff_league(ssb) %>% str() #> tibble [1 x 13] (S3: tbl_df/tbl/data.frame) #> $ league_id : chr "54040" #> $ league_name : chr "The Super Smash Bros Dynasty League" #> $ franchise_count: num 14 #> $ qb_type : chr "1QB" #> $ idp : logi FALSE #> $ scoring_flags : chr "0.5_ppr, TEPrem, PP1D" #> $ best_ball : logi TRUE #> $ salary_cap : logi FALSE #> $ player_copies : num 1 #> $ years_active : chr "2018-2020" #> $ qb_count : chr "1" #> $ roster_size : num 35 #> $ league_depth : num 490 # Get rosters ff_rosters(ssb) #> # A tibble: 455 x 11 #> franchise_id franchise_name player_id player_name pos team age #> <chr> <chr> <chr> <chr> <chr> <chr> <dbl> #> 1 0001 Team Pikachu 13129 Fournette,~ RB JAC 25.6 #> 2 0001 Team Pikachu 13189 Engram, Ev~ TE NYG 26 #> 3 0001 Team Pikachu 11680 Landry, Ja~ WR CLE 27.7 #> 4 0001 Team Pikachu 13290 Cohen, Tar~ RB CHI 25.1 #> 5 0001 Team Pikachu 13158 Westbrook,~ WR JAC 26.8 #> 6 0001 Team Pikachu 10273 Newton, Cam QB NEP 31.3 #> 7 0001 Team Pikachu 14085 Pollard, T~ RB DAL 23.3 #> 8 0001 Team Pikachu 13139 Williams, ~ RB GBP 25.4 #> 9 0001 Team Pikachu 13649 Hamilton, ~ WR DEN 25.5 #> 10 0001 Team Pikachu 9918 Sanders, E~ WR NOS 33.4 #> # ... with 445 more rows, and 4 more variables: roster_status <chr>, #> # drafted <chr>, draft_year <chr>, draft_round <chr> # Get transactions ff_transactions(ssb) #> # A tibble: 301 x 12 #> timestamp type type_desc franchise_id franchise_name player_id #> <dttm> <chr> <chr> <chr> <chr> <chr> #> 1 2020-08-25 11:10:50 FREE~ dropped 0003 Team Captain ~ 13387 #> 2 2020-08-24 15:05:29 TAXI demoted 0003 Team Captain ~ 14081 #> 3 2020-08-24 15:04:45 FREE~ dropped 0003 Team Captain ~ 14094 #> 4 2020-08-22 14:46:44 IR deactiva~ 0010 Team Yoshi 10960 #> 5 2020-08-22 14:46:44 IR deactiva~ 0010 Team Yoshi 14209 #> 6 2020-08-22 14:46:15 TAXI promoted 0010 Team Yoshi 14844 #> 7 2020-08-22 14:46:15 TAXI promoted 0010 Team Yoshi 14209 #> 8 2020-08-22 14:46:15 TAXI promoted 0010 Team Yoshi 14195 #> 9 2020-08-22 14:46:15 TAXI demoted 0010 Team Yoshi 14317 #> 10 2020-08-22 14:46:15 TAXI demoted 0010 Team Yoshi 14969 #> # ... with 291 more rows, and 6 more variables: player_name <chr>, pos <chr>, #> # team <chr>, bbid_spent <dbl>, trade_partner <chr>, comments <chr>
For a more detailed usage example, including a template dynasty league analysis script, please check out the reference articles and/or vignettes!
Contributing
Many hands make light work! Here are some ways you can contribute to this project:
You can open an issue if you’d like to request specific data or report a bug/error.
You can sponsor this project by donating to help with server costs!
If you’d like to contribute code, please check out the contribution guidelines.
Terms of Use
The R code for this package is released as open source under the MIT license.
The APIs and data accessed by this package belong to their respective owners, and are governed by their terms of use.
