View source for WebAPI/GetSchemaItems

{{update|Check for missing data}}
== URL ==
<nowiki>https://api.steampowered.com/IEconItems_<ID>/GetSchemaItems/v0001/?key=<API key></nowiki>

See the [[WebAPI#appids|ID list]] for a valid ID. You can get an API key [https://steamcommunity.com/dev/apikey here].

== Method-specific Parameters ==
; {{API optional|language}} (string)
: 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.

; {{API optional|start}} (int32): The first item id to return. Defaults to 0. Response will indicate next value to query if applicable.

== 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.
:; items: A list of item objects. The items array will return at most 1000 items.
::;name: A string that defines the item in the items_game.txt
::;defindex: The item's unique index, used to refer to instances of the item in GetPlayerItems.
::;item_class: The item's class in game (ie. what you would use as the argument to "equip" in the console to equip it).
::;item_type_name: The tokenized string that describes the item's class (eg. "<tt>#TF_Wearable_Shield</tt>" for the [[Chargin' Targe]] and the [[Razorback]]). If the language argument is specified the string for that language will be returned instead of the token.
::;item_name: The tokenized string for the item's name (eg. "<tt>#TF_Spy_Camera_Beard</tt>" for the [[Camera Beard]]). If the language argument is specified the string for that language will be returned instead of the token.
::;{{API optional|item_description}}: The tokenized string for the item's description if it has one. If a language is specified this will be the localized description string.
::;proper_name: A boolean value indicating the item requires "The" to be prefixed to it's name. Ignored if language is not English.
::;item_slot: A string indicating what loadout slot the item can be equipped to.
:::;''primary'': Primary slot items (including "Slot Token - Primary")
:::;''secondary'': Secondary slot items (including "Slot Token - Secondary")
:::;''melee'': Melee slot items (including "Slot Token - Melee")
:::;''head'': Hats and "Slot Token - Head"
:::;''misc'': Misc slot items such as medals
:::;''pda'': The Engineer's Build PDA, the Spy's Disguise Kit, and "Slot Token - PDA"
:::;''pda2'': The Engineer's Destroy PDA, the Spy's [[Invisibility Watch]], the [[Cloak and Dagger]], the [[Dead Ringer]], and "Slot Token - PDA2"
:::;''building'': "TF_WEAPON_BUILDER" (an unused copy of the Engineer's Build PDA) and the unused "Slot Token - Building"
:::;''grenade'': The unused "Slot Token - Grenade"
:::;''action'': Gifts and the Duel minigame
::;item_quality: The item's default quality value. See description of "<tt>qualities</tt>" above.
::;image_inventory: The image to display, as an escaped-slash ("\/") path to the material, without the extension
::;image_url: The URL of the small (128x128) backpack icon for the relevant item. Will be an empty string if none is available.
::;image_url_large: The URL of the large (512x512) backpack image for the relevant item. Will be an empty string if none is available.
::;{{API optional|drop_type}}: A string indicating how an item will detach (if it does) from the player upon death. This is only relevant to cosmetic items (for example, the drop type of the [[Le Party Phantom]] would be ''none'' and the mask will stay attached to the Spy's face upon death. The [[Fancy Fedora]] would have a drop type of ''drop'' and will fall from the Spy's head.)
:::;''none'': The item does not detach.
:::;''drop'': The item detaches.
::;{{API optional|item_set}}: Used to look up the set the item is part of in item_sets.
::;{{API optional|holiday_restriction}}: A string indicating the holiday on which the item can be used, if not present the item is available all year.
:::;''halloween_or_fullmoon'': [[Holiday#Halloween|Halloween or Full Moon Events]]
:::;''halloween'': [[Holiday#Halloween|Halloween]] - Currently only used on [[Eerie Crates]]
:::;''christmas'': [[Holiday#Smissmas|Smissmas]] - Currently only used on [[Noise_Maker#Australian_Christmas_2011|Winter Holiday Noisemakers]]
:::;''birthday'': [[Holiday#TF_Birthday|Birthday]] - Currently only used on [[Noise_Maker#Team_Fortress_Birthday|TF Birthday Noisemakers]]
::;model_player: The model to display for the item, using a path similar to the above but with an ".mdl" extension, or null if the object has no model.
::;min_ilevel: The minimum level of the item in the schema. See [[#Level Ranges|notes]]
::;max_ilevel: The maximum level of the item in the schema. See [[#Level Ranges|notes]]
::;{{API optional|craft_class}}: The type of the item from the crafting system's point of view. If this field is not present the item cannot be crafted by the random crafting recipes. If it is not empty it will be weapon, hat, craft_bar, haunted_hat, tool, supply_crate, or craft_token.
::;{{API optional|craft_material_type}}: Similar to craft_class, except this determines if it can be used in certain crafting recipes. An item can be used in random recipes without being able to be crafted by random recipes and visa-versa.
::;{{API optional|capabilities}}: An object describing various capabilities of the item, including how it can be interacted with.
:::;can_craft_mark: The item will have the crafter's name attached to it.
:::;nameable: [[Tags]] can be used on the item.
:::;can_gift_wrap: The item can be [[gift wrap]]ped.
:::;paintable: The item can be [[paint]]ed.
:::;can_craft_count: The item can be marked as a numbered craft.
:::;decodable: The item can be opened with a key (this possibly refers to an abandoned predecessor of the crate system).
:::;usable: The item is an Action item.
:::;usable_gc: May mark items that can be used from within the backpack and do not need to be assigned a loadout slot.
:::;usable_out_of_game: May mark items that can be activated while the user is not in-game.
::;{{API optional|tool}}: If the item is a tool this will contain certain meta-data such as it's type, purpose, or string for use in the client UI.
::;{{API optional|used_by_classes}}: The list of classes that can use this item. If this field is not present all classes can use the item.
::;{{API optional|per_class_loadout_slots}}: An object that describes class specific loadout slots for the item if applicable.
::;{{anchor|styles}} styles ''(<span style="color: red;">Optional</span>)'': If the item has changeable styles, an object containing an array of
:::;name: The style's name.
::;{{API optional|attributes}}: If the item has effects normally associated with it, an object containing an array of
:::;name: The attribute's <tt>name</tt> value ''(see below)''
:::;class: The attribute's <tt>attribute_class</tt> value ''(see below)''
:::;value: The "value" of that attribute as a "%0.6f" formatted number: 1 (or 0) for boolean attributes (such as the [[Razorback]]'s backstab blocking), or the multiplier for percentage-based attributes (such as 0.300000 for the [[Direct Hit]]'s 30% blast radius, or 1.800000 for its 180% projectile speed)
:;{{API optional|next}}: Value to set up the next query to get the next set of results. The values match an item's defindex to start from.

== Notes ==

=== HTTP Headers ===

GetSchemaItems 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'''.

=== Image Permissions ===
You are welcome to use the backpack images provided by image_url and image_url_large directly or to copy the files to your own server.

[[Category:WebAPI|GetSchema]]