API:API key

From Guild Wars 2 Wiki
Jump to: navigation, search

An API key is a code players can generate in their account settings that can allow third-party apps to access certain account data via use of the API.

Usage

Creating an API key.

API keys are created at https://account.arena.net/applications. During the creation of the key, the player will need to give it a name and a set of permissions. The name is purely for the player's reference, though any third-party app the key is given to will be able to view the name.

The permissions of the API key designate what data a third party app would be able to access, if given this key. Permissions are not able to be changed after the key is created.

account 
This permission is mandatory for all keys. It allows access to your account name and ID, home world, joined guilds, and date of account creation.
builds 
Allows access to your currently equipped specializations, traits, skills, and equipment for all game modes.
characters 
Allows access to information on your characters, including name, level, race, gender, class, age, creation date, and death count.
guilds 
Allows access to guild-related information such as rosters, history, and MOTDs for all guilds you are a member of.
inventories 
Allows access to your account vault, Material Storage, and character inventories and equipment.
progression 
Allows access to your achievements, dungeon unlocks, masteries, hungry cat scavenger hunt, and PvE progress.
pvp 
Allows access to your PvP stats, match history, reward track progression, and custom arena details.
tradingpost 
Allows access to your Trading Post transactions. This includes your current (pending) transactions, and up to 90 days of your past transactions.
unlocks 
Allows access to a list of skins and dyes you have unlocked.
wallet 
Allows access to view your account wallet.

Deleting an API key takes effect immediately, and the API key will no longer work for any third party apps.

Authenticated endpoints

Authenticated endpoints can accept the API key in two ways.

  • In a POST request, use the Authorization header field: Authorization: Bearer [api key]. Note: preflight requests are not supported by the API backend.
  • In a GET request, use the access_token query parameter: ?access_token=[api key]. This method circumvents the preflight requests of the CORS standard.

Full list of authenticated endpoints

API endpointRequired authorization
API:2/accountaccount
API:2/account/achievementsprogression
account
API:2/account/bankinventories
account
API:2/account/dailycraftingprogression
account
API:2/account/dungeonsprogression
account
API:2/account/dyesunlocks
account
API:2/account/finishersunlocks
account
API:2/account/glidersunlocks
account
API:2/account/home/catsprogression
unlocks
account
API:2/account/home/nodesprogression
account
unlocks
API:2/account/inventoryinventories
account
API:2/account/luckunlocks
account
progression
API:2/account/mailcarriersunlocks
account
API:2/account/mapchestsprogression
account
API:2/account/masteriesprogression
account
API:2/account/mastery/pointsprogression
account
API:2/account/materialsinventories
account
API:2/account/minisunlocks
account
API:2/account/mounts/skinsunlocks
account
API:2/account/mounts/typesunlocks
account
API:2/account/noveltiesunlocks
account
API:2/account/outfitsunlocks
account
API:2/account/pvp/heroesunlocks
account
API:2/account/raidsprogression
account
API:2/account/recipesunlocks
account
API:2/account/skinsunlocks
account
API:2/account/titlesunlocks
account
API:2/account/walletwallet
account
API:2/account/worldbossesprogression
account
API:2/charactersaccount
characters
API:2/characters/:id/backstoryaccount
characters
API:2/characters/:id/coreaccount
characters
API:2/characters/:id/craftingaccount
characters
API:2/characters/:id/equipmentaccount
characters
builds
inventories
API:2/characters/:id/heropointsaccount
characters
progression
API:2/characters/:id/inventoryaccount
characters
inventories
API:2/characters/:id/questsaccount
characters
progression
API:2/characters/:id/recipesaccount
unlocks
API:2/characters/:id/sabaccount
characters
API:2/characters/:id/skillsaccount
characters
builds
API:2/characters/:id/specializationsaccount
characters
builds
API:2/characters/:id/trainingaccount
characters
builds
API:2/commerceaccount
API:2/commerce/deliveryaccount
tradingpost
API:2/commerce/transactionsaccount
tradingpost
API:2/createsubtokenaccount
API:2/guild/:id/logguilds
account
API:2/guild/:id/membersguilds
account
API:2/guild/:id/ranksguilds
account
API:2/guild/:id/stashguilds
account
API:2/guild/:id/storageguilds
account
API:2/guild/:id/teamsguilds
account
API:2/guild/:id/treasuryguilds
account
API:2/guild/:id/upgradesguilds
account
API:2/pvp/gamespvp
account
API:2/pvp/standingsaccount
pvp
API:2/pvp/statspvp
account
API:2/tokeninfoaccount