Documentation¶

There are several response types/entities accross the different endpoints of the Dota 2 WebAPI. This API aims at removing inconsistencies and unifying the response content.

All variables belonging to a class are accessed using the __getitem__ method (similar to a dict). See examples for more details.

get_match_history()¶

class d2api.src.wrappers.MatchHistory(response_text)[source]¶

get_match_history or get_match_history_by_sequence_num response object

Variables:	matches (list(MatchSummary)) – List of match summaries

class d2api.src.wrappers.MatchSummary(default_obj)[source]¶

A brief summary of queried games

Variables:	match_id (int) – The unique ID of a match match_seq_num (int) – Represents the sequence in which matches were recorded start_time (int) – Unix timestamp of game begin time lobby_type (int) – Integer representing type of lobby players (list(PlayerMinimal)) – List of player summaries

get_match_details()¶

class d2api.src.wrappers.MatchDetails(response_text)[source]¶

get_match_details response object

Variables:

players (PlayerUnit) – List of players in the game
players_minimal (PlayerMinimal) – List of players represented minimally
picks_bans (PickBan) – List of picks/bans
season (int) – The season in which the game was played
winner (str) – Side that won the game (radiant/dire)
duration (int) – Duration of the game (in seconds)
pre_game_duration (int) – Duration for game to begin (in seconds)
start_time (int) – Unix timestamp of match start
match_seq_num (int) – Number denoting the order in which matches were recorded
radiant_buildings (Buildings) – Radiant building statuses at the end of the game
dire_buildings (Buildings) – Dire building statuses at the end of the game
cluster (int) – The server cluster the match was played upon (used to fetch replays)
first_blood_time (int) – Time of first-blood occurrance
lobby_type (int) – Type of lobby
human_players (int) – Number of human players in the game
leagueid (int) – The league that this match was a part of
positive_votes (int) – The number of thumbs-up the game has received by users
negative_votes (int) – The number of thumbs-down the game has received by users
game_mode (int) – Game mode
engine (int) – Source 1/Source 2
radiant_score (int) – TODO
dire_score (int) – TODO
flags – TODO

has_leavers()[source]¶

Returns:	`True` if the game contains a leaver
Return type:	bool

leavers()[source]¶

Returns:	List of leavers in a game.
Return type:	list(SteamAccount)

class d2api.src.wrappers.PlayerUnit(default_obj)[source]¶

An inventoried hero unit

Variables:

steam_account (SteamAccount) – Steam account of player
side (str) – Side to which a player belongs (radiant/dire)
hero (Hero) – Hero played
kills (int) – Number of kills at the end of the match
deaths (int) – Number of deaths at the end of the match
assists (int) – Number of assists at the end of the match
leaver_status (int) – Type of leaver
gold (int) – Amount of gold remaining at the end of the match
last_hits (int) – Number of list hits at the end of the match
denies (int) – Number of denies at the end of the game
gold_per_minute (int) – Overall gold/minute
xp_per_minute (int) – Overall XP/min
gold_spent (int) – Amount of gold spent during the match
hero_damage (int) – Total damage done to other heroes at the end of the match
tower_damage (int) – Total damage done to opponent towers at the end of the match
hero_healing (int) – Total healing done to other heroes at the end of the match
additional_units (list(AdditionalUnit)) – Additional units belonging to the current unit
inventory (list(Item)) – List of inventory items
backpack (list(Item)) – List of backpack items
ability_upgrades (list(AbilityInfo)) – Ability upgrade information

all_items()¶

Returns:	Combined list of inventory and backpack items
Return type:	list(Item)

class d2api.src.wrappers.AdditionalUnit(default_obj)[source]¶

An inventoried unit besides heroes (e.g. Lone druid bear)

Variables:	inventory (list(Item)) – List of inventory items backpack (list(Item)) – List of backpack items

all_items()¶

Returns:	Combined list of inventory and backpack items
Return type:	list(Item)

class d2api.src.wrappers.PickBan(default_obj)[source]¶

Reprents a pick/ban during a game

Variables:	is_pick (bool) – `True` if the hero was picked hero (Hero) – Hero being picked/banned side (str) – Side that picked/banned this hero (radiant/dire) order (int) – Order in which the hero was picked/banned

get_heroes()¶

class d2api.src.wrappers.Heroes(response_text)[source]¶

get_heroes response object

Variables:	heroes (list(LocalizedHero)) – List of localized hero information count (int) – Number of heroes returned

