endpoints.md

API Endpoints

Endpoint Behaviour

Bulk Expanding

These endpoints support requesting resources by using their identifiers. You can use the following methods with bulk expanding endpoints:

• all() - Get all entries
• ids() - Get all ids
• get(:id) - Get a single entry by id
• many([:id, :id]) - Get multiple entries by ids

Paginated

These endpoints support requesting pages, which contain multiple resources. You can use the following methods with paginated endpoints:

• all() - Get all entries
• page(:page) - Get a page of entries (with the current maximum page size of 200)
• page(:page, :size) - Get a page of entries with a specific page size

Basic

If endpoints are neither bulk expanding nor paginated, you can usually access the resource using the get() method. There are some exceptions to this, which are documented in the "Available Endpoints" section below.

Authenticated

All of the endpoints which fetch account data require the use of an API key. This key can be generated on the official website. The data is always only for the account of the generated API key. You can authenticate the client using the following method:

client.authenticate('XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXXXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX')
client.authenticate('...').account().get()

Localized

Localized endpoints can return resources in multiple languages. You can set the desired response language via the following method:

client.language('de')
client.language('de').items().all()

Available Endpoints

• api().account() - Information about the player's account.
• api().account().achievements() - The account's progress towards their achievements.
• api().account().bank() - The items stored in the player's bank.
• api().account().characters() - Alternative method of calling api().characters().
• api().account().dailycrafting() - The completed daily crafting for the account.
• api().account().dungeons() - The completed dungeons of the current daily.
• api().account().dyes() - The unlocked dyes of the account.
• api().account().finishers() - The unlocked finishers of the account.
• api().account().gliders() - The unlocked gliders of the account.
• api().account().home().cats() - The unlocked cats in the home instance of the account.
• api().account().home().nodes() - The unlocked nodes in the home instance of the account.
• api().account().inventory() - The shared inventory slots of the account.
• api().account().legendaryarmory() - The items in the legendary armory of the account.
• api().account().luck() - The total luck of the account.
• api().account().mailcarriers() - The unlocked mailcarriers of the account.
• api().account().mapchests() - The completed daily mapchests of the account.
• api().account().masteries() - The unlocked masteries of the account.
• api().account().mastery().points() - The unlocked mastery points of the account.
• api().account().materials() - The materials stored in the account's material storage.
• api().account().minis() - The unlocked miniatures of the account.
• api().account().mounts().skins() - The unlocked mount skins of the account.
• api().account().mounts().types() - The unlocked mount types of the account.
• api().account().outfits() - The unlocked outfits of the account.
• api().account().novelties() - The unlocked novelties of the account.
• api().account().pvp() - Alternative method of calling api().pvp().
• api().account().pvp().heroes() - The unlocked pvp heroes of the account.
• api().account().raids() - The completed raids of the current weekly.
• api().account().recipes() - The unlocked recipes of the account. 
• api().account().skins() - The unlocked skins of the account. 
• api().account().titles() - The unlocked titles of the account. 
• api().account().transactions() - Alternative method of calling api().commerce().transactions().
• api().account().delivery() - Alternative method of calling api().commerce().delivery().
• api().account().wallet() - The currencies owned by the account. 
• api().account().worldbosses() - The daily worldbosses completed by the account. 
• api().achievements() - Information about achievements.
• api().achievements().categories() - The categories for achievements.
• api().achievements().groups() - The top-level groups for achievements.
• api().achievements().daily() - The current set of daily achievements.
• api().achievements().dailyTomorrow() - The next set of daily achievements.
• api().backstory().answers() - Information about biography answers.
• api().backstory().questions() - Information about biography questions.
• api().build() - The current game build id.
• api().cats() - (Deprecated) Information about home instance cats.
• api().characters() - Information about characters of the account.
• api().characters(:name).backstory() - Backstory information of a single character.
• api().characters(:name).core() - Core information (name, race, ...) of a single character.
• api().characters(:name).crafting() - Crafting disciplines of a single character.
• api().characters(:name).equipment() - Equipment of a single character.
• api().characters(:name).heropoints() - Heropoint information of a single character.
• api().characters(:name).inventory() - Inventory of a single character.
• api().characters(:name).quests() - Completed quests of a single character.
• api().characters(:name).recipes() - Unlocked recipes of a single character.
• api().characters(:name).sab() - Zone progress and unlocks in the SAB for this character.
• api().characters(:name).skills() - Skills in use by a single character.
• api().characters(:name).specializations() - Specialization information of a single character.
• api().characters(:name).training() - Mastery training information of a single character.
• api().colors() - Information about dye colors, including their color component information.
• api().commerce().delivery() - Current coins and items in the delivery box of the trading post.
• api().commerce().exchange() - Current exchange rates for coins to gems and gems to coins.
• api().commerce().listings() - Current buy and sell listings from the trading post.
• api().commerce().prices() - Current aggregated buy and sell listing information from the trading post.
• api().commerce().transactions().current().buys() - Current buy transactions of the player.
• api().commerce().transactions().current().sells() - Current sell transactions of the player.
• api().commerce().transactions().history().buys() - Historical buy transactions of the player.
• api().commerce().transactions().history().sells() - Historical sell transactions of the player.
• api().continents() - Information about continents.
• api().continents().floors(:id) - Information about a continents' floors.
• api().currencies() - Information about currencies.
• api().dailycrafting() - Information about daily craftable items.
• api().dungeons() - Information about dungeons, including their paths.
• api().emblem().backgrounds() - The guild emblem's background images.
• api().emblem().foregrounds() - The guild emblem's foreground images.
• api().events() - Information about events.
• api().files() - Commonly requested assets that may be used to enhance API-derived applications.
• api().finishers() - Information about finishers.
• api().gliders() - Information about gliders.
• api().guild() - Core details about a given guild.
• api().guild().permissions() - Information about all guild permissions.
• api().guild().search().name(:name) - Search for guild ids using a guild name.
• api().guild().upgrades() - Information about all guild hall upgrades, including scribe decorations.
• api().guild(:id).upgrades() - Information about the guild's upgrades.
• api().guild(:id).log() - Information about certain events in the guild's log.
• api().guild(:id).members() - Information about the members of the guild.
• api().guild(:id).ranks() - Information about the ranks of the guild.
• api().guild(:id).stash() - Information about the items in the guild's vault.
• api().guild(:id).storage() - Information about the stored guild upgrades.
• api().guild(:id).teams() - Information about the teams in the guild.
• api().guild().treasury() - Information about the items in the guild's treasury.
• api().home().cats() - Information about home instance cats.
• api().home().nodes() - Information about home instance nodes.
• api().items() - Information about items that were discovered by players.
• api().itemstats() - Information about stats for items.
• api().mailcarriers() - Information about mailcarriers.
• api().legendaryarmory() - Information about the items in the legendary armory.
• api().legends() - Information about the revenant's legends.
• api().mapchests() - Information about daily claimable map chests.
• api().maps() - Details about maps, including details about floor and translation data on how to translate between world coordinates and map
• api().masteries() - Information about the masteries.
• api().materials() - Information about the categories and items in the material storage.
• api().minis() - Information about miniatures.
• api().mounts().skins() - Information about mount skins.
• api().mounts().types() - Information about mount types.
• api().nodes() - (Deprecated) Information about home instance nodes.
• api().novelties() - Information about novelties.
• api().outfits() - Information about outfits.
• api().pets() - Information about the ranger's pets.
• api().professions() - Information about professions.
• api().pvp().amulets() - Information about PvP amulets.
• api().pvp().games() - Information about past PvP matches the player has participated in.
• api().pvp().heroes() - Information about PvP heroes.
• api().pvp().ranks() - Information about PvP ranks.
• api().pvp().seasons() - Information about league seasons.
• api().pvp().seasons(:id).leaderboards() - Information about available leaderboards for a league season.
• api().pvp().seasons(:id).leaderboards().board(:board, :region) - Leaderboards for a PvP league season in a specific region.
• api().pvp().standings() - Information about the player standings in the league seasons.
• api().pvp().stats() - Information about wins and losses of the account's PvP matches.
• api().quaggans() - Quaggan images.
• api().quests() - Information about quests.
• api().races() - Information about races and their available skills.
• api().raids() - Information about raids, including their bosses.
• api().recipes() - Information about discovered recipes.
• api().recipes().search() - Search for a recipe based on input or output items.
• api().skills() - Information about skills usable by players.
• api().skins() - Information about available skins.
• api().specializations() - Information about currently released specializations.
• api().stories() - Information about the "Story Journal" stories, including the personal story and living world.
• api().stories().seasons() - Information about the "Story Journal" seasons
• api().titles() - Information about titles.
• api().tokeninfo() - Information about the supplied API key.
• api().traits() - Information about specific traits, which are contained within specializations.
• api().worlds() - Information about the available worlds / servers.
• api().worldbosses() - Information about the available worldbosses.
• api().wvw().abilities() - Information about the abilities available in WvW.
• api().wvw().matches() - Details about WvW matches, including the total score, kills and deaths and further details for each map.
• api().wvw().matches().overview() - Overview about WvW matches, shows the participating worlds.
• api().wvw().matches().scores() - Scores of the WvW matches.
• api().wvw().matches().stats() - Stats of the WvW matches, includes kills, deaths, etc.
• api().wvw().matches().stats(:id).teams(:team).top(:which) - Top 10 Guilds per team by KDR/Kills
• api().wvw().objectives() - Details about WvW objectives such as camps, towers, and keeps.
• api().wvw().upgrades() - Information about WvW upgrades.
• api().wvw().ranks() - Information about WvW ranks.

