API:1/item_details

From Guild Wars 2 Wiki
Jump to: navigation, search

/v1/item_details.json

HTTP method
GET
Format
json
API version
version 1
Release date
 ?
Scope
none
Optional
none

This resource returns a details about a single item.

Parameters

Required parameters
  • item_id – The item to query for.
Optional parameters
  • lang – The language to display the texts in.
    • Possible values:
en (English, default)
de (German)
es (Spanish)
fr (French)

Response

The response is a JSON object with the following properties. Note that the availability of some properties depends on the type of the item.

Common properties

The following properties are common to all items:

  • item_id (integer) – The item id.
  • name (string) – The name of the item.
  • description (string) – The item description.
  • type (string) – The item type.
    • Possible values:
"Armor"
"Back"
"Bag"
"Consumable"
"Container"
"CraftingMaterial"
"Gathering"
"Gizmo"
"MiniPet"
"Tool"
"Trait"
"Trinket"
"Trophy"
"UpgradeComponent"
"Weapon"
  • level (integer) – The required level.
  • rarity (string) – The rarity.
    • Possible values:
"Ascended"
"Basic"
"Exotic"
"Fine"
"Junk"
"Legendary"
"Masterwork"
"Rare"
  • vendor_value (integer) – The value in coins when selling to a vendor.
  • icon_file_id (integer) – The icon file id to be used with the render service.
  • icon_file_signature (string) – The icon file signature to be used with the render service.
  • default_skin (integer) - Skin id, to get additional info about the skin use skin_details. This property is present only for type: Armor,Back and Weapon.
  • game_types (array of string) – The game types where the item is usable. At least 1.
    • Possible values:
"Activity"
"Dungeon"
"Pve"
"Pvp"
"PvpLobby"
"Wvw"
  • flags (array of string) – Any number of additional item flags.
    • Possible values:
"AccountBindOnUse"
"AccountBound"
"HideSuffix"
"MonsterOnly"
"NoMysticForge"
"NoSalvage"
"NoSell"
"NotUpgradeable"
"NoUnderwater"
"SoulbindOnAcquire"
"SoulBindOnUse"
"Unique"
  • restrictions (array of string) – Item usage restriction based on character race.
    • Possible values:
"Asura"
"Charr"
"Human"
"Norn"
"Sylvari"
"Guardian"
"Warrior"
"Mesmer"
    • Possible future values:
"Elementalist"
"Thief"
"Engineer"
"Necromancer"
"Ranger"

Specific properties

Each item type have a specific property named as the value in "type" property in lowercase (ex. item type "Armor" have the property "armor"). This property is an object with properties specific to each item type.

You can find example output for specific item type here

Armor

  • type (string): The armor piece type.
    • Possible values:
"Boots"
"Coat"
"Gloves"
"Helm"
"HelmAquatic"
"Leggings"
"Shoulders"
  • weight_class (string): The armor weight class
    • Possible values:
"Clothing"
"Heavy"
"Light"
"Medium"
  • defense (integer) The armor's defense rating
  • infusion_slots (array of flags) The number and type of infusion slots
    • flags (array of string): The types of infusions allowed in this slot.
      • Possible values:
"Defense"
"Offense"
"Utility"
  • infix_upgrade (object): describe the bonus gived by the item. This property is optional, is not always present.
    • buff (object): buff applied by the item. The buff seems only give bonus to Boon Duration. This property is used by only 36 items.
      • skill_id (integer): id of the skill applied by the item. Only known values are "16517" and "10521".
      • description (string): Description of the effect of the skill. Only known description is "+1% Boon Duration".
    • attributes (array of objects): list stat bonuses given by the item. Each object have the following property:
      • attribute (string): name of the attribute
      • modifier (integer): bonus given to the previous attribute


  • suffix_item_id (integer): The item id of an already applied upgrade component. Can be empty.
  • secondary_suffix_item_id (integer?): it is always present but is always empty.

Back

