Difference between revisions of "WebAPI/GetAssetPrices"

From Team Fortress Wiki
Jump to: navigation, search
(People may need this. I don't know.)
(There is an easter egg here. Find it. I dare you)
Line 2: Line 2:
  
 
== URL ==
 
== URL ==
<nowiki>http://api.steampowered.com/IEconAssets_<ID>/GetAssetPrices/v0001/</nowiki>
+
<nowiki>http://api.steampowered.com/ISteamEconomy/GetAssetPrices/v0001/</nowiki>
  
 
See the [[WebAPI#appids|ID list]] for a valid ID.
 
See the [[WebAPI#appids|ID list]] for a valid ID.
  
 
== Method-specific Parameters ==
 
== Method-specific Parameters ==
 +
; appid
 +
:The [[WebAPI#appids|ID]] of the game to query assets from.
 +
 
; language
 
; language
 
:The [[Wikipedia:List of ISO 639-1 codes|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.
 
:The [[Wikipedia:List of ISO 639-1 codes|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.
Line 46: Line 49:
  
 
== Result Data ==
 
== Result Data ==
 +
 +
;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.
 
;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.
 
:;original_prices ''(<span style="color: red;">Optional</span>)'': An array equivalent to '''prices''' in layout. Present when the item is on sale.
 
:;original_prices ''(<span style="color: red;">Optional</span>)'': An array equivalent to '''prices''' in layout. Present when the item is on sale.
:;properties: An array containing information related to the item
+
:;class: A list of properties attached to the item
::;def_index: The schema ID of the item.
+
::;name: The name of the property.
 +
::;value: The value of the property.
 +
:;classid: The [[../GetAssetClassInfo|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 information related to the item's slot or special attributes. See '''tags'''
 
;tags: An array containing friendly names for the tags attached to items.
 
;tags: An array containing friendly names for the tags attached to items.

Revision as of 05:04, 1 December 2011

This documentation is for version v0001 of GetAssetPrices.

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)

Status codes

  • 1: The normal code. Should always be returned.

Result Data

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.
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
name
The name of the property.
value
The value of the property.
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

Price values

All prices are given as integers due to issues regarding precision. A double value can be obtained by dividing the price by 100.