Detailed Endpoints

api().account()

Information about the player's account.

• API-URL: /v2/account
• Paginated: No
• Bulk expanding: No
• Authenticated: Yes
• Localized: No
• Cache time: 5 minutes
• This endpoint additionally exposes the following methods:
  • blob() - All data available for the account in a single object

^{↑ Back to the overview}

---

api().account().achievements()

The account's progress towards their achievements.

• API-URL: /v2/account/achievements
• Paginated: Yes
• Bulk expanding: Partially
• Authenticated: Yes
• Localized: No
• Cache time: 5 minutes
• This endpoint behaves differently than usual bulk expanded endpoints:
  • ids() - Not supported
  • get() - All achievements of the account (same as all() and analogue to the other "basic" account endpoints)
  • All other paginated and bulk expanding methods (get(:id), page(:page), etc.) are behaving as described here

^{↑ Back to the overview}

---

api().account().bank()

The items stored in the player's bank.

• API-URL: /v2/account/bank
• Paginated: No
• Bulk expanding: No
• Authenticated: Yes
• Localized: No
• Cache time: 5 minutes

^{↑ Back to the overview}

---

api().account().characters()

Alternative method of calling api().characters().

^{↑ Back to the overview}

---

api().account().delivery()

Alternative method of calling api().commerce().delivery().

^{↑ Back to the overview}

---

api().account().dailycrafting()

The completed daily crafting of the account.

• API-URL: /v2/account/dailycrafting
• Paginated: No
• Bulk expanding: No
• Authenticated: Yes
• Localized: No
• Cache time: 5 minutes

^{↑ Back to the overview}

---

api().account().dungeons()

The completed dungeons of the current daily.

• API-URL: /v2/account/dungeons
• Paginated: No
• Bulk expanding: No
• Authenticated: Yes
• Localized: No
• Cache time: 5 minutes

^{↑ Back to the overview}

---

api().account().dyes()

The unlocked dyes of the account.

• API-URL: /v2/account/dyes
• Paginated: No
• Bulk expanding: No
• Authenticated: Yes
• Localized: No
• Cache time: 5 minutes

^{↑ Back to the overview}

---

api().account().finishers()

The unlocked finishers of the account.

• API-URL: /v2/account/finishers
• Paginated: No
• Bulk expanding: No
• Authenticated: Yes
• Localized: No
• Cache time: 5 minutes

