API:2/characters/:id/equipment

From Guild Wars 2 Wiki
Jump to: navigation, 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
    • 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": 47874,
           "slot": "HelmAquatic",
           "upgrades": [
               24836
           ],
           "binding": "Character",
           "bound_to": "<Character name>"
       },
       {
           "id": 72309,
           "slot": "Backpack",
           "infusions": [
               77310,
               49433
           ],
           "skin": 6561,
           "stats": {
               "id": 584,
               "attributes": {
                   "Power": 63,
                   "Precision": 40,
                   "CritDamage": 40
               }
           },
           "binding": "Account"
       },
       {
           "id": 48079,
           "slot": "Coat",
           "upgrades": [
               24836
           ],
           "infusions": [
               49432
           ],
           "skin": 5719,
           "binding": "Account"
       },
       {...},
       {
           "id": 22997,
           "slot": "Sickle",
           "binding": "Account",
           "charges": 31
       },
       {
           "id": 23000,
           "slot": "Axe",
           "binding": "Account",
           "charges": 7
       },
       {
           "id": 48933,
           "slot": "Pick",
           "binding": "Account"
       }
   ]
 }