API:2/account/homestead/decorations

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

/v2/account/homestead/decorations

HTTP method
GET
Format
json
API version
version 2
Release date
2024-08-23
Scope
account
unlocks
Optional
none

This resource returns information about homestead decorations used by an account.

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

This request will return an array of objects. Each objects represents a particular decoration used in the homestead along with how many copies of it has been used. Each object contains the following:

  • id (number) - The ID of the decoration, it can be resolved against /v2/homestead/decorations.
  • count (number) - How many copies of the item has been used in the homestead.

Example

Request

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

Response

[
  {
    "id": 35,
    "count": 92
  },
  {
    "id": 70,
    "count": 6
  },
  {
    "id": 125,
    "count": 1
  },
  {
    "id": 131,
    "count": 4
  },
  {
    "id": 154,
    "count": 1
  },
  ...
]

Notes

  • This endpoint will return an empty array if the account has not yet unlocked a homestead.