Difference between revisions of "WebAPI/GetPlayerItems"

From Team Fortress Wiki
Jump to: navigation, search
(→‎URL)
(→‎URL)
Line 10: Line 10:
 
'''Example:'''   
 
'''Example:'''   
  
−
<nowiki>http://api.steampowered.com/IEconItems_</nowiki>'''<Game_ID>'''/GetPlayerItems/v0001/?steamID='''<Your ID>'''&key='''<Your API Key Here>'''&format='''xml'''&lang='''en_US'''
+
<nowiki>http://api.steampowered.com/IEconItems_</nowiki>'''<Game_ID>'''/GetPlayerItems/v0001/?steamID='''<Your ID>'''&key='''<Your API Key Here>'''&format='''xml'''
  
  
Line 37: Line 37:
  
  
−
'''Language''': See below for language options.
+
'''Completed Example''' (for TF2 items, my community id, xml output):  
  
−
 
+
<nowiki>http://api.steampowered.com/IEconItems_440/GetPlayerItems/v0001/?steamID=76561197993107733&key=</nowiki>'''<Your API Key Here>'''&format=xml
−
'''Completed Example''' (for TF2 items, my community id, xml output, en_US language):
 
−
 
 
−
<nowiki>http://api.steampowered.com/IEconItems_440/GetPlayerItems/v0001/?steamID=76561197993107733&key=</nowiki>'''<Your API Key Here>'''&format=xml&lang=en_US
 
  
  
Line 49: Line 46:
 
string responseText= string.empty;
 
string responseText= string.empty;
  
−
string address = <nowiki>"http://api.steampowered.com/IEconItems_440/GetPlayerItems/v0001/?steamID=76561197993107733</nowiki>&key='''<Your API Key Here>'''&format=xml&lang=en_US";
+
string address = <nowiki>"http://api.steampowered.com/IEconItems_440/GetPlayerItems/v0001/?steamID=76561197993107733</nowiki>&key='''<Your API Key Here>'''&format=xml";
  
  

Revision as of 16:10, 27 October 2011

This documentation is for version v0001 of the WebAPI (GetPlayerItems). This method returns the specified player's backpack content.

URL

http://api.steampowered.com/IEconItems_<ID>/GetPlayerItems/v0001/

See the ID list for a valid ID.


Example:

http://api.steampowered.com/IEconItems_<Game_ID>/GetPlayerItems/v0001/?steamID=<Your ID>&key=<Your API Key Here>&format=xml


Game_ID:

440: Team Fortress 2

520: Team Fortress 2 Public Beta

620: Portal 2


Your ID: Your steam community id. (Ex: 76561197993107733)

To get your id go to http://www.vacbanned.com and enter your name/steam profile url. Your id will be the first element listed.


Format: (can be one of the following)

json - The output will be returned in the JSON format

xml - Output is returned as an XML document

vdf - Output is returned as a VDF file.


Completed Example (for TF2 items, my community id, xml output):

http://api.steampowered.com/IEconItems_440/GetPlayerItems/v0001/?steamID=76561197993107733&key=<Your API Key Here>&format=xml


C# Example

string responseText= string.empty;

string address = "http://api.steampowered.com/IEconItems_440/GetPlayerItems/v0001/?steamID=76561197993107733&key=<Your API Key Here>&format=xml";


using (WebClient client = new WebClient())

{

Response = client.DownloadString(address);

}

XmlDocument itemSchema = new XmlDocument();

itemSchema.Load(responseText);

Method-specific parameters

SteamID
The 64-bit ID of the user the backpack will be retrieved for.

Status codes

  • 1: OK. Data returned as specified below.
  • 8 ("SteamID parameter was missing"): The "steamID" parameter of the URL was not included, or if present was not a valid SteamID64 value.
  • 15 ("Permission denied"): The player's profile is set to "Private".
  • 18 ("Unknown account"): The "steamID" parameter was not registered to an account.

Result data

A list of the player's items is returned as follows:

