API:2/items

From Guild Wars 2 Wiki
Jump to: navigation, search

/v2/items

HTTP method
GET
Format
json
API version
version 2
Release date
2014-09-25
Scope
none
Optional
none

This resource returns information about items that were discovered by players in the game.

Endpoints

  • None - Request the list of all available items ids when the root endpoint (v2/items) has been accessed.
  • id - (Optional) Request items for the specified id when accessing the endpoint (v2/items/id). Cannot be used when specifying the ids parameter.

Parameters

  • lang – (Optional) Request localized information.
  • ids - (Optional; Comma Delimited List) Request an array of items for the specified ids. Cannot be used when using the id endpoint.

Response

For each requested item id, an object with the following properties is returned:

  • id (number) – The item id.
  • chat_link (string) – The chat link.
  • name (string) – The item name.
  • icon (string) – The full icon URL.
  • description (string, optional) – The item description.
  • type (string) – The item type (see below). Possible values:
  • rarity (string) – The item rarity. Possible values:
    • Junk
    • Basic
    • Fine
    • Masterwork
    • Rare
    • Exotic
    • Ascended
    • Legendary
  • level (number) – The required level.
  • vendor_value (number) – The value in coins when selling to a vendor. (Can be non-zero even when the item has the NoSell flag.)
  • default_skin (number, optional) – The default skin id.
  • flags (array of strings) – Flags applying to the item. Possible values:
    • AccountBindOnUseAccount bound on use
    • AccountBound – Account bound on acquire
    • Attuned - If the item is Attuned
    • BulkConsume - If the item can be bulk consumed
    • DeleteWarning - If the item will prompt the player with a warning when deleting
    • HideSuffix – Hide the suffix of the upgrade component
    • Infused - If the item is infused
    • MonsterOnly
    • NoMysticForge – Not usable in the Mystic Forge
    • NoSalvage – Not salvageable
    • NoSell – Not sellable
    • NotUpgradeable – Not upgradeable
    • NoUnderwater – Not available underwater
    • SoulbindOnAcquireSoulbound on acquire
    • SoulBindOnUse – Soulbound on use
    • Tonic - If the item is a tonic
    • UniqueUnique
  • game_types (array of strings) – The game types in which the item is usable. At least one game type is specified. Possible values:
  • restrictions (array of strings) – Restrictions applied to the item. Possible values:
    • Asura
    • Charr
    • Human
    • Norn
    • Sylvari
    • Elementalist
    • Engineer
    • Guardian
    • Mesmer
    • Necromancer
    • Ranger
    • Thief
    • Warrior
  • details (object, optional) – Additional item details if applicable, depending on the item type (see below).

Armor

For armor, the details object contains the following properties:

  • type (string) – The armor slot type.
    • Boots – Feet slot
    • Coat – Chest slot
    • Gloves – Hands slot
    • Helm – Helm slot
    • HelmAquaticBreathing apparatus slot
    • Leggings – Legs slot
    • Shoulders – Shoulders slot
  • weight_class (string) – The weight class of the armor piece.
  • defense (number) – The defense value of the armor piece.
  • infusion_slots (array of objects) – Infusion slots of the armor piece (see below).
  • infix_upgrade (object, optional) – The infix upgrade object (see below).
  • suffix_item_id (number, optional) – The suffix item id. This is usually a rune.
  • secondary_suffix_item_id (string) – The secondary suffix item id. Equals to an empty string if there is no secondary suffix item.
  • stat_choices (array of numbers, optional) - A list of selectable stat IDs which are visible in API:2/itemstats

Back item

For back items, the details object contains the following properties:

  • infusion_slots (array of objects) – Infusion slots of the back item (see below).
  • infix_upgrade (object, optional) – The infix upgrade object (see below).
  • suffix_item_id (number, optional) – The suffix item id. This is usually a jewel.
  • secondary_suffix_item_id (string) – The secondary suffix item id. Equals to an empty string if there is no secondary suffix item.
  • stat_choices (array of numbers, optional) - A list of selectable stat IDs which are visible in API:2/itemstats

Bag

For bags, the details object contains the following properties:

  • size (number) – The number of bag slots.
  • no_sell_or_sort (boolean) – Whether the bag is invisible/safe, and contained items won't show up at merchants etc.

Consumable

For consumables, the details object contains the following properties:

Container

For containers, the details object contains the following property:

Gathering tools

For gathering tools, the details object contains the following property:

Gizmo

For gizmo items, the details object contains the following properties:

Miniature

For miniatures (MiniPets), the details object contains the following property:

  • minipet_id (number) - The miniature it unlocks and can be resolved against /v2/minis

Salvage kits

For salvage kits (tools), the details object contains the following properties:

  • type (string) – The tool type. Always Salvage
  • charges (number) – Number of charges.

Trinket

For trinkets, the details object contains the following properties:

  • type (string) – The trinket type. Possible values:
  • infusion_slots (array of objects) – Infusion slots of the trinket (see below).
  • infix_upgrade (object, optional) – The infix upgrade object (see below).
  • suffix_item_id (number, optional) – The suffix item id. This is usually a jewel or gem.
  • secondary_suffix_item_id (string) – The secondary suffix item id. Equals to an empty string if there is no secondary suffix item.
  • stat_choices (array of numbers, optional) - A list of selectable stat IDs which are visible in API:2/itemstats

Upgrade component

