README.Rmd

---
title: "sportmonks"
output: github_document
---

```{r setup, include=FALSE}
knitr::opts_chunk$set(echo = T, message = F, error = F, warning = F)
```

```{r, echo = FALSE, results='asis', eval = T}
git_repo <- "systats/sportmonks"
cat(
  badger::badge_custom("Premium", "Soccer Data", "yellow"),
  badger::badge_devel(git_repo, "blue"),
  #badge_travis(git_repo),
  #"[![Codecov test coverage](https://codecov.io/gh/favstats/peRspective/branch/master/graph/badge.svg)](https://codecov.io/gh/favstats/peRspective?branch=master)",
  badger::badge_code_size(git_repo),
  badger::badge_last_commit(git_repo)
)
```

Install via

```{r, eval = F}
devtools::install_github("systats/sportmonks")
library(sportmonks)
```


```{r, echo = F}
pacman::p_load(tidyverse, crayon)
devtools::load_all()
# devtools::document()
# devtools::test()

key <- jsonlite::read_json("tests/settings.json")[[1]]
Sys.setenv(sportmonks = key)
#Sys.getenv("sportmonks")
```


# Endpoints

API responses are parsed per default. To get the raw json response, set the parse parameter to "F".

## Continents

```{r}
get_continents()
get_continent(1)
```

## Country

```{r}
get_countries()
get_country(2)
```

## Leagues

```{r}
my_leagues <- get_leagues(parse = T) # Default
my_leagues_raw <- get_leagues(parse = F)
my_leagues_raw %>% parse_request()
my_leagues

get_league(271)
```


## Seasons

```{r}
new_leagues <- get_seasons()
get_season(1273)
```


## Fixtures

Depending on your substription plan and the situational needs you can include nested 
tables which is particuarly useful for the fixture Endpoint to get all the data at once. 

```{r}
includes <- c('localTeam','visitorTeam','goals',
              'cards','lineup','referee','venue',
              'odds', 'stats')


get_fixture(id = 10333321, includes = includes)
get_fixtures(ids = c(10333321, 10333322))
get_fixture(date = "2019-01-23")
get_fixtures(dates = c("2019-01-01", "2019-02-01"))
# missing: get by date range for team
```

## Livescores

```{r, message = T}
get_live()
# get_live_now()
# all 
# inplay
```


## Comments

```{r}
get_comments(10333321)
```


## Highlights

```{r}
get_highlights(10333321)
```

## Head2Head

```{r}
get_head2head(team1 = 309, team2 = 66)
```


## Teams

```{r}
get_team(180)
get_team(season_id = 1273)
```

## Players

```{r}
get_player(180)
```

## Topscores

```{r}
get_topscores(season_id = 1273, agg = T)
```

## Venues

```{r}
get_venue(8928)
# by id
# by season id
```

## Rounds

```{r}
get_round(round_id = 147767)
get_round(season_id = 12963)
```


## Odds

```{r}
get_odds(10333321)

# by fixture and bookmarker
# by fixture and market
# by fixture id
# inplay odds by fixture id
```


## Coaches

```{r}
get_coache(896462)
```


## Stages

```{r}
get_stage(stage_id = 7508262)
get_stage(season_id = 12963)
```

## Bookmarkers

```{r}
get_bookmakers()
get_bookmaker(book_id = 25679219)
```


## Markets

```{r}
get_markets()
get_market(id = 10)
```

## Team Squads

```{r}
get_team_squads(season_id = 12963, team_id = 180)
```

## TV-stations

```{r}
get_tv(10333321)
```


```{r}
sessionInfo()
```

## Get future games

```{r}
get_future_games()
get_future_games(league_id = 501)
get_future_games(league_id = c(271, 501))


```


# Status Response

* 2xx range indicate success.
- 200	The request was successful and data is returned.
* 4xx range indicate an error that failed given the information provided.
- 400	It seems that some part of the request is malformed. The exact reason is returned in the response.
- 401	The request is not authenticated.
- 403	Not authorized. Indicates you're attempting to access a feed which is not accesible from your plan.
- 429	Too Many Requests. In order to make the API as responsive as possible, you have an hourly request limit. The limit for your current subscription can be found in any successfull response. Check the "meta" section to find out your limit.
* 5xx range indicate an error with SportMonks' servers.
- 500	An internal error has occurred, and has been logged for further inspection. Please email support if you are receiving this error.


## Ratelimits

* `default` all our plans are included with 2000 requests per 60 minutes per endpoint.