num_backpack_slots
The number of backpack slots this user has.
items
An object containing a list of associative arrays.
id
The unique ID of the specific item.
original_id
The ID of the item before it was customized, traded, or otherwise changed.
defindex
The defindex of the item, as found in the item array returned from GetSchema.
level
The arbitrary "level" value of the item as displayed in the inventory.
quantity
The number of "uses" an item has, generally only has a value in excess of '1' on "usable items", such as the Dueling Mini-Game.
flag_cannot_trade
A boolean value that is true if the item cannot be traded. This is true for items granted by an achievement, purchased items, and certain promotional items.
inventory
An inventory token as described here, or '0' if the item has been awarded and not yet found (placed in the backpack).
quality
The quality of the item (see definition in GetSchema).
custom_name (Optional)
The item's custom name if it has one.
custom_desc (Optional)
The item's custom description if it has one.
contained_item (Optional)
All the information for the item that this item contains for gift-wrapped items.
style (Optional)
An integer that can be used as an index to the item's style list.
attributes (Optional)
If the item has additional effects to the ones normally associated with it as described in GetSchema, contains a list of associative arrays.
defindex
The index to the attributes definition in the schema, e.g. 133 for the medal number attribute for the Gentle Manne's Service Medal.
value
The value for this attribute for this item, e.g. the medal number for the Gentle Manne's Service Medal.
float_value (Optional)
The floating point value for this attribute if it has one.
account_info (Optional)
Set on attributes with a Steam ID as the value.
steamid
The specified user's unique 64-bit Steam ID.
personaname
The specified user's current name on Steam.
equipped (Optional)
If the item is equipped, contains an array of equip information
class
The class the weapon is equipped to (numeric index).
slot
The slot the weapon is equipped in (numeric index).

Inventory token

The inventory token is a combination of class loadout flags and position in the player's backpack. This unsigned 32-bit integer is split into two two-byte words. The high word contains flags for each class. 1-bit in a class's slot indicates that the item is equipped in the appropriate loadout slot for that class. The low word contains the backpack position with '0' if the item has been awarded, but not yet found (placed in the backpack), '1' being the upper left slot, '2' the second slot from the left on the top row, etc. Here it is visually: 


  ┌─────────────────────────────────────────────────────────────── Always '1'
  │ ┌─┬─┬─┬─┬─┬─────────────────────────────────────────────────── Unused
  │ │ │ │ │ │ │ ┌───────────────────────────────────────────────── Engineer 
  │ │ │ │ │ │ │ │ ┌─────────────────────────────────────────────── Spy 
  │ │ │ │ │ │ │ │ │ ┌───────────────────────────────────────────── Pyro 
  │ │ │ │ │ │ │ │ │ │ ┌─────────────────────────────────────────── Heavy 
  │ │ │ │ │ │ │ │ │ │ │ ┌───────────────────────────────────────── Medic 
  │ │ │ │ │ │ │ │ │ │ │ │ ┌─────────────────────────────────────── Demoman 
  │ │ │ │ │ │ │ │ │ │ │ │ │ ┌───────────────────────────────────── Soldier 
  │ │ │ │ │ │ │ │ │ │ │ │ │ │ ┌─────────────────────────────────── Sniper (or Atlas)
  │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ ┌───────────────────────────────── Scout (or P-Body)
  │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ ┌─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─ Backpack position 
  │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │
  0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0

Examples: 

  1 0 0 0 0 0 0 0 0 1 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 1 0 0 1  Equipped Pyro item 
                                                                   in backpack slot 9
  1 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 1 0 1 0 0 1  Unequipped item 
                                                                   in backpack slot 41
  1 0 0 0 0 0 0 1 0 1 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 1 0 1 0 1 0  Equipped by Pyro and Engineer
                                                                   in backpack slot 42


Languages: English
Retrieved from "https://wiki.teamfortress.com/w/index.php?title=WebAPI/GetPlayerItems&oldid=791505"