API:2/account/home/cats

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

/v2/account/home/cats

HTTP method
GET
Format
json
API version
version 2
Release date
2017-03-01
Scope
account
progression
unlocks
Optional
none

This resource returns information about unlocked home instance cats.

Parameters

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

Response

This request will return an array of integers. Each integer represents the id of a particular cat that can be resolved against /v2/home/cats.

Earliest Schema Version

Given a schema version earlier than 2019-03-22T00:00:00Z (or no schema version), this request will return an array of objects with the following properties:

  • id (number) – The id for the cat that can be resolved against /v2/cats.
  • hint (string, optional) – A hint to identify what is needed for each cat.

Example

Request - with the latest schema version

https://api.guildwars2.com/v2/account/home/cats
Authorization: Bearer <API key>
X-Schema-Version: 2019-03-22T00:00:00Z

Response

[
  2,
  24,
  1,
  20
]

Request - with the earliest schema version

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

Response

[
  {
    "id": 2,
    "hint": "grilled_chicken"
  },
  {
    "id": 24,
    "hint": "snow_leopard"
  },
  {
    "id": 1,
    "hint": "chicken"
  },
  {
    "id": 20,
    "hint": "necromancer"
  }
]