^{↑ Back to the overview}

---

api().account().gliders()

The unlocked gliders of the account.

• API-URL: /v2/account/gliders
• Paginated: No
• Bulk expanding: No
• Authenticated: Yes
• Localized: No
• Cache time: 5 minutes

^{↑ Back to the overview}

---

api().account().home().cats()

The unlocked cats in the home instance of the account.

• API-URL: /v2/account/home/cats
• Paginated: No
• Bulk expanding: No
• Authenticated: Yes
• Localized: No
• Cache time: 5 minutes

^{↑ Back to the overview}

---

api().account().home().nodes()

The unlocked nodes in the home instance of the account.

• API-URL: /v2/account/home/nodes
• Paginated: No
• Bulk expanding: No
• Authenticated: Yes
• Localized: No
• Cache time: 5 minutes

^{↑ Back to the overview}

---

api().account().inventory()

The shared inventory slots of the account.

• API-URL: /v2/account/inventory
• Paginated: No
• Bulk expanding: No
• Authenticated: Yes
• Localized: No
• Cache time: 5 minutes

^{↑ Back to the overview}

---

api().account().legendaryarmory()

The items in the legendary armory of the account.

• API-URL: /v2/account/legendaryarmory
• Paginated: No
• Bulk expanding: No
• Authenticated: Yes
• Localized: No
• Cache time: 5 minutes

^{↑ Back to the overview}

---

api().account().luck()

The total luck of the account.

• API-URL: /v2/account/luck
• Paginated: No
• Bulk expanding: No
• Authenticated: Yes
• Localized: No
• Cache time: 5 minutes
• This endpoint behaves differently than the API:
  • This endpoint returns the luck value directly.

^{↑ Back to the overview}

---

api().account().mailcarriers()

The unlocked mailcarriers of the account.

• API-URL: /v2/account/mailcarriers
• Paginated: No
• Bulk expanding: No
• Authenticated: Yes
• Localized: No
• Cache time: 5 minutes

^{↑ Back to the overview}

---

api().account().mapchests()

The completed daily mapchests of the account.

• API-URL: /v2/account/mapchests
• Paginated: No
• Bulk expanding: No
• Authenticated: Yes
• Localized: No
• Cache time: 5 minutes

^{↑ Back to the overview}

---

api().account().masteries()

The unlocked masteries of the account.

• API-URL: /v2/account/masteries
• Paginated: No
• Bulk expanding: No
• Authenticated: Yes
• Localized: No
• Cache time: 5 minutes

^{↑ Back to the overview}

---

api().account().mastery().points()

The unlocked mastery points of the account.

• API-URL: /v2/account/mastery/points
• Paginated: No
• Bulk expanding: No
• Authenticated: Yes
• Localized: No
• Cache time: 5 minutes

^{↑ Back to the overview}

---

api().account().materials()

The materials stored in the account's material storage.

• API-URL: /v2/account/materials
• Paginated: No
• Bulk expanding: No
• Authenticated: Yes
• Localized: No
• Cache time: 5 minutes

^{↑ Back to the overview}

---

api().account().minis()

The unlocked miniatures of the account.

• API-URL: /v2/account/minis
• Paginated: No
• Bulk expanding: No
• Authenticated: Yes
• Localized: No
• Cache time: 5 minutes

^{↑ Back to the overview}

---

api().account().mounts().skins()

The unlocked mount skins of the account.

• API-URL: /v2/account/mounts/skins
• Paginated: No
• Bulk expanding: No
• Authenticated: Yes
• Localized: No
• Cache time: 5 minutes

^{↑ Back to the overview}

---

api().account().mounts().types()

The unlocked mount types of the account.

• API-URL: /v2/account/mounts/types
• Paginated: No
• Bulk expanding: No
• Authenticated: Yes
• Localized: No
• Cache time: 5 minutes

^{↑ Back to the overview}

---

api().account().outfits()

The unlocked outfits of the account.

• API-URL: /v2/account/outfits
• Paginated: No
• Bulk expanding: No
• Authenticated: Yes
• Localized: No
• Cache time: 5 minutes

^{↑ Back to the overview}

---

api().account().novelties()

The unlocked novelties of the account.

• API-URL: /v2/account/novelties
• Paginated: No
• Bulk expanding: No
• Authenticated: Yes
• Localized: No
• Cache time: 5 minutes

^{↑ Back to the overview}

---

api().account().pvp()

Alternative method of calling api().pvp().

^{↑ Back to the overview}

---

api().account().pvp().heroes()

The unlocked pvp heroes of this account.

• API-URL: /v2/account/pvp/heroes
• Paginated: No
• Bulk expanding: No
• Authenticated: Yes
• Localized: No
• Cache time: 5 minutes

^{↑ Back to the overview}

---

api().account().raids()

The completed raids of the current weekly.

• API-URL: /v2/account/raids
• Paginated: No
• Bulk expanding: No
• Authenticated: Yes
• Localized: No
• Cache time: 5 minutes

^{↑ Back to the overview}

---

api().account().recipes()

The unlocked recipes of the account. 

• API-URL: /v2/account/recipes
• Paginated: No
• Bulk expanding: No
• Authenticated: Yes
• Localized: No
• Cache time: 5 minutes

^{↑ Back to the overview}

---

api().account().skins()

The unlocked skins of the account. 

• API-URL: /v2/account/skins
• Paginated: No
• Bulk expanding: No
• Authenticated: Yes
• Localized: No
• Cache time: 5 minutes

^{↑ Back to the overview}

---

api().account().titles()

The unlocked titles of the account. 

• API-URL: /v2/account/titles
• Paginated: No
• Bulk expanding: No
• Authenticated: Yes
• Localized: No
• Cache time: 5 minutes

^{↑ Back to the overview}

---

api().account().transactions()

Alternative method of calling api().commerce().transactions().

^{↑ Back to the overview}

---

api().account().wallet()

The currencies owned by the account. 

