API:2/characters/:id/equipmenttabs
From Guild Wars 2 Wiki
< API:2 | characters
Jump to navigationJump to search
/v2/characters/:id/equipmenttabs
- HTTP method
- GET
- Format
- json
- API version
- version 2
- Release date
- 2019-12-18
- Scope
- account
builds
characters - Optional
- none
This resource returns information about an accounts equipment template tabs.
Endpoints
- None - Request a list of all available tabs.
:tab- (optional) Request information about the specified tab only.active- (optional) Request information about the currently selected tab only.
Parameters
access_token- (optional) If the API key is not specified in the request header, it can be specified here.tab- (optional) The tab of which to request the contents.tabs- (optional) A comma separated list of tabs of which to request the contents orall.
Response
For each requested tab, an object with the following properties is returned:
tab(number) - The "id" of this tab. (The position at which it resides.)name(string) - The name given to the equipment combination.is_active(boolean) - Whether or not this is the tab selected on the character currently.equipment(array of objects) - Contains an object for each equiped piece of equipment.id(number) - The item id of the equipment piece. Resolvable against /v2/items.slot(string) - In which slot the equipment piece is equiped. Possible values:HelmShouldersCoatGlovesLeggingsBootsWeaponA1WeaponA2WeaponB1WeaponB2BackpackAccessory1Accessory2AmuletRing1Ring2HelmAquaticWeaponAquaticAWeaponAquaticB
skin(number, optional) - The skin id of the skin transmuted onto the equipment piece. Resolvable against /v2/skins.upgrades(array of numbers, optional) - The item ids of the upgrade components sloted in the weapon. Resolvable against /v2/items.infusions(array of numbers, optional) - The item ids of the infusions sloted in the weapon. Resolvable against /v2/items.binding(string, optional) - The binding of the item. Possible values:AccountCharacter
bound_to(string, optional) - The name of the character to which the item is bound.location(string) - EitherEquippedorArmory.dyes(array of numbers, optional) - Four dye ids representing the dyes used in the dye slots of the equipment piece ornullif a dye slot is unavailable for a piece. Resolvable against /v2/colors.stats(object, optional) - Contains detailed information on the weapon stats.id(number) - The id of the wepons stats. Resolvable against /v2/itemstats.attributes(object) - Contains the weapon attributes in the form of key value pairs with the key being the attribute name and the value itself.
equipment_pvp(object) - Contains the following key-value pairs:amulet(number) - resolve id against v2/pvp/amulets.rune(number) - resolve id against v2/items.sigils(array of numbers) - resolve ids against v2/items. Will contain nulls for unequipped items.- Sigils are provided in the order
[<primary weapon sigil 1>, <secondary weapon sigil 1>, <primary weapon sigil 2>, <secondary weapon sigil 2>].
- Sigils are provided in the order
Example
Request
https://api.guildwars2.com/v2/characters/<character name>/equipmenttabs?tabs=all Authorization: Bearer <access token>
Response
[
{
"tab": 1,
"name": "Example Response Equipment",
"is_active": true,
"equipment": [
{
"id": 1062,
"slot": "Coat",
"location": "Equipped",
"dyes": [
74,
74,
74,
null
]
},
{
"id": 3187,
"slot": "Boots",
"skin": 74,
"location": "Equipped",
"dyes": [
74,
74,
74,
null
]
},
{
"id": 6461,
"slot": "Leggings",
"binding": "Character",
"bound_to": "<Character Name>",
"location": "Equipped",
"dyes": [
74,
74,
74,
null
]
},
{
"id": 2258,
"slot": "Shoulders",
"binding": "Character",
"bound_to": "<Character Name>",
"location": "Equipped",
"dyes": [
74,
74,
74,
null
]
},
{
"id": 39229,
"slot": "Accessory1",
"binding": "Account",
"location": "Equipped"
},
{
"id": 26252,
"slot": "WeaponA1",
"location": "Equipped"
},
{
"id": 32399,
"slot": "WeaponA2",
"location": "Equipped"
},
{
"id": 30704,
"slot": "WeaponB1",
"upgrades": [
24615,
24554
],
"infusions": [
49432,
49432
],
"binding": "Account",
"location": "Equipped",
"stats": {
"id": 161,
"attributes": {
"Power": 251,
"Precision": 179,
"CritDamage": 179
}
}
}
],
"equipment_pvp": {
"amulet": 13,
"rune": 21192,
"sigils": [
81254,
null,
21152,
null
]
}
},
...
]
Notes
- Unlike other endpoints this endpoint requires the two permissions
account,charactersand additionally at least one ofbuildsorinventorieswhereas the response does not appear to contain more or less information depending on which additional permission(s) were granted. - The armory was introduced alongside the equipment tabs as a location where equiped items are stored for an inactive tab (and their contribution to player stats ignored). The
locationattribute for equipment will returnEquippedif the current tab is active. However for inactive tabs the attribute will also beEquippedif the item is present on the active tab, otherwise the item is marked as being in theArmory.
