get_scheduled_league_games {RDota2} | R Documentation |
Scheduled League Games
Description
A list of scheduled league matches.
Usage
get_scheduled_league_games(date_min = NULL, date_max = NULL, tz = "",
dota_id = "570", language = "en", key = NULL)
Arguments
date_min |
(optional) A date of the format "yyyy-mm-dd HH:MM:SS". See examples for details. Return games from this date onwards. |
date_max |
(optional) A date of the format "yyyy-mm-dd HH:MM:SS". See examples for details. Return games up to this date |
tz |
A time zone specification if date_min and/or date_max are used. See as.POSIXct. "" (default) is the current time zone and "GMT" is UTC. |
dota_id |
Can take one of three values.
|
language |
The ISO639-1 language code for returning all the information in the corresponding language. If the language is not supported, english will be returned. For a complete list of the ISO639-1 language codes please visit https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes. |
key |
The api key obtained from Steam. If you don't have one please visit
https://steamcommunity.com/dev in order to do so. For instructions on the correct way
to use this key please visit https://github.com/LyzandeR/RDota2 and check the readme file.
You can also see the examples. A key can be made available to all the functions by using
|
Details
A list will be returned that contains three elements. The content, the url and the response received from the api.
The content element of the list contains a games list with information about the matches. Each element of the games list is a game. Each game consists of (some) of the following sections:
-
league_id: The unique league id.
-
game_id: A unique game id.
-
teams: A list of the participating teams.
-
starttime: Unix Timestamp of start time.
-
comment: Description of game.
-
final: Whether the game is a final or not.
Value
A dota_api object containing the elements described in the details.
Steam API Documentation
https://wiki.teamfortress.com/wiki/WebAPI/GetScheduledLeagueGames
Examples
## Not run:
get_scheduled_league_games()
get_scheduled_league_games(language = 'en', key = NULL)
get_scheduled_league_games(language = 'en', key = 'xxxxxxxxxxx')
get_scheduled_league_games(date_min = '2016-06-01 00:00:00',
date_max = '2016-09-07 00:00:00')
## End(Not run)