• API-URL: /v2/account/wallet
• Paginated: No
• Bulk expanding: No
• Authenticated: Yes
• Localized: No
• Cache time: 5 minutes

^{↑ Back to the overview}

---

api().account().worldbosses()

The daily worldbosses completed by the account.

• API-URL: /v2/account/worldbosses
• Paginated: No
• Bulk expanding: No
• Authenticated: Yes
• Localized: No
• Cache time: 5 minutes

^{↑ Back to the overview}

---

api().achievements()

Information about achievements.

• API-URL: /v2/achievements
• Paginated: Yes
• Bulk expanding: Yes
• Authenticated: No
• Localized: Yes
• Cache time: 24 hours

^{↑ Back to the overview}

---

api().achievements().categories()

The categories for achievements.

• API-URL: /v2/achievements/categories
• Paginated: Yes
• Bulk expanding: Yes
• Authenticated: No
• Localized: Yes
• Cache time: 24 hours

^{↑ Back to the overview}

---

api().achievements().groups()

The top-level groups for achievements.

• API-URL: /v2/achievements/groups
• Paginated: Yes
• Bulk expanding: Yes
• Authenticated: No
• Localized: Yes
• Cache time: 24 hours

^{↑ Back to the overview}

---

api().achievements().daily()

The current set of daily achievements.

• API-URL: /v2/achievements/daily
• Paginated: No
• Bulk expanding: No
• Authenticated: No
• Localized: No
• Cache time: 60 minutes

^{↑ Back to the overview}

---

api().achievements().dailyTomorrow()

The next set of daily achievements.

• API-URL: /v2/achievements/daily/tomorrow
• Paginated: No
• Bulk expanding: No
• Authenticated: No
• Localized: No
• Cache time: 60 minutes

^{↑ Back to the overview}

---

api().backstory().answers()

Information about biography answers.

• API-URL: /v2/backstory/answers
• Paginated: Yes
• Bulk expanding: Yes
• Authenticated: No
• Localized: Yes
• Cache time: 24 hours

^{↑ Back to the overview}

---

api().backstory().questions()

Information about biography questions.

• API-URL: /v2/backstory/questions
• Paginated: Yes
• Bulk expanding: Yes
• Authenticated: No
• Localized: Yes
• Cache time: 24 hours

^{↑ Back to the overview}

---

api().build()

The current game build id.

• API-URL: /v2/build
• Paginated: No
• Bulk expanding: No
• Authenticated: No
• Localized: No
• Cache time: 1 minute

^{↑ Back to the overview}

---

api().cats()

Information about home instance cats.

• DEPRECATED
• API-URL: /v2/cats
• Paginated: Yes
• Bulk expanding: Yes
• Authenticated: No
• Localized: No
• Cache time: 24 hours

^{↑ Back to the overview}

---

api().characters()

Information about characters of the account.

• API-URL: /v2/characters
• Paginated: Yes
• Bulk expanding: Yes
• Authenticated: Yes
• Localized: No
• Cache time: 5 minutes

^{↑ Back to the overview}

---

api().characters(:name).backstory()

Backstory information of a single character.

• API-URL: /v2/characters/:name/backstory
• Paginated: No
• Bulk expanding: No
• Authenticated: Yes
• Localized: No
• Cache time: 5 minutes

^{↑ Back to the overview}

---

api().characters(:name).core()

Core information (name, race, ...) of a single character.

• API-URL: /v2/characters/:name/core
• Paginated: No
• Bulk expanding: No
• Authenticated: Yes
• Localized: No
• Cache time: 5 minutes

^{↑ Back to the overview}

---

api().characters(:name).crafting()

Crafting disciplines of a single character.

• API-URL: /v2/characters/:name/crafting
• Paginated: No
• Bulk expanding: No
• Authenticated: Yes
• Localized: No
• Cache time: 5 minutes

^{↑ Back to the overview}

---

api().characters(:name).equipment()

Equipment of a single character.

• API-URL: /v2/characters/:name/equipment
• Paginated: No
• Bulk expanding: No
• Authenticated: Yes
• Localized: No
• Cache time: 5 minutes

^{↑ Back to the overview}

---

api().characters(:name).heropoints()

Heropoint information of a single character.

• API-URL: /v2/characters/:name/heropoints
• Paginated: No
• Bulk expanding: No
• Authenticated: Yes
• Localized: No
• Cache time: 5 minutes

^{↑ Back to the overview}

---

api().characters(:name).inventory()

Inventory of a single character.

• API-URL: /v2/characters/:name/inventory
• Paginated: No
• Bulk expanding: No
• Authenticated: Yes
• Localized: No
• Cache time: 5 minutes

^{↑ Back to the overview}

---

api().characters(:name).quests()

Completed quests of a single character.

• API-URL: /v2/characters/:name/quests
• Paginated: No
• Bulk expanding: No
• Authenticated: Yes
• Localized: No
• Cache time: 5 minutes

^{↑ Back to the overview}

---

api().characters(:name).recipes()

Unlocked recipes of a single character.

• API-URL: /v2/characters/:name/recipes
• Paginated: No
• Bulk expanding: No
• Authenticated: Yes
• Localized: No
• Cache time: 5 minutes

^{↑ Back to the overview}

---

api().characters(:name).sab()

Zone progress and unlocks in the SAB for this character.

• API-URL: /v2/characters/:name/sab
• Paginated: No
• Bulk expanding: No
• Authenticated: Yes
• Localized: No
• Cache time: 5 minutes

^{↑ Back to the overview}

---

api().characters(:name).skills()

Skills in use by a single character.

• API-URL: /v2/characters/:name/skills
• Paginated: No
• Bulk expanding: No
• Authenticated: Yes
• Localized: No
• Cache time: 5 minutes

^{↑ Back to the overview}

---

api().characters(:name).specializations()

Specialization information of a single character.

• API-URL: /v2/characters/:name/specializations
• Paginated: No
• Bulk expanding: No
• Authenticated: Yes
• Localized: No
• Cache time: 5 minutes

^{↑ Back to the overview}

