Difference between revisions of "WebAPI/GetMatchHistory"

From Team Fortress Wiki
Jump to: navigation, search
m (Fixing url)
Line 1: Line 1:
 
== URL ==
 
== URL ==
 
<nowiki>GET http://api.steampowered.com/IDOTA2Match_<ID>/GetMatchHistory/v1</nowiki>
 
<nowiki>GET http://api.steampowered.com/IDOTA2Match_<ID>/GetMatchHistory/v1</nowiki>
 
Supported IDs: 570, 205790.
 
  
 
== Method-specific parameters ==
 
== Method-specific parameters ==

Revision as of 22:09, 3 February 2013

URL

GET http://api.steampowered.com/IDOTA2Match_<ID>/GetMatchHistory/v1

Method-specific parameters

player_name (Optional) (string)
Exact match of a player's display-name at the time of the match.
hero_id (Optional) (uint32)
A list of hero IDs can be found via the GetHeroes method.
game_mode (Optional) (uint32)
0 - All Pick
1 - Single Draft
2 - All Random
3 - Random Draft
4 - Captain's Draft
5 - Captain's Mode
6 - Death Mode
7 - Diretide
8 - Reverse Captain's Mode
9 - The Greeviling
10 - Tutorial
11 - Mid Only
12 - Least Played
13 - New Player Pool
skill (Optional) (uint32)
Skill bracket for the matches.
0 - Any
1 - Normal
2 - High
3 - Very High
date_min (Optional) (uint32)
Minimum date range for returned matches (unix timestamp).
date_max (Optional) (uint32)
Maximum date range for returned matches (unix timestamp).
min_players (Optional) (string)
Minimum amount of players in a match for the match to be returned.
account_id (Optional) (string)
32-bit account ID.
league_id (Optional) (string)
Only return matches from this league. A list of league IDs can be found via the GetLeagueListing method.
start_at_match_id (Optional) (string)
Start searching for matches newer than this match ID.
matches_requested (Optional) (string)
Amount of matches to include in results (default: 25).
tournament_games_only (Optional) (string)
Whether to limit results to tournament matches.

Result data

result
status
1 - Success
15 - Cannot get match history for a user that hasn't allowed it.
statusDetail
A message explaining the status, should status not be 1.
num_results
The number of matches in this response.
total_results
The total number of matches for the query.
results_remaining
The number of matches left for this query.
matches
A list of matches.
match_id
The matches unique ID.
match_seq_num
A 'sequence number', representing the order in which matches were recorded.
start_time
Unix timestamp of when the match began.
lobby_type
-1 - Invalid
0 - Public matchmaking
1 - Practise
2 - Tournament
3 - Tutorial
4 - Co-op with bots.
5 - Team match
players
The list of players within the match.
account_id
32-bit account ID.
player_slot
See #Player slot below.
hero_id
The hero's unique ID. A list of hero IDs can be found via the GetHeroes method.

Player Slot

A player's slot is returned via an 8-bit unsigned integer. The first bit represent the player's team, false if Radiant and true if dire. The final three bits represent the player's position in that team, from 0-4.

   ┌─────────────── Team (false if Radiant, true if Dire).
   │ ┌─┬─┬─┬─────── Not used.
   │ │ │ │ │ ┌─┬─┬─ The position of a player within their team (0-4).
   │ │ │ │ │ │ │ │
   0 0 0 0 0 0 0 0