dota2api Documentation

Transcription

1 dota2api Documentation Release 1 Joshua Duffy March 04, 2015

2

3 Contents 1 Contents Installation Tutorial Library Reference Contributing Indices and tables 7 3 References 9 Python Module Index 11 i

4 ii

5 dota2api Documentation, Release 1 Welcome to the dota2api documentation. The dota2api library is a wrapper around the Dota 2 API 1 from Valve Software Contents 1

6 dota2api Documentation, Release 1 2 Contents

7 CHAPTER 1 Contents 1.1 Installation This part of the documentation covers the installation of the library. Tip: Work in a virtual environment! Pip Installing via pip 1 is probably the easiest method: Tip: Currently removed, TBC! $ pip install dota2api From Source You can also download the latest version from the repository 2 and run the setup file: $ python setup.py install Get The Code You can also download the latest version of the code from the repository 2 : $ git clone References 1.2 Tutorial This part of the documentation covers the basic usage of the library

8 dota2api Documentation, Release Getting an API Key Grab one from Valve Basic Usage Coming soon Common Uses Coming soon. 1.3 Library Reference Here is the library reference for the wrapper module along with the exceptions used dota2api.wrapper Returns a response object, the exact object returned depends on what API call was used class dota2api.wrapper.initialise(api_key=none, language=none) When calling this you need to provide the api_key You can also specify a language Parameters api_key (str) string with the api key language (str, optional) string that defaults to en_us if not set get_game_items() Returns a dictionary of in-game items, used to parse ids into localised names Returns dictionary of items see examples get_heroes() Returns a dictionary of in-game heroes, used to parse ids into localised names Returns dictionary of heroes see examples get_league_listing() Returns a dictionary containing a list of all ticketed leagues Parameters match_id (int, optional) Returns dictionary of ticketed leagues see examples get_live_league_games() Returns a dictionary containing a list of ticked games in progress Returns dictionary of live games see examples get_match_details(match_id=none, **kwargs) Returns a dictionary containing the details for a dota 2 match Parameters match_id (int, optional) Returns dictionary of matches see examples 4 Chapter 1. Contents

9 dota2api Documentation, Release 1 get_match_history(account_id=none, **kwargs) Returns a dictionary containing a list of the most recent dota matches Parameters hero_id (int, optional) game_mode (int, optional) see ref/modes.json skill (int, optional) see ref/skill.json date_min (int, optional) unix timestamp rounded to the nearest day date_max (int, optional) unix timestamp rounded to the nearest day min_players (int, optional) only return matches with minimum amount of players league_id (int, optional) for ids use get_league_listing() start_at_match_id (int, optional) start at matches equal to or older than this match id matches_requested (int, optional) defaults to 100 tournament_games_only (str, optional) limit results to tournament matches only Returns dictionary of matches see examples get_player_summaries(steamids=none, **kwargs) Returns a dictionary containing a player summaries Parameters steamids (list) list of 64-bit steam ids Returns dictionary of player summaries see examples get_team_info_by_team_id(start_at_team_id=none, **kwargs) Returns a dictionary containing a in-game teams Parameters start_at_team_id (int, optional) teams_requested (int, optional) Returns dictionary of teams see examples get_tournament_prize_pool(leagueid=none, **kwargs) Returns a dictionary that includes community funded tournament prize pools Parameters leagueid (int, optional) Returns dictionary of prize pools see examples dota2api.src.exceptions Not many exceptions exist due to server side validation on the parameters exception dota2api.src.exceptions.apiauthenticationerror(api_key=none) Raised when the API key supplied is invalid Parameters api_key (str) key used will be displayed upon error exception dota2api.src.exceptions.apitimeouterror Raised when too many requests are been made or the server is busy exception dota2api.src.exceptions.baseerror Base error used 1.3. Library Reference 5

10 dota2api Documentation, Release Contributing This document provides help with people who wish to contribute to the project Documentation Documentation improvements are always welcome, I am looking for this to be one of the definitive guides to the API as most information online is out of date Bug Reports Bug reports are welcome! 6 Chapter 1. Contents

11 CHAPTER 2 Indices and tables genindex modindex search 7

12 dota2api Documentation, Release 1 8 Chapter 2. Indices and tables

13 CHAPTER 3 References 9

14 dota2api Documentation, Release 1 10 Chapter 3. References

15 Python Module Index d dota2api.src.exceptions, 5 dota2api.wrapper, 4 11

16 dota2api Documentation, Release 1 12 Python Module Index

17 Index A APIAuthenticationError, 5 APITimeoutError, 5 B BaseError, 5 D dota2api.src.exceptions (module), 5 dota2api.wrapper (module), 4 G get_game_items() (dota2api.wrapper.initialise method), 4 get_heroes() (dota2api.wrapper.initialise method), 4 get_league_listing() (dota2api.wrapper.initialise method), 4 get_live_league_games() (dota2api.wrapper.initialise method), 4 get_match_details() (dota2api.wrapper.initialise method), 4 get_match_history() (dota2api.wrapper.initialise method), 4 get_player_summaries() (dota2api.wrapper.initialise method), 5 get_team_info_by_team_id() (dota2api.wrapper.initialise method), 5 get_tournament_prize_pool() (dota2api.wrapper.initialise method), 5 I Initialise (class in dota2api.wrapper), 4 13