get_top_live_game {RDota2}

Top Live Games

Description

Returns the top live games by MMR.

Usage

get_top_live_game(partner = 1, dota_id = 570, language = "en",
  key = NULL)

Arguments

partner

The documentation does not specify what this parameter should be but it seems like numbers from 1-3 return results of live games.

dota_id

Can take one of three values.

• 570 - Dota 2 (default)

• 816 - Dota 2 Internal Test

• 205790 - Dota 2 Beta Test

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 key_actions. The key argument in individual functions should only be used in case the user needs to work with multiple keys.

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 list which contains information about the top live games. The following information is provided for each game (Categories are not documented at the time of the release - please check the Steam API Documentation link below:

• activate_time

• deactivate_time

• server_steam_id

• lobby_id

• league_id

• lobby_type

• game_time

• delay

• spectators

• game_mode

• average_mmr

• sort_score

• last_update_time

• radiant_lead

• radiant_score

• dire_score

• players

Value

A dota_api object containing the elements described in the details.

Steam API Documentation

https://wiki.teamfortress.com/wiki/WebAPI/GetTopLiveGame

Examples

## Not run: 
get_top_live_game(partner = 1)
get_top_live_game(partner = 1, language = 'en', key = NULL)
get_top_live_game(partner = 2, language = 'en', key = 'xxxxxxxxxxx')

## End(Not run)