API:2/characters/:id/sab

This resource returns information about Super Adventure Box on a character attached to a specific account.

Parameters

access_token - (optional) If the API key is not specified in the request header, it can be specified here.

Response

The endpoint returns an object with zones, unlocks, and songs attributes, describing what that character has done/unlocked within Super Adventure Box.

Each object under zones has the following attributes:

id (number) - An internal ID that uniquely identifies a zone by world, zone, and mode.
mode (string) - The mode used when completing this zone. One of: infantile, normal, tribulation.
world (number) - The world this zone is in.
zone (number) - The zone's number.

id	mode	world	zone
1	normal	1	1
2	normal	1	2
3	normal	1	3
4	normal	2	1
5	normal	2	2
6	normal	2	3
13	infantile	1	1
14	infantile	1	2
15	infantile	1	3
16	infantile	2	1
17	infantile	2	2
18	infantile	2	3
25	tribulation	1	1
26	tribulation	1	2
27	tribulation	1	3
28	tribulation	2	1
29	tribulation	2	2
30	tribulation	2	3

Each object under unlocks has the following attributes:

id (number) - An internal ID that uniquely identifies an unlock.
name (string, optional) - An unlocalized string describing the unlock. See the table below for valid values.

id	name
1	chain_stick
3	slingshot
4	bow Name is blank in the API. Correct name provided for reference only.
6	whip
9	mini_bomb
10	mega_bomb Name is blank in the API. Correct name provided for reference only.
12	candle
13	torch
15	wooden_whistle
18	digger
19	nice_scoop
21	glove_of_wisdom
24	bauble_purse
25	bauble_tote_bag
26	bauble_backpack Name is blank in the API. Correct name provided for reference only.
27	moto_breath
28	moto_finger
31	health_vessel_1
32	health_vessel_2
34	medium_health_potion

Each object under songs has the following attributes:

id (number) - An internal ID that uniquely identifies a song.
name (string) - An unlocalized string describing the song. See the table below for valid values.

id	name
1	secret_song
2	gatekeeper_lullaby
3	shatter_serenade

Example

Request

https://api.guildwars2.com/v2/characters/My%20Character/sab
Authorization: Bearer <API key>

Response

{
  "zones": [
    {
      "id": 1,
      "mode": "normal",
      "world": 1,
      "zone": 1
    },
    {
      "id": 30,
      "mode": "tribulation",
      "world": 2,
      "zone": 3
    }
  ],
  "unlocks": [
    {
      "id": 3,
      "name": "slingshot"
    },
    {
      "id": 6,
      "name": "whip"
    }
  ],
  "songs": [
    {
      "id": 1,
      "name": "secret_song"
    }
  ]
}

Notes

API bug:

Unlock IDs 4 (bow), 10 (mega_bomb) and 26 (bauble_backpack) currently do not include a name attribute. (ref)

Boomerang can be swapped for the whip at the Vending Machine, and therefore this item is suspected to intentionally not be listed in the API as an upgrade.

API