Difference between revisions of "WebAPI/GetAssetClassInfo"
< WebAPI
(I almost definitely did not copy and paste this footer.) |
(Add apparently needed example and clarification, remove use of "zero-indexed". It was confusing in this context in the first place) |
||
| Line 36: | Line 36: | ||
* Turkish (tr, tr_TR) | * Turkish (tr, tr_TR) | ||
| − | ;classid''N'': Where N can be a series of | + | ;classid''N'': Where N can be a series of sequential numbers to form a list of class IDs. <ref name="placeholdervar">'''''N''''' refers to an incrementing ID starting from 0. For example: <b><nowiki>http://api.steampowered.com/ISteamEconomy/GetAssetClassInfo/v0001?key=APIKEY&format=json&language=en&appid=440&class_count=2&classid0=195151&classid1=16891096</nowiki></b>, with each consecutive classid incrementing from there.</ref> |
;class_count: The number of classids passed to the request | ;class_count: The number of classids passed to the request | ||
| Line 44: | Line 44: | ||
;success: '''true''' if the query was successful, '''false''' otherwise. | ;success: '''true''' if the query was successful, '''false''' otherwise. | ||
| − | ;''classnumber'': Where ''classnumber'' is a string corresponding to the given '''classid''N''''' list. | + | ;''classnumber'': Where ''classnumber'' is a string corresponding to the given '''classid''N'''''<ref name="placeholdervar"/> list. |
:;icon_url: An encoded URL to be passed to http://cdn.steamcommunity.com/economy/image/<encoded url> | :;icon_url: An encoded URL to be passed to http://cdn.steamcommunity.com/economy/image/<encoded url> | ||
| Line 61: | Line 61: | ||
:;fraudwarnings: An array of warnings that are displayed if the item can potentially be used to scam someone, for example a warning string indicating that an item has been renamed with a [[Name Tag]] in Team Fortress 2. | :;fraudwarnings: An array of warnings that are displayed if the item can potentially be used to scam someone, for example a warning string indicating that an item has been renamed with a [[Name Tag]] in Team Fortress 2. | ||
| − | ::;''N'': Where N is the index of the warning. Value is a localized warning string. | + | ::;''N'': Where N<ref name="placeholdervar"/> is the index of the warning. Value is a localized warning string. |
:;descriptions: An array of attributes attached to the item. Will be an empty string if none is available. | :;descriptions: An array of attributes attached to the item. Will be an empty string if none is available. | ||
| − | ::;''N'': Where ''N'' is the index of the attribute given as a string. | + | ::;''N'': Where ''N''<ref name="placeholdervar"/> is the index of the attribute given as a string. |
:::;type: The type of the attribute, includes '''text''' | :::;type: The type of the attribute, includes '''text''' | ||
:::;value: The localized attribute value. | :::;value: The localized attribute value. | ||
| Line 70: | Line 70: | ||
:;actions: An array of links and their labels related to the item. | :;actions: An array of links and their labels related to the item. | ||
| − | ::;''N'': Where ''N'' is the index of the action. | + | ::;''N'': Where ''N''<ref name="placeholdervar"/> is the index of the action. |
:::;name: The localized label of the link. | :::;name: The localized label of the link. | ||
:::;link: The URL to get more information about the item. | :::;link: The URL to get more information about the item. | ||
| + | |||
| + | == Notes == | ||
| + | <references/> | ||
{{Languages|WebAPI/GetAssetClassInfo}} | {{Languages|WebAPI/GetAssetClassInfo}} | ||
[[Category:WebAPI|GetAssetClassInfo]] | [[Category:WebAPI|GetAssetClassInfo]] | ||
Revision as of 21:17, 2 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)
- classidN
- Where N can be a series of sequential numbers to form a list of class IDs. [1]
- class_count
- The number of classids passed to the request
Result Data
- success
- true if the query was successful, false otherwise.
- classnumber
- Where classnumber is a string corresponding to the given classidN[1] list.
- icon_url
- An encoded URL to be passed to http://cdn.steamcommunity.com/economy/image/<encoded url>
- icon_url_large
- An encoded URL similar to icon_url or an empty string if not available.
- name
- The localized name of the item.
- name_color
- The RGB tuple used for the item's name line color as a hexadecimal value.
- background_color
- The RGB tuple used for the item's cell background as a hexadecimal value.
- type
- The localized string used to display the type of the item or an empty string if not available.
- tradable
- A string indicating the tradability status of the item, 1 if it can be traded or 0 otherwise.
- descriptions
- An array of attributes attached to the item. Will be an empty string if none is available.
- N
- Where N[1] is the index of the attribute given as a string.
- type
- The type of the attribute, includes text
- value
- The localized attribute value.
- color
- The RGB tuple of the attribute's description line as a hexadecimal value.
- actions
- An array of links and their labels related to the item.
- N
- Where N[1] is the index of the action.
- name
- The localized label of the link.
- link
- The URL to get more information about the item.
Notes
| Languages: | English |
