WebAPI

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

GetSchema

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

GetFriendList

User friend list

GetUGCFileDetails

UGC file size, local filename, and URL.

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

• Steam Condenser Ruby, PHP, and Java library.
• TF2 Web APpy A small Python class.
• Steamodd Python module.
  • OPTF2 online viewer (source code).
• libsc An Objective-C library for iOS (4.0+) and framework for Mac OS X (10.6+).

See also

• Feedback for requests, suggestions, and issues.