get_tournament_prize_pool {RDota2} | R Documentation |
Dota Tournament Prizes
Description
Dota Tournament Prizes.
Usage
get_tournament_prize_pool(leagueid = NULL, dota_id = 570, language = "en",
key = NULL)
Arguments
leagueid |
(optional) The league id to get prize information about. |
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 data.frame tournament prizes. Each row of the data.frame is a tournament and the following columns are included:
-
prize_pool: The prize pool.
-
league_id: The league's id.
Value
A dota_api object containing the elements described in the details.
Steam API Documentation
https://wiki.teamfortress.com/wiki/WebAPI/GetTournamentPrizePool
Examples
## Not run:
get_tournament_prize_pool(leagueid = 40)
get_tournament_prize_pool(leagueid = 65006)
get_tournament_prize_pool(language = 'en', key = NULL)
get_tournament_prize_pool(language = 'en', key = 'xxxxxxxxxxx')
## End(Not run)