WebAPI

From Team Fortress Wiki
Revision as of 01:01, 7 September 2012 by Filmore (talk | contribs) (Implementations)
Jump to: navigation, search

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

GetAppList
Full list of every publicly facing program in the store/library.
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
GetPlayerBans
Player ban/probation status
GetPlayerItems
Lists items in a player's backpack.
GetPlayerSummaries
User profile data
GetRarities
DOTA2 item rarity list.
GetSchema
Information about the items in a supporting game.
GetStoreSections
DOTA2 store sections.
GetUGCFileDetails
UGC file size, local filename, and URL.
ResolveVanityURL
Resolve vanity URL parts to a 64 bit ID.
UpToDateCheck
Check if a given app version is the most current available.

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.