class d2api.src.wrappers.LocalizedHero(default_obj)[source]¶

Localized hero information

Variables:	name (str) – Hero name id (int) – Hero ID localized_name (str) – Name of hero in language specified

get_game_items()¶

class d2api.src.wrappers.GameItems(response_text)[source]¶

get_game_items response object

Variables:	game_items (list(LocalizedGameItems)) – List of localized item information

class d2api.src.wrappers.LocalizedGameItem(default_obj)[source]¶

Localized item information

Variables:	id (int) – Item ID name (str) – Item name cost (int) – Cost of item secret_shop (bool) – True if the item is sold in secret shop side_shop (bool) – True if the item is sold in side shop recipe (bool) – True if it is a recipe localized_name (str) – Name of item in language specified

get_tournament_prize_pool()¶

class d2api.src.wrappers.TournamentPrizePool(response_text)[source]¶

get_tournament_prize_pool response object

Variables:	prize_pool (int) – Prize pool league_id (int) – League ID for which prize pool was fetched

get_live_league_games()¶

class d2api.src.wrappers.LiveLeagueGames(response_text)[source]¶

get_live_league_games response object

Variables:	games (list(Game)) – List of games

class d2api.src.wrappers.Game(default_obj)[source]¶

Summary of a live league game

Variables:

radiant_team (TeamInfo) – Radiant team information
dire_team (TeamInfo) – Dire team information
players (List(PlayerMinimal)) – List of players in the game
scoreboard (Scoreboard) – Game scoreboard at time of query
lobby_id (int) – ID of lobby
match_id (int) – Unique ID used to identify match
spectators (int) – Number of spectators
league_id (int) – Unique ID for the league of the match
league_node_id (int) – Unique ID of node within the league
stream_delay_s (int) – Stream delay in seconds
radiant_series_win (int) – Number of wins by radiant team
dire_series_win (int) – Number of wins by dire team
series_type (int) – Type of series

class d2api.src.wrappers.Scoreboard(default_obj)[source]¶

Scoreboard of live game

Variables:	duration (int) – Duration of the game at time of query roshan_respawn_timer (int) – Time left for Roshan to respawn radiant (TeamLive) – Radiant team summary dire (TeamLive) – Dire team summary

class d2api.src.wrappers.TeamLive(default_obj)[source]¶

Information of a team in live game

Variables:	score (int) – Current number of kills by the team buildings (Buildings) – State of buildings picks (list(Hero)) – List of heroes picked bans (list(Hero)) – List of heroes banned players (list(PlayerLive)) – List of player summaries

class d2api.src.wrappers.PlayerLive(default_obj)[source]¶

Information of a player in live game

Variables:

player_slot (int) – Slot of player within the team
steam_account (SteamAccount) – Steam account of the player
hero (Hero) – Hero played
kills (int) – Number of kills
deaths (int) – Number of deaths
assists (int) – Number of assists
last_hits (int) – Number of last hits
denies (int) – Number of denies
gold (int) – Current amount of gold
level (int) – Current level
gold_per_min (int) – gold/min at time of query
xp_per_min (int) – XP/min at time of query
abilities (list(AbilityInfo)) – List of ability information
ultimate_state (int) – Current state of ultimate
ultimate_cooldown (int) – Remaining time for ultimate to come off cooldown
inventory (list(Item)) – List of items in player inventory
respawn_timer (int) – Remain time for player to respawn
position_x (float) – X coordinate of hero
position_y (float) – Y coordinate of hero
net_worth (int) – Net worth of the hero

get_top_live_game()¶

class d2api.src.wrappers.TopLiveGame(response_text)[source]¶

get_top_live_game response object

Variables:	game_list (list(LiveGameSummary)) – List of top live games

class d2api.src.wrappers.LiveGameSummary(default_obj)[source]¶

Summary of a live game

Variables:

players (PlayerMinimal) – List of player info
radiant_towers (Buildings) – Radiant towers
dire_towers (Buildings) – Dire towers
activate_time (int) – TODO
deactivate_time (int) – TODO
server_steam_id (int) – Steam ID of server
lobby_id (int) – ID of lobby
league_id (int) – Unique ID for the league of the match
lobby_type (int) – Type of lobby
game_time (int) – Game time
delay (int) – Stream delay (game, spectator delay)
spectators (int) – Current number of spectators
game_mode (int) – Game mode of current game
average_mmr (int) – Average MMR of the game
match_id (int) – Unique ID used to identify match
series_id (int) – Unique ID used to identify series
radiant_team (TeamInfo) – Information about radiant team
dire_team (TeamInfo) – Information about dire team
sort_score (int) – TODO
last_update_time (int) – TODO
radiant_lead (int) – Gold lead of radiant team
radiant_score (int) – TODO
dire_score (int) – TODO

