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
API:2/account/bankinventories
API:2/account/dungeonsprogression
API:2/account/dyesunlocks
API:2/account/finishersunlocks
API:2/account/glidersunlocks
API:2/account/homeprogression
API:2/account/home/catsprogression
API:2/account/home/nodesprogression
API:2/account/inventoryinventories
API:2/account/mailcarriersunlocks
API:2/account/masteriesprogression
API:2/account/mastery/pointsprogression
API:2/account/materialsinventories
API:2/account/minisunlocks
API:2/account/mountsunlocks
API:2/account/mounts/skinsunlocks
API:2/account/mounts/typesunlocks
API:2/account/outfitsunlocks
API:2/account/pvp/heroesunlocks
API:2/account/raidsprogression
API:2/account/recipesunlocks
API:2/account/skinsunlocks
API:2/account/titlesunlocks
API:2/account/walletwallet
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
API:2/characters/:id/heropointsaccount
characters
API:2/characters/:id/inventoryaccount
characters
API:2/characters/:id/skillsaccount
characters
API:2/characters/:id/specializationsaccount
characters
API:2/characters/:id/trainingaccount
characters
API:2/commerceaccount
tradingpost
API:2/commerce/deliveryaccount
tradingpost
API:2/guild/:idguilds
API:2/guild/:id/logguilds
API:2/guild/:id/membersguilds
API:2/guild/:id/ranksguilds
API:2/guild/:id/stashguilds
API:2/guild/:id/storageguilds
API:2/guild/:id/teamsguilds
API:2/guild/:id/treasuryguilds
API:2/guild/:id/upgradesguilds
API:2/pvp/gamespvp
API:2/pvp/standingsaccount
pvp
API:2/pvp/statspvp
API:2/tokeninfoaccount