For upgrade components, the details object contains the following properties:

  • type (string) – The type of the upgrade component. Possible values:
  • flags (array of strings) – The items that can be upgraded with the upgrade component. Possible values:
    • Weapons: Axe, Dagger, Focus,Greatsword, Hammer, Harpoon, LongBow, Mace, Pistol, Rifle, Scepter, Shield, ShortBow, Speargun, Staff, Sword, Torch, Trident, Warhorn
    • Armor: HeavyArmor, MediumArmor, LightArmor
    • Trinkets: Trinket
  • infusion_upgrade_flags (array of strings) – Applicable infusion slot for infusion upgrades. Possible values:
  • suffix (string) – The suffix appended to the item name when the component is applied.
  • infix_upgrade (object) – Bonus the upgrade grants. Has the following properties:
    • id (number) - Id of the upgrade component.
    • attributes (array) – Empty for all currently discovered items
    • buff (object, optional) – Object containing the upgrade component's effect. Has the following properties:
      • skill_id (number) – The skill id of the effect.
      • description (string) – The effect's description.
  • bonuses (list of strings, optional) – The bonuses from runes.

Note: For runes, the effect is specified in the bonuses property. In that case, the infix_upgrade does not contain a buff property. All other upgrade components don't list a bonuses property but specify all their effects in the buff subproperty.

Weapon

For weapons, the details object contains the following properties:

  • type (string) – The weapon type.
    • One-handed main hand: Axe, Dagger, Mace, Pistol, Scepter, Sword
    • One-handed off hand: Focus, Shield, Torch, Warhorn
    • Two-handed: Greatsword, Hammer, LongBow, Rifle, ShortBow, Staff
    • Aquatic: Harpoon, Speargun, Trident
    • Other: LargeBundle, SmallBundle, Toy, ToyTwoHanded
  • damage_type (string) – The damage type.
    • Fire – Fire damage
    • Ice – Ice damage
    • Lightning – Lighting damage
    • Physical – Physical damage.
    • Choking – (not used)
  • min_power (number) – Minimum weapon strength.
  • max_power (number) – Maximum weapon strength.
  • defense (number) – The defense value of the weapon (for shields).
  • infusion_slots (array of objects) – Infusion slots of the weapon (see below).
  • infix_upgrade (object, optional) – The infix upgrade object (see below).
  • suffix_item_id (number, optional) – The suffix item id. This is usually a sigil.
  • secondary_suffix_item_id (string) – The secondary suffix item id. Equals to an empty string if there is no secondary suffix item.
  • stat_choices (array of numbers, optional) - A list of selectable stats IDs which are visible in API:2/itemstats

Other types

Crafting materials, trophies, and Traits don't have an additional details object.

Subobjects

Infix upgrade subobject

The infix upgrade is an object with the following properties:

  • id (number) - The itemstat id that can be resolved against /v2/itemstats.
  • attributes (array of object) – List of attribute bonuses. Each object contains the following properties:
  • buff (object, optional) – Object containing an additional effect. This is used for Boon Duration, Condition Duration, or additional attribute bonuses for ascended trinkets or back items. It has the following properties:
    • skill_id (number) – The skill id of the effect.
    • description (string) – The effect's description.

Infusion slots subobject

An infusion slots object is an object with the following properties:

  • flags (array of strings) – Infusion slot type of infusion upgrades. The array contains a maximum of one value. Possible values:
    • Enrichment – Item has an enrichment slot.
    • Infusion – Item has an infusion slot.
  • item_id (number, optional) – The infusion upgrade already in the armor piece. Only used for +5 Agony Infusions (id 49428).[verification requested]

Note: If no infusion slot is present, the value of the infusion_slots property is an empty array. For each present upgrade slot, a flag object as defined above is present.

Example

https://api.guildwars2.com/v2/items/28445

{
  "name": "Strong Soft Wood Longbow of Fire",
  "description": "",
  "type": "Weapon",
  "level": 44,
  "rarity": "Masterwork",
  "vendor_value": 120,
  "default_skin": "3942",
  "game_types": [ "Activity", "Dungeon", "Pve", "Wvw" ],
  "flags": [ "SoulBindOnUse" ],
  "restrictions": [],
  "id": 28445,
  "chat_link":"[&AgEdbwAA]",
  "icon": "https://render.guildwars2.com/file/C6110F52DF5AFE0F00A56F9E143E9732176DDDE9/65015.png",
  "details": {
    "type": "LongBow",
    "damage_type": "Physical",
    "min_power": 385,
    "max_power": 452,
    "defense": 0,
    "infusion_slots": [],
    "infix_upgrade": {
      "attributes": [
        { "attribute": "Power", "modifier": 62 },
        { "attribute": "Precision", "modifier": 44 }
      ]
    },
    "suffix_item_id": 24547,
    "secondary_suffix_item_id": ""
  }
}

https://api.guildwars2.com/v2/items/12452

 {
   "name": "Omnomberry Bar",
   "type": "Consumable",
   "level": 80,
   "rarity": "Fine",
   "vendor_value": 33,
   "game_types": [
       "Wvw",
       "Dungeon",
       "Pve"
   ],
   "flags": [
       "NoSell"
   ],
   "restrictions": [ ],
   "id": 12452,
   "chat_link": "[&AgGkMAAA]",
   "icon": "https://render.guildwars2.com/file/6BD5B65FBC6ED450219EC86DD570E59F4DA3791F/433643.png",
   "details": {
       "type": "Food",
       "duration_ms": 1800000,
       "apply_count": 1,
       "name": "Nourishment",
       "icon": "https://render.guildwars2.com/file/779D3F0ABE5B46C09CFC57374DA8CC3A495F291C/436367.png",
       "description": "30% Magic Find\n40% Gold from Monsters\n+10% Experience from Kills"
   }
 }