Description
Access Live Sports Odds from the Odds API.
Description
A utility to quickly obtain clean and tidy sports odds from The Odds API <https://the-odds-api.com>.
README.md
oddsapiR
To access the API, get a free API key from https://the-odds-api.com
Installation & Usage
Installation
You can install the released version of oddsapiR
from GitHub with:
# You can install using the pacman package using the following code:
if (!requireNamespace('pacman', quietly = TRUE)){
install.packages('pacman')
}
pacman::p_load_current_gh("sportsdataverse/oddsapiR")
# if you would prefer devtools installation
if (!requireNamespace('devtools', quietly = TRUE)){
install.packages('devtools')
}
# Alternatively, using the devtools package:
devtools::install_github(repo = "sportsdataverse/oddsapiR")
git clone https://github.com/sportsdataverse/oddsapi
cd oddsapi
Rscript -e "devtools::install()"
Odds API Keys
The Odds API requires an API key, here’s a quick run-down:
- Using the key: You can save the key for consistent usage by adding
ODDS_API_KEY=XXXX-YOUR-API-KEY-HERE-XXXXX
to your .Renviron file (easily accessed viausethis::edit_r_environ()
). Runusethis::edit_r_environ()
, a new script will pop open named.Renviron
, THEN paste the following in the new script that pops up (without quotations)
ODDS_API_KEY = XXXX-YOUR-API-KEY-HERE-XXXXX
Save the script and restart your RStudio session, by clicking Session
(in between Plots
and Build
) and click Restart R
(there also exists the shortcut Ctrl + Shift + F10
to restart your session). If set correctly, from then on you should be able to use any of the functions without any other changes.
- For less consistent usage: At the beginning of every session or within an R environment, save your API key as the environment variable
ODDS_API_KEY
(with quotations) using a command like the following.
Sys.setenv(ODDS_API_KEY = "XXXX-YOUR-API-KEY-HERE-XXXXX")
Documentation
For more information on the package and function reference, please see the oddsapiR
documentation website.
Breaking Changes
Follow the SportsDataverse on Twitter and star this repo
Our Authors
Citations
To cite the oddsapiR
R package in publications, use:
BibTex Citation
@misc{gilani_2022_oddsapiR,
author = {Gilani, Saiem},
title = {oddsapiR: The SportsDataverse's R Package for The Odds API.},
url = {https://oddsapiR.sportsdataverse.org},
year = {2022}
}