WebAPI/GetSchemaOverview

URL

https://api.steampowered.com/IEconItems_<ID>/GetSchemaOverview/v0001/?key=<API key>

See the ID list for a valid ID. You can get an API key here.

Method-specific Parameters

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 for TF2 are:

• 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)

Result Data

result

status

The status of the request, should always be 1.

items_game_url

A string containing the URL to the full item schema as used by the game.

qualities

An object containing the numeric values corresponding to each "quality" an item can have:

normal (0 - Normal)

Set on stock items.

rarity1 (1 - Genuine)

Set on items acquired for a promotional event (for example, Sun-On-A-Stick and Sharpened Volcano Fragment).

rarity2 (2)

Unused

vintage (3 - Vintage)

Set on items that were owned before certain updates and promotions.

rarity3 (4)

Unused

rarity4 (5 - Unusual)

Set on items with an effect attached or that were gained from a Halloween event.

unique (6 - Unique)

Set on the most common items including those found via drops and crafting.

community (7 - Community)

Set on items granted to community contributors.

developer (8 - Valve)

Set on items owned by Valve staff members.

selfmade (9 - Self-Made)

Set on items owned by 3rd-party content creators.

customized (10 - Customized)

Unused

strange (11 - Strange)

Set on ranked items.

completed (12 - Completed)

Unused

haunted (13 - Haunted)

Set on Halloween items.

collectors (14 - Collector's)

Set on Collector's items.

paintkitweapon (15 - Decorated Weapon)

Set on Decorated items.

qualityNames

If the language argument is specified this object is included in the output. It includes the translations of the internal quality names to the specified language.

originNames

A list of objects describing an item's origin.

origin

An integer identifying the origin. See GetPlayerItems.

name

The localized name of the origin.

attributes

An object containing an array of

name

A name describing the attribute (eg. "damage bonus" for damage increases found on weapons such as the Scotsman's Skullcutter, or "scattergun has knockback" for the Force-A-Nature's knockback)

defindex

The attribute's unique index, used to refer to unique instances of the item with these attributes in GetPlayerItems.

attribute_class

an underscore-based name for the attribute (eg. "mult_dmg" for the attribute whose name is "damage bonus")

minvalue

The minimum value allowed for this attribute. See notes

maxvalue

The maximum value allowed for this attribute. See notes

description_string (Optional)

The tokenized string that describes the attribute. See notes

description_format (Optional)

A string describing how to format the value for a description. See notes

value_is_percentage

For values that translate into percentages and are represented by that percentage (eg. changes to the blast radius)

value_is_inverted_percentage

For values that translate into percentages and are represented by the difference in that percentage from 100% (eg. changes to the fire rate)

value_is_additive

For values that are a specific number (eg. max health bonuses and bleed durations) and boolean attributes (such as The Sandman's ability to knock out balls)

value_is_additive_percentage

For values that add to an existing percentage (e.g. The Ubersaw adding 25% charge every hit)

value_is_date

For values that are a unix timestamp

value_is_particle_index

For values that are a particle effect type. See notes

value_is_account_id

For values that are a Steam account ID. See notes

value_is_or

Possibly for values that get applied if a condition is true (e.g. player is on fire)

value_is_item_def

For values that are an item ID (a defindex value in the schema)

effect_type

A string describing the type of effect the attribute has.

positive

The effect is outright beneficial to the user (displayed in blue text in the item description window)

negative

The effect is punitive to the user (red text)

neutral

The effect is more tangential to the normal behavior (eg. the Kritzkrieg's ÜberCharge being critical hits rather than invulnerability) (white text).

hidden

A boolean that indicates if the attribute's description should be hidden from user view.

stored_as_integer

A boolean that indicates whether or not the value of the attribute is stored as an integer (opposed to a float).

item_sets

A list of objects containing item set definitions.

item_set

The internal name of the set used for look ups.

name

The localized set name.

store_bundle (Optional)

The localized set name as it appears in the store.

items

A list of localized item names identifying the items contained in the set.

attributes (Optional)

A list of objects that describe special attributes granted by equipping a complete set. Layout is identical to to item attributes.

attribute_controlled_attached_particles

An object containing a list of objects that describe the defined particle effects.

system

The name of the particle system.

id

The effect's ID, referred to by the attached particle effect attribute.

attach_to_rootbone

A boolean that indicates whether or not the effect is attached to the "root" bone. That is the bone of the item with no parent bones used for rotation and animation calculations.

attachment (Optional)

A string indicating where the effect is attached.

name

The localized name of the effect.

item_levels

A list of objects that describe ranks for kill eater items.

name

The name of the rank set that the ranks are for.

levels

A list of objects describing requirements and levels of each rank.

level

The rank's level.

required_score

The required kill eater score to level up the rank to the next one.

name

The rank/prefix name.

kill_eater_score_types

An object containing a list of objects describing suffixes to use after a kill eater value in an attribute display line.

type

An integer matching the one found in kill eater score type attributes. Use this to determine the string to use as a suffix.

type_name

A localized suffix.

Notes

HTTP Headers

GetSchemaOverview responses will contain the Last-Modified header for use in caching and as a date for use in requests containing the If-Modified-Since header. This also applies to the client schema linked to by items_game_url.

Attribute Min and Max Values

Values found on items are not guaranteed to fall within this range: for instance, "attach particle effect" lists "0.000000" as both its minvalue and maxvalue, but non-zero values are used to specify what particle effect to attach.

Particle Index Type

This type was introduced with the Polycount Update. It is to be used as an index to retrieve the particle effect name/description string.

Account ID Type

There are two formats of IDs that can be extracted from this.

Steam Community ID

Add 76561197960265728 to this value for the 64 bit Steam Community ID

STEAM_0 ID

Divide this value by 2 for a STEAM_0 ID value

Attribute Descriptions

If the attribute is unused or there is no applicable description_string and description_format will be unset. If there is a language specified this will be the localized description string instead of the token.

In the localized description string there are "%s1" tokens, these are to be replaced with the appropriately formatted value generated with the format type and attribute values.