API:2/characters/:id/equipment

From Guild Wars 2 Wiki
Jump to navigationJump to search

/v2/characters/:id/equipment

HTTP method
GET
Format
json
API version
version 2
Release date
2015-05-22
Scope
account
builds
characters
inventories
Optional
none

This resource returns information about the equipment on a character attached to a specific account.

Parameters

  • access_token - (optional) If the API key is not specified in the request header, it can be specified here.

Response

  • equipment (array) - An array containing an entry for each piece of equipment currently on the selected character.
    • id (integer) - The item id, resolvable against /v2/items
    • slot (string) - The equipment slot in which the item is slotted. Possible values:
      • HelmAquatic
      • Backpack
      • Coat
      • Boots
      • Gloves
      • Helm
      • Leggings
      • Shoulders
      • Accessory1
      • Accessory2
      • Ring1
      • Ring2
      • Amulet
      • WeaponAquaticA
      • WeaponAquaticB
      • WeaponA1
      • WeaponA2
      • WeaponB1
      • WeaponB2
      • Sickle
      • Axe
      • Pick
    • infusions (array) (optional) - returns an array of infusion item ids which can be resolved against /v2/items
    • upgrades (array) (optional) - returns an array of upgrade component item ids which can be resolved against /v2/items
    • skin (integer) (optional) - Skin id for the given equipment piece. Can be resolved against /v2/skins
    • stats (object) (optional) - Contains information on the stats chosen if the item offers an option for stats/prefix.
      • id (integer) - The itemstat id, can be resolved against /v2/itemstats
      • attributes (object) - Contains a summary of the stats on the item.
        • Power (integer) (optional) - Shows the amount of power given
        • Precision (integer) (optional) - Shows the amount of Precision given
        • Toughness (integer) (optional) - Shows the amount of Toughness given
        • Vitality (integer) (optional) - Shows the amount of Vitality given
        • Condition Damage (integer) (optional) - Shows the amount of Condition Damage given
        • Condition Duration (integer) (optional) - Shows the amount of Condition Duration given
        • Healing (integer) (optional) - Shows the amount of Healing Power given
        • BoonDuration (integer) (optional) - Shows the amount of Boon Duration given
    • binding (string) (optional) - describes which kind of binding the item has. Possible values:
      • Character
      • Account
    • location (string) - describes where this item is stored. Possible values:
      • Equipped - equipped in the active tab
      • Armory - equipped in inactive tabs
      • EquippedFromLegendaryArmory - if the item is stored in the account-wide legendary armory.
    • tabs (array of numbers) - identifies which tabs this particular item is reused in.
    • charges (number) (optional) - The amount of charges remaining on the item.
    • bound_to (string) (optional, only if character bound) - Name of the character the item is bound to.
    • dyes (array of numbers) - Array of selected dyes for the equipment piece. Values default to null if no dye is selected. Colors can be resolved against v2/colors

Example

Request

  https://api.guildwars2.com/v2/characters/<character name>/equipment
  Authorization: Bearer <API key>

  https://api.guildwars2.com/v2/characters/<character name>/equipment?access_token=<API key>

Response

{
  "equipment": [
    {
      "id": 81462,
      "slot": "Backpack",
      "infusions": [
        43254,
        43254
      ],
      "stats": {
        "id": 1130,
        "attributes": {
          "Power": 52,
          "Precision": 27,
          "ConditionDamage": 52,
          "ConditionDuration": 27
        }
      },
      "binding": "Account",
      "location": "EquippedFromLegendaryArmory",
      "tabs": [
        3
      ],
      "dyes": [
        null,
        null,
        null,
        null
      ]
    },
    {
      "id": 71436,
      "slot": "Coat",
      "upgrades": [
        24762
      ],
      "skin": 704,
      "binding": "Account",
      "location": "Equipped",
      "tabs": [
        3
      ],
      "dyes": [
        1277,
        70,
        1246,
        null
      ]
    },
    {
      "id": 85215,
      "slot": "Boots",
      "upgrades": [
        24762
      ],
      "skin": 5733,
      "stats": {
        "id": 1224,
        "attributes": {
          "Power": 38,
          "Precision": 21,
          "ConditionDamage": 38,
          "ConditionDuration": 21
        }
      },
      "binding": "Character",
      "bound_to": "<character name>",
      "location": "Equipped",
      "tabs": [
        3
      ],
      "dyes": [
        1277,
        70,
        1277,
        null
      ]
    },
    {...},
    {
      "id": 22997,
      "slot": "Sickle",
      "binding": "Account",
      "location": "Equipped"
    },
    {
      "id": 23000,
      "slot": "Axe",
      "binding": "Account",
      "location": "Equipped"
    },
    {
      "id": 23001,
      "slot": "Pick",
      "binding": "Account",
      "location": "Equipped"
    }
  ]
}