---

api().characters(:name).training()

Mastery training information of a single character.

• API-URL: /v2/characters/:name/training
• Paginated: No
• Bulk expanding: No
• Authenticated: Yes
• Localized: No
• Cache time: 5 minutes

^{↑ Back to the overview}

---

api().colors()

Information about dye colors, including their color component information.

• API-URL: /v2/colors
• Paginated: Yes
• Bulk expanding: Yes
• Authenticated: No
• Localized: Yes
• Cache time: 24 hours

^{↑ Back to the overview}

---

api().commerce().delivery()

Current coins and items in the delivery box of the trading post.

• API-URL: /v2/commerce/delivery
• Paginated: No
• Bulk expanding: No
• Authenticated: Yes
• Localized: No
• Cache time: 5 minutes

^{↑ Back to the overview}

---

api().commerce().exchange()

Current exchange rates for coins to gems and gems to coins.

• API-URL: /v2/commerce/exchange
• Paginated: No
• Bulk expanding: No
• Authenticated: No
• Localized: No
• Cache time: 10 minutes
• This endpoint exposes the following methods:
  • gems(:quantity) - The current exchange rate of gems to coins
  • coins(:quantity) - The current exchange rate of coins to gems

^{↑ Back to the overview}

---

api().commerce().listings()

Current buy and sell listings from the trading post.

• API-URL: /v2/commerce/listings
• Paginated: Yes
• Bulk expanding: Yes
• Authenticated: No
• Localized: No
• Cache time: 2 minutes

^{↑ Back to the overview}

---

api().commerce().prices()

Current aggregated buy and sell listing information from the trading post.

• API-URL: /v2/commerce/prices
• Paginated: Yes
• Bulk expanding: Yes
• Authenticated: No
• Localized: No
• Cache time: 1 minute

^{↑ Back to the overview}

---

api().commerce().transactions().current().buys()

Current buy transactions of the player.

• API-URL: /v2/commerce/transactions/current/buys
• Paginated: Yes
• Bulk expanding: No
• Authenticated: Yes
• Localized: No
• Cache time: 10 minutes

^{↑ Back to the overview}

---

api().commerce().transactions().current().sells()

Current sell transactions of the player.

• API-URL: /v2/commerce/transactions/current/sells
• Paginated: Yes
• Bulk expanding: No
• Authenticated: Yes
• Localized: No
• Cache time: 10 minutes

^{↑ Back to the overview}

---

api().commerce().transactions().history().buys()

Historical buy transactions of the player.

• API-URL: /v2/commerce/transactions/history/buys
• Paginated: Yes
• Bulk expanding: No
• Authenticated: Yes
• Localized: No
• Cache time: 10 minutes

^{↑ Back to the overview}

---

api().commerce().transactions().history().sells()

Historical sell transactions of the player.

• API-URL: /v2/commerce/transactions/history/sells
• Paginated: Yes
• Bulk expanding: No
• Authenticated: Yes
• Localized: No
• Cache time: 10 minutes

^{↑ Back to the overview}

---

api().continents()

Information about continents.

• API-URL: /v2/continents
• Paginated: Yes
• Bulk expanding: Yes
• Authenticated: No
• Localized: Yes
• Cache time: 24 hours

^{↑ Back to the overview}

---

api().continents().floors(:id)

Information about a continents' floors.

• API-URL: /v2/continents/:id/floors
• Paginated: Yes
• Bulk expanding: Yes
• Authenticated: No
• Localized: No
• Cache time: 24 hours

^{↑ Back to the overview}

---

api().currencies()

Information about currencies.

• API-URL: /v2/currencies
• Paginated: Yes
• Bulk expanding: Yes
• Authenticated: No
• Localized: Yes
• Cache time: 24 hours

^{↑ Back to the overview}

---

api().dailycrafting()

Information about daily craftable items.

• API-URL: /v2/dailycrafting
• Paginated: Yes
• Bulk expanding: Yes
• Authenticated: No
• Localized: No
• Cache time: 24 hours

^{↑ Back to the overview}

---

api().dungeons()

Information about dungeons, including their paths.

• API-URL: /v2/dungeons
• Paginated: Yes
• Bulk expanding: Yes
• Authenticated: No
• Localized: No
• Cache time: 24 hours

^{↑ Back to the overview}

---

api().emblem().backgrounds()

The guild emblem's background images.

• API-URL: /v2/emblem/backgrounds
• Paginated: Yes
• Bulk expanding: Yes
• Authenticated: No
• Localized: No
• Cache time: 24 hours

^{↑ Back to the overview}

---

api().emblem().foregrounds()

The guild emblem's foreground images.

• API-URL: /v2/emblem/foregrounds
• Paginated: Yes
• Bulk expanding: Yes
• Authenticated: No
• Localized: No
• Cache time: 24 hours

^{↑ Back to the overview}

---

api().events()

Information about events.

• API-URL: /v1/event_details.json
• Paginated: No
• Bulk expanding: No
• Authenticated: No
• Localized: No
• Cache time: 24 hours

^{↑ Back to the overview}

---

api().files()

Commonly requested assets that may be used to enhance API-derived applications.

• API-URL: /v2/files
• Paginated: Yes
• Bulk expanding: Yes
• Authenticated: No
• Localized: No
• Cache time: 24 hours

^{↑ Back to the overview}

---

api().finishers()

Information about finishers.

• API-URL: /v2/finishers
• Paginated: Yes
• Bulk expanding: Yes
• Authenticated: No
• Localized: Yes
• Cache time: 24 hours

^{↑ Back to the overview}

---

api().gliders()

Information about gliders.

• API-URL: /v2/gliders
• Paginated: Yes
• Bulk expanding: Yes
• Authenticated: No
• Localized: Yes
• Cache time: 24 hours

^{↑ Back to the overview}

---

api().guild()

Core details about a given guild.

• API-URL: /v2/guild
• Paginated: No
• Bulk expanding: No
• Authenticated: Optional
• Localized: No
• Cache time: 60 minutes

