API:2/account/bank

From Guild Wars 2 Wiki
< API:2‎ | account
Jump to navigationJump to search

/v2/account/bank

HTTP method
GET
Format
json
API version
version 2
Release date
2015-06-26
Scope
account
inventories
Optional
none

This resource returns the items stored in a player's vault (not including material storage). This endpoint is only accessible with a valid API key.

Parameters

  • access_token (optional) – Can be used to specify an API key for the request if it is not given in the request header.

Response

The endpoint returns an array of objects, each representing an item slot in the vault. If a slot is empty, it will return null. The amount of slots/bank tabs is implied by the length of the array.

Each object contains the following:

  • id (number) – The item's ID.
  • count (number) – The amount of items in the item stack.
  • charges (number, optional) – The amount of charges remaining on the item.
  • skin (number, optional) – The skin applied to the item, if it is different from its original. Can be resolved against /v2/skins.
  • dyes (array of numbers, optional) – The IDs of the dyes applied to the item. Can be resolved against /v2/colors.
  • upgrades (array of numbers, optional) – The item IDs of the runes or sigills applied to the item.
  • upgrade_slot_indices (array of numbers, optional) – The slot occupied by the upgrade at the corresponding position in upgrades.
  • infusions (array, optional) – An array of item IDs for each infusion applied to the item.
  • binding (string, optional) – The current binding of the item. Either Account or Character if present.
  • bound_to (string, optional) – If binding is Character, this field tells which character it is bound to.
  • stats (object, optional) – The stats of the item.

Example

Request

https://api.guildwars2.com/v2/account/bank
Authorization: Bearer <API key>

Response

[
  {
    "id": 19675,
    "count": 80
  },
  null,
  null,
  {
    "id": 46760,
    "count": 1,
    "upgrades": [
      24580
    ],
    "infusions": [
      37129
    ]
  },
  null,
  {
    "id": 14451,
    "count": 1,
    "skin": 5330
  },
  {
    "id": 74,
    "count": 1,
    "skin": 1409,
    "dyes": [
        2,
        443,
        2,
        1
    ],
    "binding": "Account"
  }
]