get_match_history {RDota2} | R Documentation |
A list of Matches
Description
A list of matches based on various parameters.
Usage
get_match_history(hero_id = NULL, game_mode = NULL, skill = NULL,
date_min = NULL, date_max = NULL, min_players = NULL,
account_id = NULL, league_id = NULL, start_at_match_id = NULL,
matches_requested = NULL, tournament_games_only = NULL, tz = "",
dota_id = 570, language = "en", key = NULL)
Arguments
hero_id |
(optional) The hero id. A list of hero ids can be found via the get_heroes function. |
game_mode |
(optional) The game mode:
No 15 does not exist |
skill |
(optional) Skill bracket.
|
date_min |
(optional) Minimum date range for returned matches (yyyy-mm-dd HH:MM:SS). |
date_max |
(optional) Maximum date range for returned matches (yyyy-mm-dd HH:MM:SS). |
min_players |
(optional) Minimum number of players in match. |
account_id |
(optional) Account ID. |
league_id |
(optional) League ID. |
start_at_match_id |
(optional) Matches equal or older than this ID. |
matches_requested |
(optional) Amount of matches to return (defaults to 25). |
tournament_games_only |
(optional) Binary (0 or 1). Whether to return tournament matches. |
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 list called matches. Each element of matches list is a match. Each match contains the following sections:
-
match_id: The match id.
-
match_seq_num:A sequence number, representing the order in which matches were recorded.
-
start_time: UNIX timestamp of when the game began.
-
lobby_type: Check the API Documentation.
-
radiant_team_id: Radiant team id.
-
dire_team_id: Dire team id.
-
players: A list containing information about the players.
Value
A dota_api object containing the elements described in the details.
Steam API Documentation
https://wiki.teamfortress.com/wiki/WebAPI/GetMatchHistory
Examples
## Not run:
get_match_history(matches_requested = 2)
get_match_history(matches_requested = 2, date_min = '2015-01-01 16:00:00', hero_id = 1)
get_match_history(language = 'en', key = NULL)
get_match_history(language = 'en', key = 'xxxxxxxxxxx')
## End(Not run)