^{↑ Back to the overview}

---

api().guild().permissions()

Information about all guild permissions.

• API-URL: /v2/guild/permissions
• Paginated: Yes
• Bulk expanding: Yes
• Authenticated: No
• Localized: Yes
• Cache time: 24 hours

^{↑ Back to the overview}

---

api().guild().search().name(:name)

Search for guild ids using a guild name.

• API-URL: /v2/guild/search?name=:name
• Paginated: No
• Bulk expanding: No
• Authenticated: No
• Localized: No
• Cache time: 60 minutes

^{↑ Back to the overview}

---

api().guild().upgrades()

Information about all guild hall upgrades, including scribe decorations.

• API-URL: /v2/guild/upgrades
• Paginated: Yes
• Bulk expanding: Yes
• Authenticated: No
• Localized: Yes
• Cache time: 24 hours

^{↑ Back to the overview}

---

api().guild(:id).upgrades()

Information about the guild's upgrades.

• API-URL: /v2/guild/:id/upgrades
• Paginated: No
• Bulk expanding: No
• Authenticated: Yes
• Localized: No
• Cache time: 5 minutes

^{↑ Back to the overview}

---

api().guild(:id).log()

Information about certain events in the guild's log.

• API-URL: /v2/guild/:id/log
• Paginated: No
• Bulk expanding: No
• Authenticated: Yes
• Localized: No
• Cache time: 5 minutes
• This endpoint additionally exposes the following methods:
  • since(:logId) - Only get entries that are newer than the given log id

^{↑ Back to the overview}

---

api().guild(:id).members()

Information about the members of the guild.

• API-URL: /v2/guild/:id/members
• Paginated: No
• Bulk expanding: No
• Authenticated: Yes
• Localized: No
• Cache time: 5 minutes

^{↑ Back to the overview}

---

api().guild(:id).ranks()

Information about the ranks of the guild.

• API-URL: /v2/guild/:id/ranks
• Paginated: No
• Bulk expanding: No
• Authenticated: Yes
• Localized: No
• Cache time: 5 minutes

^{↑ Back to the overview}

---

api().guild(:id).stash()

Information about the items in the guild's vault.

• API-URL: /v2/guild/:id/stash
• Paginated: No
• Bulk expanding: No
• Authenticated: Yes
• Localized: No
• Cache time: 5 minutes

^{↑ Back to the overview}

---

api().guild(:id).storage()

Information about the stored guild upgrades.

• API-URL: /v2/guild/:id/storage
• Paginated: No
• Bulk expanding: No
• Authenticated: Yes
• Localized: No
• Cache time: 5 minutes

^{↑ Back to the overview}

---

api().guild(:id).teams()

Information about the teams in the guild.

• API-URL: /v2/guild/:id/teams
• Paginated: No
• Bulk expanding: No
• Authenticated: Yes
• Localized: No
• Cache time: 5 minutes

^{↑ Back to the overview}

---

api().guild().treasury()

Information about the items in the guild's treasury.

• API-URL: /v2/guild/:id/treasury
• Paginated: No
• Bulk expanding: No
• Authenticated: Yes
• Localized: No
• Cache time: 5 minutes

^{↑ Back to the overview}

---

api().home().cats()

Information about home instance cats.

• API-URL: /v2/home/cats
• Paginated: Yes
• Bulk expanding: Yes
• Authenticated: No
• Localized: No
• Cache time: 24 hours

^{↑ Back to the overview}

---

api().home().nodes()

Information about home instance nodes.

• API-URL: /v2/home/nodes
• Paginated: Yes
• Bulk expanding: Yes
• Authenticated: No
• Localized: No
• Cache time: 24 hours

^{↑ Back to the overview}

---

api().items()

Information about items that were discovered by players.

• API-URL: /v2/items
• Paginated: Yes
• Bulk expanding: Yes
• Authenticated: No
• Localized: Yes
• Cache time: 24 hours

^{↑ Back to the overview}

---

api().itemstats()

Information about stats for items.

• API-URL: /v2/itemstats
• Paginated: Yes
• Bulk expanding: Yes
• Authenticated: No
• Localized: Yes
• Cache time: 24 hours

^{↑ Back to the overview}

---

api().legendaryarmory()

Information about the items in the legendary armory.

• API-URL: /v2/legendaryarmory
• Paginated: Yes
• Bulk expanding: Yes
• Authenticated: No
• Localized: No
• Cache time: 24 hours

^{↑ Back to the overview}

---

api().legends()

Information about the revenant's legends.

• API-URL: /v2/legends
• Paginated: Yes
• Bulk expanding: Yes
• Authenticated: No
• Localized: No
• Cache time: 24 hours

^{↑ Back to the overview}

---

api().mailcarriers()

Information about mailcarriers.

• API-URL: /v2/mailcarriers
• Paginated: Yes
• Bulk expanding: Yes
• Authenticated: No
• Localized: Yes
• Cache time: 24 hours

^{↑ Back to the overview}

---

api().mapchests()

Information about daily claimable map chests.

• API-URL: /v2/mapchests
• Paginated: Yes
• Bulk expanding: Yes
• Authenticated: No
• Localized: No
• Cache time: 24 hours

^{↑ Back to the overview}

---

api().maps()

Details about maps, including details about floor and translation data on how to translate between world coordinates and map coordinates.

• API-URL: /v2/maps
• Paginated: Yes
• Bulk expanding: Yes
• Authenticated: No
• Localized: Yes
• Cache time: 24 hours

^{↑ Back to the overview}

---

api().masteries()

Information about the masteries.

• API-URL: /v2/masteries
• Paginated: Yes
• Bulk expanding: Yes
• Authenticated: No
• Localized: Yes
• Cache time: 24 hours

^{↑ Back to the overview}

---

api().materials()

Information about the categories and items in the material storage.

• API-URL: /v2/materials
• Paginated: Yes
• Bulk expanding: Yes
• Authenticated: No
• Localized: Yes
• Cache time: 24 hours

