WebAPI

From Team Fortress Wiki
Revision as of 11:58, 10 December 2011 by Lagg (talk | contribs)
Jump to: navigation, search

The Steam API is documented on Steam Community and has a Valve Developer Wiki entry, Steam Web API. The mapping of the API data to each data format is described on the latter.

Calls to the API require a valid Steam Web API key to function. You can get your own API Key here. Each example URL will only work after replacing "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" with your API key.

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.
format (Optional)
The format to return the data in ("json" for JSON, "xml" for XML, or "vdf" for VDF). The structure of the data for each format is described here. If no format is specified, the data will be returned with the default of JSON.

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

GetSchema
Returns information about the items in a supporting game.
GetPlayerItems
Lists items in a player's backpack.
GetAssetPrices
Prices of items in the economy.
GetAssetClassInfo
Asset metadata
ResolveVanityURL
Resolve vanity URL parts to a 64 bit ID.
GetNewsForApp
News feed for various games
GetGlobalAchievementPercentagesForApp
Statistics showing how much of the player base have unlocked various achievements.
GetPlayerSummaries
User profile data

Notes

List of valid IDs

440
Team Fortress 2
520
Team Fortress 2 Public Beta
620
Portal 2

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