back property is an object with the following properties:

  • infusion_slots (array of object): the objects contained in this array describe infusion slots type. It have the following known properties:
    • item_id (integer): is the item_id applied in infusion slot. This property seems only be used by infused Back, the only known value is 49428 (+5 Agony_Infusion)
    • flags (array of string): infusion slot type. It is an array but seems to have between 0 and 1 values.
      • Known values:
"Offense"
"Defense"
  • infix_upgrade (object): describe the bonus gived by the item. This property is optional, is not always present.
    • buff (object): buff applied by the item. The buff seems only give bonus to character stats. It is optional, doesn't appear on all Backs.
      • skill_id (integer): id of the skill applied by the item.
      • description (string): Description of the effect of the skill.
    • attributes (array of objects): list stat bonuses given by the item. Each object have the following property:
      • attribute (string): name of the attribute
      • modifier (integer): bonus given to the previous attribute

buff and attributes bonuses are aggregated in in-game tooltip.

  • suffix_item_id (integer): item_id of the upgrade component applied to the item.
  • secondary_suffix_item_id (integer?): it is always present but is always empty.

Bag

bag property is an object with the following properties:

  • no_sell_or_sort (integer): this value could be 0 or 1
  • size (integer): this is the size of the bag (known values are: 4, 5, 8, 12, 10, 15, 18, 20)

Consumable

consumable property is an object with the following properties:

  • type (string): The consumable type
    • Possible values:
"AppearanceChange"
"Booze"
"ContractNpc"
"Food"
"Generic"
"Halloween"
"Immediate"
"Transmutation"
"Unlock"
"UnTransmutation"
"UpgradeRemoval"
"Utility"

Consumable types "Generic","Food" and "Utility" may have the following properties:

  • duration_ms (integer): effect duration in milliseconds
  • description (string): effect descriptions

Consumable types "Unlock" have the property:

  • unlock_type (string): type of unlock
    • Possible values:
"BagSlot"
"BankTab"
"CollectibleCapacity"
"Content"
"CraftingRecipe"
"Dye"
"Unknown"

Consumable types "Unlock" with "unlock_type"="CraftingRecipe" have the property:

  • recipe_id (integer): ID of the recipe that will be unlocked after using the consumable

Consumable types "Unlock" with "unlock_type"="Dye" have the property:

  • color_id (integer): ID of the color that will be unlocked after using the consumable

Container

container property is an object with the following properties:

  • type (string): The container type
    • Possible values:
"Default"
"GiftBox"
"OpenUI"

CraftingMaterial

Item type "CraftingMaterial" has no specific properties.

Gathering

gathering property is an object with the following properties:

  • type (string): The gathering type
    • Possible values:
"Foraging"
"Logging"
"Mining"

Gizmo

gizmo property is an object with the following properties:

  • type (string): The gizmo type
    • Possible values:
"Default"
"ContainerKey"
"RentableContractNpc"
"UnlimitedConsumable"

MiniPet

Item type "MiniPet " has no specific properties.

Tool

tool property is an object with the folowing properties:

  • type (string): tool type, the only known value is "Salvage"
  • charges (integer): number of charges of the tool.

Trinket

trinket property is an object with the following properties:

  • type (string): describe the type of Trinket.
    • Known Values:
"Amulet"
"Accessory"
"Ring"
  • infusion_slots (array of object): the objects contained in this array describe infusion slots type. It have the following known properties:
    • item_id (integer): is the item_id applied in infusion slot. This property seems only be used by infused Trinket, the only known value is 49428 (+5 Agony_Infusion)
    • flags (array of string): infusion slot type. It is an array but seems to have between 0 and 1 values.
      • Known values:
"Offense"
"Defense"
  • infix_upgrade (object): describe the bonus gived by the item. This property is optional, is not always present.
    • buff (object): buff applied by the item. The buff seems only give bonus to character stats. It is optional, doesn't appear on all Trinkets.
      • skill_id (integer): id of the skill applied by the item.
      • description (string): Description of the effect of the skill.
    • attributes (array of objects): list stat bonuses given by the item. Each object have the following property:
      • attribute (string): name of the attribute
      • modifier (integer): bonus given to the previous attribute

