Difference between revisions of "WebAPI"

From Team Fortress Wiki
Jump to: navigation, search
(i-ghost missed one! Also might as well start this now)
(There, now all Joerelics are gone. Removing VDC links since there is no more information to be found there. VDF will get a simple language agnostic doc)
Line 1: Line 1:
The Steam API is documented on [http://steamcommunity.com/dev Steam Community] and has a Valve Developer Wiki entry, [[vdc:Steam_Web_API|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 [http://www.steamcommunity.com/dev/apikey here]. Each example URL will only work after replacing "<code>XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX</code>" with your API key.
 
 
 
== Common elements ==
 
== Common elements ==
  
Line 9: Line 5:
 
All TF2 methods take the following arguments in their URL:
 
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.
+
;key: Your Steam Web API key. Without this, the server will return an HTTP 403 (forbidden) error. A key can be generated [http://www.steamcommunity.com/dev/apikey here].
;{{API optional|format}}: The format to return the data in ("'''<code>json</code>'''" for JSON, "'''<code>xml</code>'''" for XML, or "'''<code>vdf</code>'''" for VDF). The structure of the data for each format is described [[vdc:Steam_Web_API#Formats|here]]. If no format is specified, the data will be returned with the default of JSON.
+
;{{API optional|format}}: The file format to return output in.
 +
:;<code>json</code> (default): The [http://json.org JavaScript Object Notation] format
 +
:;<code>xml</code>: Standard XML
 +
:;<code>vdf</code>: [[/VDF|Valve Data Format]]
  
 
=== Terminology ===
 
=== Terminology ===
Line 51: Line 50:
  
 
* [[Talk:WebAPI/Feedback|Feedback]] for requests, suggestions, and issues.
 
* [[Talk:WebAPI/Feedback|Feedback]] for requests, suggestions, and issues.
* [[vdc:Steam_Web_API|Steam Web API]] for more information and other methods.
 
  
 
[[Category:Valve]]
 
[[Category:Valve]]
 
[[Category:WebAPI| ]]
 
[[Category:WebAPI| ]]

Revision as of 16:31, 12 December 2011

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

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

  • Feedback for requests, suggestions, and issues.