API:2/characters/:id/sab

From Guild Wars 2 Wiki
Jump to navigationJump to search

/v2/characters/:id/sab

HTTP method
GET
Format
json
API version
version 2
Release date
2017-04-07
Scope
account
characters
Optional
none

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.

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. Valid values include:
chain_stick, slingshot, whip, mini_bomb, candle, torch, wooden_whistle, digger, nice_scoop, glove_of_wisdom, bauble_purse, bauble_tote_bag, moto_breath, moto_finger, health_vessel_1, health_vessel_2, medium_health_potion
There is an unlock of ID 10 that does not include a name attribute. It is believed this ID refers to the "Mega Bomb" unlock.

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. Valid values include:
secret_song, gatekeeper_lullaby, 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"
    }
  ]
}