API:2/characters/:id/equipment
From Guild Wars 2 Wiki
< API:2 | characters
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.v(optional) - Can be used to specify the schema version.
Response
Prior to schema version 2019-12-19T00:00:00.000Z, items equipped from the Legendary Armory will be missing from this response.
equipment(array) - An array containing an entry for each piece of equipment currently on the selected character.id(integer) - The itemid, resolvable against /v2/itemsslot(string) - The equipment slot in which the item is slotted. This value is optional on schema2019-12-19T00:00:00.000Zor later, will be missing if equipment is in an inactive tab. Possible values:HelmAquaticBackpackCoatBootsGlovesHelmLeggingsShouldersAccessory1Accessory2Ring1Ring2AmuletWeaponAquaticAWeaponAquaticBWeaponA1WeaponA2WeaponB1WeaponB2SickleAxePick
infusions(array) (optional) - returns an array of infusion itemidswhich can be resolved against/v2/itemsupgrades(array) (optional) - returns an array of upgrade component itemidswhich can be resolved against/v2/itemsskin(integer) (optional) - Skin id for the given equipment piece. Can be resolved against/v2/skinsstats(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/itemstatsattributes(object) - Contains a summary of the stats on the item.Power(integer) (optional) - Shows the amount of power givenPrecision(integer) (optional) - Shows the amount of Precision givenToughness(integer) (optional) - Shows the amount of Toughness givenVitality(integer) (optional) - Shows the amount of Vitality givenCondition Damage(integer) (optional) - Shows the amount of Condition Damage givenCondition Duration(integer) (optional) - Shows the amount of Condition Duration givenHealing(integer) (optional) - Shows the amount of Healing Power givenBoonDuration(integer) (optional) - Shows the amount of Boon Duration given
binding(string) (optional) - describes which kind of binding the item has. Possible values:CharacterAccount
location(string) - describes where this item is stored. Available on schema2019-12-19T00:00:00.000Zor later. Possible values:Equipped- equipped in the active tab.Armory- equipped in an inactive tabs.EquippedFromLegendaryArmory- if the item is stored in the account-wide legendary armory, but equipped in the active tab.LegendaryArmory- if the item is stored in the account-wide legendary armory, but equipped in an inactive tabs.
tabs(array of numbers) - identifies which tabs this particular item is reused in. Available on schema2019-12-19T00:00:00.000Zor later.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 tonullif no dye is selected. Colors can be resolved againstv2/colors
Example
Request
https://api.guildwars2.com/v2/characters/<character name>/equipment Authorization: Bearer <API key> X-Schema-Version: 2021-07-15T13:00:00.000Z https://api.guildwars2.com/v2/characters/<character name>/equipment?access_token=<API key>&v=2021-07-15T13:00:00.000Z
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"
}
]
}