get_team_info_by_team_id()¶

class d2api.src.wrappers.TeamInfoByTeamID(response_text)[source]¶

get_team_info_by_team_id response object

Variables:	teams (list(TeamInfo)) – List of team information

get_broadcaster_info()¶

class d2api.src.wrappers.BroadcasterInfo(response_text)[source]¶

get_broadcaster_info response object

Variables:	steam_account (SteamAccount) – Steam account of broadcaster server_steam_id (int) – Unique ID of game server currently being broadcasted live (bool) – `True` if the user is currently broadcasting allow_live_video (bool) – `True` if the user has allowed live video

get_player_summaries()¶

class d2api.src.wrappers.PlayerSummaries(response_text)[source]¶

get_player_summaries response object

Variables:	players (list(SteamDetails)) – List of steam information in ascending order of account ids

class d2api.src.wrappers.SteamDetails(default_obj)[source]¶

Information about a player as on Steam.

Variables:

steam_account (SteamAccount) – Steam account of the player
communityvisibility (str) – A string representing the access setting of the profile
profilestate (int) – Set to 1 if the user has configured their profile
personname (str) – Display name
lastlogoff (int) – Unix timestamp of when the player was last online
profileurl (str) – The URL to the user’s steam profile
avatar (str) – URL of 32x32 image
avatarmedium (str) – URL of 64x64 image
avatarfull (str) – URL of 184x184 image
personastate (str) – A string representing user’s status
commentpermission (int) – If present the profile allows public comments
realname (str) – The user’s real name
primaryclanid (int) – The 64 bit ID of the user’s primary group
timecreated (int) – A unix timestamp of the date the profile was created
loccountrycode (int) – ISO 3166 code of where the user is located
locstatecode (int) – Variable length code representing the state the user is located in
loccityid (int) – An integer ID internal to Steam representing the user’s city
gameid (int) – If the user is in game this will be set to it’s app ID as a string
gameextrainfo (str) – The title of the game
gameserverip (str) – The server URL given as an IP address and port number

Common wrappers and entities¶

class d2api.src.wrappers.TeamInfo(default_obj)[source]¶

Information about team

Variables:	team_name (str) – The team’s name. team_id (int) – The team’s unique ID. team_logo (int) – The UGC id for the team logo. complete (bool) – Whether the players for this team are all team members.

class d2api.src.wrappers.AbilityInfo(default_obj)[source]¶

Ability upgrade during game.

Variables:	ability (Ability) – Ability upgraded. time (int) – Game time at which ability was upgraded level (int) – Level of the player at which ability was upgraded.

class d2api.src.wrappers.Buildings(default_obj)[source]¶

Represents current state of buildings

Variables:	{lane}_{position} (bool) – Tower status [lane = top, mid, bot][position = 1, 2, 3] (e.g. top_t2) ancient_bot (bool) – Ancient bottom tower ancient_top (bool) – Ancient top tower {lane}_{type} (bool) – Barracks status [lane = top, mid, bot][type = ranged, melee] (e.g. mid_melee)

class d2api.src.wrappers.PlayerMinimal(default_obj)[source]¶

A minimal information wrapper for a player

Variables:	steam_account (SteamAccount) – Steam account of player side (str) – side to which a player belongs (radiant/dire) hero (Hero) – hero played

class d2api.src.entities.Ability(ability_id)[source]¶

Wrapper to map ability data to ability_id

Variables:	ability_id (int) – Unique identifier of ability ability_name (str) – Name of the ability

class d2api.src.entities.Item(item_id)[source]¶

Wrapper to map item information to item_id

Variables:	item_id (int) – Unique identifier of item item_cost (int) – Cost of the item item_aliases (list(str)) – List of names by which the item is known item_name (str) – Name of the item

class d2api.src.entities.SteamAccount(account_id)[source]¶

Wrapper to implicitly store steam32 and steam64 account IDs

Variables:	id32 (int) – 32-bit Steam ID id64 (int) – 64-bit Steam ID

class d2api.src.entities.Hero(hero_id)[source]¶

Wrapper to map hero information to hero_id

Variables:	hero_id (int) – Unique identifier of hero hero_name (str) – Name of the hero