Difference between revisions of "WebAPI"

From Team Fortress Wiki
Jump to: navigation, search
(Notes)
(Methods: Add new request, alphabetize list)
Line 17: Line 17:
 
== Methods ==
 
== Methods ==
  
;[[/GetSchema|GetSchema]]: Information about the items in a supporting game.
+
;[[/GetAssetClassInfo|GetAssetClassInfo]]: Asset metadata
;[[/GetPlayerItems|GetPlayerItems]]: Lists items in a player's backpack.
 
 
;[[/GetAssetPrices|GetAssetPrices]]: Prices of items in the economy.
 
;[[/GetAssetPrices|GetAssetPrices]]: Prices of items in the economy.
;[[/GetAssetClassInfo|GetAssetClassInfo]]: Asset metadata
+
;[[/GetFriendList|GetFriendList]]: User friend list
;[[/ResolveVanityURL|ResolveVanityURL]]: Resolve vanity URL parts to a 64 bit ID.
+
;[[/GetGlobalAchievementPercentagesForApp|GetGlobalAchievementPercentagesForApp]]: Statistics showing how much of the player base have unlocked various achievements.
 
;[[/GetNewsForApp|GetNewsForApp]]: News feed for various games
 
;[[/GetNewsForApp|GetNewsForApp]]: News feed for various games
;[[/GetGlobalAchievementPercentagesForApp|GetGlobalAchievementPercentagesForApp]]: Statistics showing how much of the player base have unlocked various achievements.
+
;[[/GetPlayerAchievements|GetPlayerAchievements]]: Game achievements
 +
;[[/GetPlayerItems|GetPlayerItems]]: Lists items in a player's backpack.
 
;[[/GetPlayerSummaries|GetPlayerSummaries]]: User profile data
 
;[[/GetPlayerSummaries|GetPlayerSummaries]]: User profile data
;[[/GetFriendList|GetFriendList]]: User friend list
+
;[[/GetSchema|GetSchema]]: Information about the items in a supporting game.
 
;[[/GetUGCFileDetails|GetUGCFileDetails]]: UGC file size, local filename, and URL.
 
;[[/GetUGCFileDetails|GetUGCFileDetails]]: UGC file size, local filename, and URL.
 +
;[[/ResolveVanityURL|ResolveVanityURL]]: Resolve vanity URL parts to a 64 bit ID.
  
 
== Notes ==
 
== Notes ==

Revision as of 03:17, 14 August 2012

Common elements

Parameters

All TF2 methods take the following arguments in their URL:

key
Your Steam Web API key. Without this, the server will return an HTTP 403 (forbidden) error. A key can be generated here.
format (Optional)
The file format to return output in.
json (default)
The JavaScript Object Notation format
xml
Standard XML
vdf
Valve Data Format

Terminology

A "tokenized string" refers to a string containing "#"-prefixed tokens that are replaced with the equivalent string in the game's VDF for the chosen language. For instance, "TF_Weapon_Jar" is defined as "Jar Based Karate" in tf/resource/tf_english.txt (as found in "team fortress 2 content.gcf").

Methods

GetAssetClassInfo
Asset metadata
GetAssetPrices
Prices of items in the economy.
GetFriendList
User friend list
GetGlobalAchievementPercentagesForApp
Statistics showing how much of the player base have unlocked various achievements.
GetNewsForApp
News feed for various games
GetPlayerAchievements
Game achievements
GetPlayerItems
Lists items in a player's backpack.
GetPlayerSummaries
User profile data
GetSchema
Information about the items in a supporting game.
GetUGCFileDetails
UGC file size, local filename, and URL.
ResolveVanityURL
Resolve vanity URL parts to a 64 bit ID.

Notes

List of valid IDs

440
Team Fortress 2
520
Team Fortress 2 Public Beta
570
Dota 2
620
Portal 2
816
Dota 2 internal test
205790
Dota 2 (beta) test

Methods Requiring a 64-bit User ID

Most API requests that take an ID parameter require a 64 bit ID, if one is not readily available a vanity URL part can be resolved via ResolveVanityURL.

Implementations

See also

  • Feedback for requests, suggestions, and issues.