API:2/homestead/decorations
From Guild Wars 2 Wiki
Jump to navigationJump to search
/v2/homestead/decorations
- HTTP method
- GET
- Format
- json
- API version
- version 2
- Release date
- 2024-08-23
- Scope
- none
- Optional
- none
This resource returns information about all available homestead decorations.
Endpoints
- None - Request the list of all available homestead decorations
ids
when the root endpoint (v2/homestead/decorations
) has been accessed. id
- (Optional) Request the homestead decoration for the specifiedid
when accessing the endpoint (v2/homestead/decorations/id
). Cannot be used when specifying theids
parameter.
Parameters
lang
– (Optional) Request localized content.page
- (Optional; integer)page_size
- (Optional; integer)ids
- (Optional; Comma Delimited List) Request an array of homestead decorations for the specifiedids
. Cannot be used when accessing theid
endpoint.
Response
For each requested homestead decoration id
, an object with the following properties is returned:
id
(number) – The decoration id.name
(string) – The name of the decoration.description
(string) – The homestead decoration description.max_count
(number) - The maximum amount of storable instances of this decoration.icon
(string) – A URL pointing to an icon for the decoration.categories
(array) – An array of decoration category ids which this decoration belongs to. Can be compared to the /homestead/decorations/categories endpoint
Example
https://api.guildwars2.com/v2/homestead/decorations/140
{ "id": 140, "name": "Sandstone Pillar", "description": "Crafted by scribes.", "categories": [ 16, 1 ], "max_count": 250, "icon": "https://render.guildwars2.com/file/A2DBDD1E546A2F5EDAC301BA07FEA20F1B1C12A7/1223799.png" }