Difference between revisions of "WebAPI/GetAssetPrices"

From Team Fortress Wiki
Jump to: navigation, search
m (Asset Name and Classes)
(Careful about how you use "integer" in type dependent documentation, also moved other notes to ref list)
Line 49: Line 49:
  
 
:;assets: A list of items with slot '''tags''' and prices in the chosen or all currency.
 
:;assets: A list of items with slot '''tags''' and prices in the chosen or all currency.
::;prices: An array containing the currency code and respective price, if a '''currency''' is specified only that currency value will be present.
+
::;prices: An array containing the currency code and respective price, if a '''currency''' is specified only that currency value will be present. <ref>All prices are given as integers due to issues regarding precision. A double value can be obtained by dividing the price by 100.</ref>
 
::;{{API optional|original_prices}}: An array equivalent to '''prices''' in layout. Present when the item is on sale.
 
::;{{API optional|original_prices}}: An array equivalent to '''prices''' in layout. Present when the item is on sale.
::;class: A list of properties attached to the item
+
::;class: A list of properties attached to the item <ref>Note that for first party (Valve) games there may be a '''def_index''' property present, its value is a string that can be converted to an integer for use in [[../GetSchema|schema]] item lookups.</ref>
 
:::;name: The name of the property.
 
:::;name: The name of the property.
 
:::;value: The value of the property.
 
:::;value: The value of the property.
Line 60: Line 60:
  
 
== Notes ==
 
== Notes ==
=== Price values ===
+
<references/>
All prices are given as integers due to issues regarding precision. A double value can be obtained by dividing the price by 100.
 
 
 
=== Asset Name and Classes ===
 
For Team Fortress 2 and DOTA2 (and their respective public betas, etc.), the asset "name" is always an integer equal to the value of one of the '''class''' objects with a name of "def_index". The def_index value is the unique identifier used for item definitions when querying backpacks, etc.
 
  
 
{{Languages|WebAPI/GetAssetPrices}}
 
{{Languages|WebAPI/GetAssetPrices}}
 
[[Category:WebAPI|GetAssetPrices]]
 
[[Category:WebAPI|GetAssetPrices]]

Revision as of 06:38, 3 September 2012

URL

http://api.steampowered.com/ISteamEconomy/GetAssetPrices/v0001/

See the ID list for a valid ID.

Method-specific Parameters

appid
The ID of the game to query assets from.
language
The ISO639-1 language code for the language all localized strings should be returned in. Not all strings have been translated to every language. If a language does not have a string, the English string will be returned instead. If this parameter is omitted the string token will be returned for the strings.

Supported languages:

  • Danish (da, da_DK)
  • Dutch (nl, nl_NL)
  • English (en, en_US)
  • Finnish (fi, fi_FI)
  • French (fr, fr_FR)
  • German (de, de_DE)
  • Hungarian (hu, hu_HU)
  • Italian (it, it_IT)
  • Japanese (ja, ja_JP)
  • Korean (ko, ko_KR)
  • Norwegian (no, no_NO)
  • Polish (pl, pl_PL)
  • Portuguese (pt, pt_PT)
  • Brazillian Portuguese (pt_BR)
  • Romanian (ro, ro_RO)
  • Russian (ru, ru_RU)
  • Simplified Chinese (zh, zh_CN)
  • Spanish (es, es_ES)
  • Swedish (sv, sv_SE)
  • Traditional Chinese (zh2, zh_TW)
  • Turkish (tr, tr_TR)
currency
The ISO 4217 code for currency specific filtering.

Supported codes:

  • US dollars (usd)
  • UK pound (gbp)
  • Euro (eur)
  • RU Ruble (rub)

Result Data

result
success
true if the query was successful, false otherwise.
assets
A list of items with slot tags and prices in the chosen or all currency.
prices
An array containing the currency code and respective price, if a currency is specified only that currency value will be present. [1]
original_prices (Optional)
An array equivalent to prices in layout. Present when the item is on sale.
class
A list of properties attached to the item [2]
name
The name of the property.
value
The value of the property.
name
The "name" of the asset. This has no set content besides that it is an identifier that can be used in URLs such as those for Valve's store frontend.
classid
The class ID of the item.
tags
An array containing information related to the item's slot or special attributes. See tags
tags
An array containing friendly names for the tags attached to items.

Notes

  1. All prices are given as integers due to issues regarding precision. A double value can be obtained by dividing the price by 100.
  2. Note that for first party (Valve) games there may be a def_index property present, its value is a string that can be converted to an integer for use in schema item lookups.