API:2/guild/:id/stash

From Guild Wars 2 Wiki
< API:2‎ | guild‎ | :id
Jump to: navigation, search

/v2/guild/:id/stash

HTTP method
GET
Format
json
API version
version 2
Release date
2016-01-21
Scope
account
guilds
Optional
none

This resource returns information about the items in a guild's vault. The endpoint requires the scope guilds, and will only work if the API key is from the guild leader's account.

Response

The endpoint must be requested with :id replaced with a valid guild ID. The endpoint will return an array of objects, each describing the contents of a section of the guild's vault. Each object has the following properties:

  • upgrade_id (number) - ID of the guild upgrade that granted access to this section of the guild vault.
  • size (number) - The number of slots in this section of the guild vault.
  • coins (number) - The number of coins deposited in this section of the guild vault.
  • note (string) - The description set for this section of the guild's vault.
  • inventory (array) - An array of objects describing the items in the guild stash of exactly size length. Each object either contains the following properties if an item is present, or is null if the slot is empty:
    • id (number) - ID of the item in this slot.
    • count (number) - Amount of items in this slot.

Example

https://api.guildwars2.com/v2/guild/4BBB52AA-D768-4FC6-8EDE-C299F2822F0F/stash
 [
   {
     "upgrade_id" : 58,
     "size" : 100,
     "coins": 100039,
     "note" : "put extra siege/seaweed here please",
     "inventory" : [
       null,
       null,
       {
         "id" : 12138,
         "count" : 250
       },
       null,
       null,
       null,
       // ... 100 entries in total.
     ]
   },
   // ...
 ]