buff and attributes bonuses are aggregated in in-game tooltip.

  • suffix_item_id (integer): item_id of the upgrade component applied to the item.
  • secondary_suffix_item_id (integer?): it is always present but is always empty.

Trophy

Item type "Trophy" has no specific properties.

UpgradeComponent

upgrade_componentproperty is an object with the following properties:

  • type (string): The Upgrade Component type
    • Possible values:
"Default"
"Gem"
"Rune"
"Sigil"
Note that "Gem" type are Universal upgrades and gemstones; PvP Sigils and Runes are type "Default"; Are "Default" type also Jewels and Infusions.
  • flags (array of string): array of items on which the upgrade component can be applied.
    • Possible values:
"HeavyArmor"
"LightArmor"
"MediumArmor"
"Axe"
"Dagger"
"Focus"
"Greatsword"
"Hammer"
"Harpoon"
"LongBow"
"Mace"
"Pistol"
"Rifle"
"Scepter"
"Shield"
"ShortBow"
"Speargun"
"Staff"
"Sword"
"Torch"
"Trident"
"Warhorn"
"Trinket"
  • infusion_upgrade_flags (array of string): list infusion slot on which the upgrade component can be applied.
    • Possible values:
"Defense"
"Offense"
"Utility"
  • bonuses (array of string): list of rune bonuses only existing for items of type "Rune".
  • infix_upgrade (object): have properties that describe the functionality of the upgrade component. This object appear to be used only by sigils.
    • buff (object): have properties that describe the buff applied by the upgrade component.
      • skill_id (integer): id of skill applied by the upgrade component.
      • description (string): effect description of skill applied by the upgrade component.
    • attributes (array): no known value, appear to not be used.
  • suffix (string): suffix added to the item name when the current upgrade component is applied.

Weapon

  • type (string): The weapon type.
    • Possible values:
"Axe"
"Dagger"
"Focus"
"Greatsword"
"Hammer"
"Harpoon"
"LargeBundle"
"LongBow"
"Mace"
"Pistol"
"Rifle"
"Scepter"
"Shield"
"ShortBow"
"SmallBundle"
"Speargun"
"Staff"
"Sword"
"Torch"
"Toy"
"Trident"
"TwoHandedToy"
"Warhorn"
  • damage_type (string): The weapon's damage type
    • Possible values:
"Choking"
"Fire"
"Ice"
"Lightning"
"Physical"
  • min_power (integer) The weapon's minimum power rating
  • max_power (integer) The weapon's maximum power rating
  • defense (integer) The weapon's defense rating
  • infusion_slots (array of flags) The number and type of infusion slots
    • flags (array of string): The types of infusions allowed in this slot.
      • Possible values:
"Defense"
"Offense"
"Utility"
  • infix_upgrade (object): describe the bonus gived by the item. This property is optional, is not always present.
    • buff (object): buff applied by the item. This property is used by only 117 items.
      • skill_id (integer): id of the skill applied by the item.
      • description (string): Description of the effect of the skill.
    • attributes (array of objects): list stat bonuses given by the item. Each object have the following property:
      • attribute (string): name of the attribute
      • modifier (integer): bonus given to the previous attribute


  • suffix_item_id (integer): The item id of an already applied upgrade component. Can be empty.
  • secondary_suffix_item_id (integer?): it is always present but is always empty.

Example

The following is an example response for item 28445, you can find more examples here

https://api.guildwars2.com/v1/item_details.json?item_id=28445

{
  "item_id": "28445",
  "name": "Strong Bow of Fire",
  "description": "",
  "type": "Weapon",
  "level": "44",
  "rarity": "Masterwork",
  "vendor_value": "120",
  "icon_file_id": "65015",
  "icon_file_signature": "C6110F52DF5AFE0F00A56F9E143E9732176DDDE9",
  "game_types": [ "Activity", "Dungeon", "Pve", "Wvw" ],
  "flags": [ "SoulBindOnUse" ],
  "restrictions": [],
  "weapon": {
    "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"
  }
}