Difference between revisions of "WebAPI/GetMatchHistory"

From Team Fortress Wiki
Jump to: navigation, search
(lagg fix)
 
(17 intermediate revisions by 10 users not shown)
Line 3: Line 3:
  
 
== Method-specific parameters ==
 
== Method-specific parameters ==
−
;{{API optional|player_name}} ''(string)'':
+
;{{API optional|hero_id}} ''(uint32)'': A list of hero IDs can be found via the [[WebAPI/GetHeroes|GetHeroes]] method.
−
;{{API optional|hero_id}} ''(uint32)'':
 
 
;{{API optional|game_mode}} ''(uint32)'':
 
;{{API optional|game_mode}} ''(uint32)'':
−
;{{API optional|skill}} ''(uint32)'':
+
:;0 - None:
−
;{{API optional|date_min}} ''(uint32)'':
+
:;1 - All Pick:
−
;{{API optional|date_max}} ''(uint32)'':
+
:;2 - Captain's Mode:
−
;{{API optional|min_players}} ''(string)'':
+
:;3 - Random Draft:
−
;{{API optional|account_id}} ''(string)'':
+
:;4 - Single Draft:
−
;{{API optional|league_id}} ''(string)'':
+
:;5 - All Random:
−
;{{API optional|start_at_match_id}} ''(string)'':
+
:;6 - Intro:
−
;{{API optional|matches_requested}} ''(string)'':
+
:;7 - Diretide:
−
;{{API optional|tournament_games_only}} ''(string)'':
+
:;8 - Reverse Captain's Mode:
 +
:;9 - The Greeviling:
 +
:;10 - Tutorial:
 +
:;11 - Mid Only:
 +
:;12 - Least Played:
 +
:;13 - New Player Pool:
 +
:;14 - Compendium Matchmaking:
 +
:;16 - Captain's Draft:
 +
;{{API optional|skill}} ''(uint32)'': Skill bracket for the matches (Ignored if an account ID is specified).
 +
:;0 - Any:
 +
:;1 - Normal:
 +
:;2 - High:
 +
:;3 - Very High:
 +
;{{API optional|min_players}} ''(string)'': Minimum amount of players in a match for the match to be returned.
 +
;{{API optional|account_id}} ''(string)'': 32-bit or 64-bit account ID.
 +
;{{API optional|league_id}} ''(string)'': Only return matches from this league. A list of league IDs can be found via the [[WebAPI/GetLeagueListing|GetLeagueListing]] method.
 +
;{{API optional|start_at_match_id}} ''(string)'': Start searching for matches equal to or older than this match ID.
 +
;{{API optional|matches_requested}} ''(string)'': Amount of matches to include in results (default: 25).
 +
;{{API optional|tournament_games_only}} ''(string)'': Whether to limit results to tournament matches. (0 = false, 1 = true)
  
 
== Result data ==
 
== 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:
 +
:::;6 - Solo Queue:
 +
:::;7 - Ranked Matchmaking:
 +
:::;8 - 1v1 Solo Mid:
 +
::;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 [[WebAPI/GetHeroes|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
 +
 +
== Notes ==
 +
<references/>
 +
 +
[[Category:WebAPI|GetMatchHistory]]

Latest revision as of 12:15, 20 October 2022

URL

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

Method-specific parameters

hero_id (Optional) (uint32)
A list of hero IDs can be found via the GetHeroes method.
game_mode (Optional) (uint32)
0 - None
1 - All Pick
2 - Captain's Mode
3 - Random Draft
4 - Single Draft
5 - All Random
6 - Intro
7 - Diretide
8 - Reverse Captain's Mode
9 - The Greeviling
10 - Tutorial
11 - Mid Only
12 - Least Played
13 - New Player Pool
14 - Compendium Matchmaking
16 - Captain's Draft
skill (Optional) (uint32)
Skill bracket for the matches (Ignored if an account ID is specified).
0 - Any
1 - Normal
2 - High
3 - Very High
min_players (Optional) (string)
Minimum amount of players in a match for the match to be returned.
account_id (Optional) (string)
32-bit or 64-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 equal to or older 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. (0 = false, 1 = true)

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
6 - Solo Queue
7 - Ranked Matchmaking
8 - 1v1 Solo Mid
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

Notes

Retrieved from "https://wiki.teamfortress.com/w/index.php?title=WebAPI/GetMatchHistory&oldid=3288666"