API:2/characters/:id/buildtabs

From Guild Wars 2 Wiki
Jump to navigationJump to search

/v2/characters/:id/buildtabs

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 the build template tabs of a character.

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 or all.

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.)
  • is_active (boolean) - Whether or not this is the tab selected on the character currently.
  • build (object) - Contains detailed information about the build.
    • name (string) - The name given to the build.
    • profession (string) - The characters profession. Resolvable against /v2/professions.
    • specializations (array of objects) - Three objects providing information about the characters selected specializations.
      • id (number) - The specialization id or null if none is selected. Resolvable against /v2/specializations.
      • traits (array of numbers) - Three trait ids or null in places where none is selected. Resolvable against /v2/traits.
    • skills (object) - Contains information about the characters selected skills. All values may be resolved against /v2/skills.
      • heal (number) - The id of the heal skill or null if none is selected.
      • utilities (array of numbers) - Three utility skill ids or null in places where none is selected.
      • elite (number) - The id of the elite skill or null if none is selected.
    • aquatic_skills (object) - Contains information about the characters selected underwater skills. The structure is the same as the one of skills above.
    • legends (array of strings) (optional) - Included for revenants only. Two legend ids or null in places where none is selected. Resolvable against /v2/legends.
    • aquatic_legends (array of strings) (optional) - Included for revenants only. The structure is the same as the one of legends above.
    • pets (object) (optional) - Included for rangers only. Containers information about the characters selected pets. Resolvable against /v2/pets.
      • terrestrial (array of integers) - Containers the two pet ids the ranger has equipped for terrestrial combat.
      • aquatic (array of integers) - Containers the two pet ids the ranger has equipped for aquaticcombat.

Example

Request

https://api.guildwars2.com/v2/characters/<character name>/buildtabs?tabs=all
Authorization: Bearer <access token>

Response

[
  {
    "tab": 1,
    "is_active": true,
    "build": {
      "name": "An Example Response Build",
      "profession": "Warrior",
      "specializations": [
        {
          "id": 4,
          "traits": [
            1447,
            1338,
            1440
          ]
        },
        {
          "id": 11,
          "traits": [
            1474,
            1482,
            null
          ]
        },
        {
          "id": null,
          "traits": [
            null,
            null,
            null
          ]
        }
      ],
      "skills": {
        "heal": 14389,
        "utilities": [
          14479,
          14410,
          null
        ],
        "elite": 14355
      },
      "aquatic_skills": {
        "heal": 14402,
        "utilities": [
          14413,
          null,
          14404
        ],
        "elite": 14419
      }
    }
  },
  ...
]

References