^{↑ Back to the overview}

---

api().minis()

Information about miniatures.

• API-URL: /v2/minis
• Paginated: Yes
• Bulk expanding: Yes
• Authenticated: No
• Localized: Yes
• Cache time: 24 hours

^{↑ Back to the overview}

---

api().mounts().skins()

Information about mount skins.

• API-URL: /v2/mounts/skins
• Paginated: Yes
• Bulk expanding: Yes
• Authenticated: No
• Localized: Yes
• Cache time: 24 hours

^{↑ Back to the overview}

---

api().mounts().types()

Information about mount types.

• API-URL: /v2/mounts/types
• Paginated: Yes
• Bulk expanding: Yes
• Authenticated: No
• Localized: Yes
• Cache time: 24 hours

^{↑ Back to the overview}

---

api().nodes()

Information about home instance nodes.

• DEPRECATED
• API-URL: /v2/nodes
• Paginated: Yes
• Bulk expanding: Yes
• Authenticated: No
• Localized: No
• Cache time: 24 hours

^{↑ Back to the overview}

---

api().novelties()

Information about novelties.

• API-URL: /v2/novelties
• Paginated: Yes
• Bulk expanding: Yes
• Authenticated: No
• Localized: No
• Cache time: 24 hours

^{↑ Back to the overview}

---

api().outfits()

Information about outfits.

• API-URL: /v2/outfits
• Paginated: Yes
• Bulk expanding: Yes
• Authenticated: No
• Localized: Yes
• Cache time: 24 hours

^{↑ Back to the overview}

---

api().pets()

Information about the ranger's pets.

• API-URL: /v2/pets
• Paginated: Yes
• Bulk expanding: Yes
• Authenticated: No
• Localized: Yes
• Cache time: 24 hours

^{↑ Back to the overview}

---

api().professions()

Information about professions.

• API-URL: /v2/professions
• Paginated: Yes
• Bulk expanding: Yes
• Authenticated: No
• Localized: Yes
• Cache time: 24 hours

^{↑ Back to the overview}

---

api().pvp().amulets()

Information about PvP amulets.

• API-URL: /v2/pvp/amulets
• Paginated: Yes
• Bulk expanding: Yes
• Authenticated: No
• Localized: Yes
• Cache time: 24 hours

^{↑ Back to the overview}

---

api().pvp().games()

Information about past PvP matches the player has participated in.

• API-URL: /v2/pvp/games
• Paginated: Yes
• Bulk expanding: Yes
• Authenticated: Yes
• Localized: No
• Cache time: 5 minutes

^{↑ Back to the overview}

---

api().pvp().heroes()

Information about PvP heroes.

• API-URL: /v2/pvp/heroes
• Paginated: Yes
• Bulk expanding: Yes
• Authenticated: No
• Localized: Yes
• Cache time: 24 hours

^{↑ Back to the overview}

---

api().pvp().ranks()

Information about PvP ranks.

• API-URL: /v2/pvp/ranks
• Paginated: Yes
• Bulk expanding: Yes
• Authenticated: No
• Localized: Yes
• Cache time: 24 hours

^{↑ Back to the overview}

---

api().pvp().seasons()

Information about league seasons.

• API-URL: /v2/pvp/seasons
• Paginated: Yes
• Bulk expanding: Yes
• Authenticated: No
• Localized: Yes
• Cache time: 24 hours

^{↑ Back to the overview}

---

api().pvp().seasons(:id).leaderboards()

Information about available leaderboards for a league season.

• API-URL: /v2/pvp/seasons/:id/leaderboards
• Paginated: No
• Bulk expanding: No
• Authenticated: No
• Localized: No
• Cache time: 24 hours
• This endpoint exposes the following methods:
  • ids() - Available leaderboards for a league season.

^{↑ Back to the overview}

---

api().pvp().seasons(:id).leaderboards().board(:board, :region)

Leaderboards for a PvP league season in a specific region.

• API-URL: /v2/pvp/seasons/:id/leaderboards/:board/:region
• Paginated: Yes
• Bulk expanding: No
• Authenticated: No
• Localized: No
• Cache time: 5 minutes

^{↑ Back to the overview}

---

api().pvp().standings()

Information about the player standings in the league seasons.

• API-URL: /v2/pvp/standings
• Paginated: No
• Bulk expanding: No
• Authenticated: Yes
• Localized: No
• Cache time: 5 minutes

^{↑ Back to the overview}

---

api().pvp().stats()

Information about wins and losses of the account's PvP matches.

• API-URL: /v2/pvp/stats
• Paginated: No
• Bulk expanding: No
• Authenticated: Yes
• Localized: No
• Cache time: 5 minutes

^{↑ Back to the overview}

---

api().quaggans()

Quaggan images.

• API-URL: /v2/quaggans
• Paginated: Yes
• Bulk expanding: Yes
• Authenticated: No
• Localized: No
• Cache time: 24 hours

^{↑ Back to the overview}

---

api().quests()

Information about quests.

• API-URL: /v2/quests
• Paginated: Yes
• Bulk expanding: Yes
• Authenticated: No
• Localized: No
• Cache time: 24 hours

^{↑ Back to the overview}

---

api().races()

Information about races and their available skills.

• API-URL: /v2/races
• Paginated: Yes
• Bulk expanding: Yes
• Authenticated: No
• Localized: Yes
• Cache time: 24 hours

^{↑ Back to the overview}

---

api().raids()

Information about raids, including their bosses.

• API-URL: /v2/raids
• Paginated: Yes
• Bulk expanding: Yes
• Authenticated: No
• Localized: No
• Cache time: 24 hours

^{↑ Back to the overview}

---

api().recipes()

Information about discovered recipes.

• API-URL: /v2/recipes
• Paginated: Yes
• Bulk expanding: Yes
• Authenticated: No
• Localized: No
• Cache time: 24 hours

^{↑ Back to the overview}

---

api().recipes().search()

Search for a recipe based on input or output items.

• API-URL: /v2/recipes/search
• Paginated: No
• Bulk expanding: No
• Authenticated: No
• Localized: No
• Cache time: 24 hours
• This endpoint exposes the following methods:
  • input(:id) - Search for recipes with this item as an ingredient
  • output(:id) - Search for recipes that craft this item

^{↑ Back to the overview}

---

api().skills()

Information about skills usable by players.

• API-URL: /v2/skills
• Paginated: Yes
• Bulk expanding: Yes
• Authenticated: No
• Localized: Yes
• Cache time: 24 hours

^{↑ Back to the overview}

---

api().skins()

Information about available skins.

• API-URL: /v2/skins
• Paginated: Yes
• Bulk expanding: Yes
• Authenticated: No
• Localized: Yes
• Cache time: 24 hours

^{↑ Back to the overview}

---

api().specializations()

Information about currently released specializations.

• API-URL: /v2/specializations
• Paginated: Yes
• Bulk expanding: Yes
• Authenticated: No
• Localized: Yes
• Cache time: 24 hours

^{↑ Back to the overview}

---

api().stories()

Information about the "Story Journal" stories, including the personal story and living world.

• API-URL: /v2/stories
• Paginated: Yes
• Bulk expanding: Yes
• Authenticated: No
• Localized: Yes
• Cache time: 24 hours

^{↑ Back to the overview}

---

api().stories().seasons()

Information about the "Story Journal" seasons

• API-URL: /v2/stories/seasons
• Paginated: Yes
• Bulk expanding: Yes
• Authenticated: No
• Localized: Yes
• Cache time: 24 hours

^{↑ Back to the overview}

---

api().titles()

Information about titles.

• API-URL: /v2/titles
• Paginated: Yes
• Bulk expanding: Yes
• Authenticated: No
• Localized: Yes
• Cache time: 24 hours

^{↑ Back to the overview}

---

api().tokeninfo()

Information about the supplied API key.

• API-URL: /v2/tokeninfo
• Paginated: No
• Bulk expanding: No
• Authenticated: Yes
• Localized: No
• Cache time: 1 minute

^{↑ Back to the overview}

---

api().traits()

Information about specific traits, which are contained within specializations.

• API-URL: /v2/traits
• Paginated: Yes
• Bulk expanding: Yes
• Authenticated: No
• Localized: Yes
• Cache time: 24 hours

^{↑ Back to the overview}

---

api().worlds()

Information about the available worlds / servers.

• API-URL: /v2/worlds
• Paginated: Yes
• Bulk expanding: Yes
• Authenticated: No
• Localized: Yes
• Cache time: 24 hours

^{↑ Back to the overview}

---

api().worldbosses()

Information about the available worldbosses

• API-URL: /v2/worldbosses
• Paginated: Yes
• Bulk expanding: Yes
• Authenticated: No
• Localized: Yes
• Cache time: 24 hours

^{↑ Back to the overview}

---

api().wvw().abilities()

Information about the abilities available in WvW.

• API-URL: /v2/wvw/abilities
• Paginated: Yes
• Bulk expanding: Yes
• Authenticated: No
• Localized: Yes
• Cache time: 24 hours

^{↑ Back to the overview}

---

api().wvw().matches()

Details about WvW matches, including the total score, kills and deaths and further details for each map.

• API-URL: /v2/wvw/matches
• Paginated: Yes
• Bulk expanding: Yes
• Authenticated: No
• Localized: No
• Cache time: 30 seconds
• This endpoint additionally exposes the following methods:
  • world(:worldId) - Only get details to WvW matches where the given world is participating in

^{↑ Back to the overview}

---

api().wvw().matches().overview()

Overview about WvW matches, shows the participating worlds.

• API-URL: /v2/wvw/matches/overview
• Paginated: Yes
• Bulk expanding: Yes
• Authenticated: No
• Localized: No
• Cache time: 30 seconds
• This endpoint additionally exposes the following methods:
  • world(:worldId) - Only get details to WvW matches where the given world is participating in

^{↑ Back to the overview}

---

api().wvw().matches().scores()

Scores of the WvW matches.

• API-URL: /v2/wvw/matches/scores
• Paginated: Yes
• Bulk expanding: Yes
• Authenticated: No
• Localized: No
• Cache time: 30 seconds
• This endpoint additionally exposes the following methods:
  • world(:worldId) - Only get details to WvW matches where the given world is participating in

^{↑ Back to the overview}

---

api().wvw().matches().stats()

Stats of the WvW matches, includes kills, deaths, etc.

• API-URL: /v2/wvw/matches/stats
• Paginated: Yes
• Bulk expanding: Yes
• Authenticated: No
• Localized: No
• Cache time: 30 seconds
• This endpoint additionally exposes the following methods:
  • world(:worldId) - Only get details to WvW matches where the given world is participating in

^{↑ Back to the overview}

---

api().wvw().matches().stats(:id).teams(:team).top(:which)

Top 10 Guilds for a given team in a given match ID by KDR/Kills

• API-URL: /v2/wvw/matches/stats/:id/teams/:team/top/:which
• Paginated: No
• Bulk expanding: No
• Authenticated: No
• Localized: No
• Cache time: 30 seconds

^{↑ Back to the overview}

---

api().wvw().objectives()

Details about WvW objectives such as camps, towers, and keeps.

• API-URL: /v2/wvw/objectives
• Paginated: Yes
• Bulk expanding: Yes
• Authenticated: No
• Localized: Yes
• Cache time: 24 hours

^{↑ Back to the overview}

---

api().wvw().upgrades()

Information about WvW upgrades.

• API-URL: /v2/wvw/upgrades
• Paginated: Yes
• Bulk expanding: Yes
• Authenticated: No
• Localized: Yes
• Cache time: 24 hours

^{↑ Back to the overview}

---

api().wvw().ranks()

Information about WvW ranks.

• API-URL: /v2/wvw/ranks
• Paginated: Yes
• Bulk expanding: Yes
• Authenticated: No
• Localized: Yes
• Cache time: 24 hours

^{↑ Back to the overview}