The GuildWars 2 API is accessed by making requests to https://api.guildwars2.com with the following URI format:
https://api.guildwars2.com/<version>/<endpoint>
This site is kind of both, a documentation and a sandbox. To play around click the 'Use this endpoint' button at the top right of a card. The site will make a request to the API and the 'Request' table becomes interactive where possible.
If you want to use the authenticated APIs you need to enter an API key in the box above. The key will only be saved in your Browser. Data of this site is available on GitHub.
Made with ❤ by Keeky.4102
account v2Requires API Key
This resource returns information about player accounts. This endpoint is only accessible with a valid API key.
https://api.guildwars2.com/v2/account/
| Method | Name | Value | Type | Required | Description |
|---|---|---|---|---|---|
| Auth | string | Yes | Default authentication. Pass the API key either via Header Authorization: Bearer <API key> or GET access_token |
| Name | Type | Description |
|---|---|---|
| id | string | The unique persistent account GUID. |
| name | string | The unique account name with numerical suffix. It is possible that the name change. Do not rely on the name, use id instead. |
| world | int | The id of the home world the account is assigned to. Can be fetched by requesting /v2/worlds. |
| guilds | array | A list of guilds assigned to the given account. |
| created | string | Timestamp of the moment the character was created. |
account/bank v2Requires API Key
This resource returns the contents of the account’s bank. This endpoint is only accessible with a valid API key.
https://api.guildwars2.com/v2/account/bank/
| Method | Name | Value | Type | Required | Description |
|---|---|---|---|---|---|
| Auth | string | Yes | Default authentication. Pass the API key either via Header Authorization: Bearer <API key> or GET access_token |
||
| get | ids | string | No | Optional parameter to get details about specific IDs. Seperate with a comma. | |
| get | page | int | No | Pagination. |
| Name | Type | Description |
|---|---|---|
| id | int | ID of the stored item |
| count | int | Amout of the stored item. |
account/materials v2Requires API Key
This resource returns the contents of the account’s material storage. This endpoint is only accessible with a valid API key.
https://api.guildwars2.com/v2/account/materials/
| Method | Name | Value | Type | Required | Description |
|---|---|---|---|---|---|
| Auth | string | Yes | Default authentication. Pass the API key either via Header Authorization: Bearer <API key> or GET access_token |
| Name | Type | Description |
|---|---|---|
| id | int | ID of the stored item |
| category | int | Category id of the stored item (See materials) |
| count | int | Amout of the stored item. |
characters v2Requires API Key
This resource returns information about characters attached to a specific account. This endpoint is only accessible with a valid API key.
If the endpoint is accessed without any parameters /v2/characters, it will return an array of characters by name.
Characters can be requested specifically via the ids parameter, or by specifying them in the next URI component. (e.g. /v2/characters/MyCharacter)
To retrieve all the characters on an account, pagination can be used. (/v2/characters?page=0)
To just get a characters equipment or inventory you can also use /v2/equipment/:id/inventory and /v2/characters/:id/inventory.
https://api.guildwars2.com/v2/characters/
| Method | Name | Value | Type | Required | Description |
|---|---|---|---|---|---|
| Auth | string | Yes | Default authentication. Pass the API key either via Header Authorization: Bearer <API key> or GET access_token |
||
| get | ids | string | No | Optional parameter to get details about specific IDs. Seperate with a comma. | |
| get | page | int | No | Pagination. |
| Name | Type | Description |
|---|---|---|
| name | string | The character's name. Name changes are a thing. |
| race | string | The character's race. Either Asura, Charr, Human, Norn or Sylvari. |
| gender | string | The character's gender. Either Male or Female. |
| profession | string | The character's profession. Either Elementalist, Engineer, Guardian, Mesmer, Necromancer, Ranger, Thief orWarrior. |
| level | int | The character's level. |
| guild | string | The guild ID of the character's currently represented guild. Only shown if the character actually represents a guild. |
| age | int | Playtime in seconds. |
| created | string | Timestamp of the moment the character was created. |
| deaths | int | The number of times this character died. |
| equipment | array | Array of items currently equipped. |
| bags | array | Big multidimensional array of all bags and their contents. |
commerce/transactions v2Requires API Key
This resource provides access to the current and historical transactions of a player. This endpoint is only accessible with a valid API key. Results are cached for five minutes.
https://api.guildwars2.com/v2/commerce/transactions/
| Method | Name | Value | Type | Required | Description |
|---|---|---|---|---|---|
| Auth | string | Yes | Default authentication. Pass the API key either via Header Authorization: Bearer <API key> or GET access_token |
| Name | Type | Description |
|---|---|---|
| id | int | Id of the transaction. |
| item_id | int | The item id. |
| price | int | The price in coins. |
| quantity | int | The quantity of the item. |
| created | string | The date of creation, using ISO-8601 standard. |
| purchased | string | The date of purchase, using ISO-8601 standard. Not shown in current second-level endpoint. |
tokeninfo v2Requires API Key
This resource returns information about the supplied API key. This endpoint is only accessible with a valid API key.
https://api.guildwars2.com/v2/tokeninfo/
| Method | Name | Value | Type | Required | Description |
|---|---|---|---|---|---|
| Auth | string | Yes | Default authentication. Pass the API key either via Header Authorization: Bearer <API key> or GET access_token |
| Name | Type | Description |
|---|---|---|
| id | int | The API key that was requested. |
| name | string | The name that was given to the API key when it was created. |
| array | Array of strings describing which permissions the API key has. Currently the array can contain any of account, characters, inventories and tradingpost |
guild_details v1
This resource returns a details about a guild. Note: Only one request parameter is required; if both are set, the guild id takes precedence.
https://api.guildwars2.com/v1/guild_details/
| Method | Name | Value | Type | Required | Description |
|---|---|---|---|---|---|
| get | guild_id | string | Yes | The guild id to query for. | |
| get | guild_name | string | Yes | The guild name to query for. |
| Name | Type | Description |
|---|---|---|
| guild_id | string | The guild id. |
| guild_name | string | The guild name. |
| tag | string | The guild tag. |
| emblem | object | If present, it holds detailed information about the guilds emblem. |
wvw/matches v1
This resource returns a list of the currently running WvW matches, with the participating worlds included in the result. Further details about a match can be requested using the match_details resource.
https://api.guildwars2.com/v1/wvw/matches/
| Method | Name | Value | Type | Required | Description |
|---|---|---|---|---|---|
| None | |||||
| Name | Type | Description |
|---|---|---|
| wvw_match_id | string | The WvW match id. |
| red_world_id | int | The world id of the red world. |
| blue_world_id | int | The world id of the blue world. |
| green_world_id | int | The world id of the green world. |
| start_time | string | A timestamp of when the match started. |
| end_time | string | A timestamp of when the match ends. |
wvw/match_details v1
This resource returns further details about the specified match, including the total score and further details for each map.
https://api.guildwars2.com/v1/wvw/match_details/
| Method | Name | Value | Type | Required | Description |
|---|---|---|---|---|---|
| get | match_id | string | Yes | The WvW match to query for. |
| Name | Type | Description |
|---|---|---|
| match_id | string | The guild id. |
| scores | array | A list of the three total scores (order: red, blue, green). |
| maps | array | A list of objects containing detailed information about each of the four maps. |
wvw/objective_names v1
This resource returns an unordered list of the localized WvW objective names for the specified language.
https://api.guildwars2.com/v1/wvw/objective_names/
| Method | Name | Value | Type | Required | Description |
|---|---|---|---|---|---|
| get | lang | string | No | The WvW match to query for. |
| Name | Type | Description |
|---|---|---|
| id | string | The objective id. |
| name | array | The name of the objective in the specified language. Note that this is not the name displayed in the game, but rather the abstract type. |
items v2
This resource returns information about items that were discovered by players in the game. Note that the response varies depending on the type of item you're requesting.
https://api.guildwars2.com/v2/items/
| Method | Name | Value | Type | Required | Description |
|---|---|---|---|---|---|
| get | lang | string | No | Request localized information. | |
| get | ids | string | No | Optional parameter to get details about specific IDs. Seperate with a comma. | |
| get | page | int | No | Pagination. |
| Name | Type | Description |
|---|---|---|
| id | int | The item id. |
| name | string | The item name. |
| icon | string | The full icon URL. |
| description | string | The item description. |
| type | string | The item type. |
| rarity | string | The item rarity. |
| level | int | The required level. |
| vendor_value | int | The value in coins when selling to a vendor. (Can be non-zero even when the item has the NoSell flag.) |
| default_skin | int | The default skin id. |
| flags | array | Flags applying to the item. |
| game_types | array | The game types in which the item is usable. At least one game type is specified. |
| restrictions | array | Restrictions applied to the item. |
| details | object | Additional item details if applicable, depending on the item type. |
materials v2
Unauthenticated endpoint which provides localized names and contents for each of the material storage tabs.
https://api.guildwars2.com/v2/materials/
| Method | Name | Value | Type | Required | Description |
|---|---|---|---|---|---|
| get | lang | string | No | Request localized information. | |
| get | ids | string | No | Optional parameter to get details about specific IDs. Seperate with a comma. |
| Name | Type | Description |
|---|---|---|
| id | int | ID of the material category. |
| name | string | Name of the material category. |
| items | array | Array of all item ids of this material category. |
recipes v2
This resource returns information about recipes that were discovered by players in the game. Note that the response varies depending on the type of item you're requesting.
https://api.guildwars2.com/v2/recipes/
| Method | Name | Value | Type | Required | Description |
|---|---|---|---|---|---|
| get | lang | string | No | Request localized information. | |
| get | ids | string | No | Optional parameter to get details about specific IDs. Seperate with a comma. | |
| get | page | int | No | Pagination. |
| Name | Type | Description |
|---|---|---|
| id | int | The recipe id. |
| type | string | The recipe type. |
| output_item_id | int | The item id of the produced item. |
| output_item_count | int | The amount of items produced. |
| time_to_craft_ms | int | The time in milliseconds it takes to craft the item. |
| disciplines | array | The crafting disciplines that can use the recipe. |
| int | The required rating to craft the recipe. | |
| flags | array | Flags applying to the recipe. |
| ingredients | array | List of recipe ingredients. |
recipes/search v2
This resource allows searching for recipe. To get additional information about the returned recipes, use the recipes endpoint. Input and output request parameters can't be used together.
https://api.guildwars2.com/v2/recipes/search/
| Method | Name | Value | Type | Required | Description |
|---|---|---|---|---|---|
| get | input | int | No | The item id when searching for recipes with an item as an ingredient. | |
| get | output | int | No | The item id when searching for the recipes that craft an item. |
| Name | Type | Description |
|---|---|---|
| None | array | An array of item ids. |
skins v2
This resource returns information about skins that were discovered by players in the game.
https://api.guildwars2.com/v2/skins/
| Method | Name | Value | Type | Required | Description |
|---|---|---|---|---|---|
| get | ids | string | No | Optional parameter to get details about specific IDs. Seperate with a comma. | |
| get | lang | string | No | Request localized information. | |
| get | page | int | No | Pagination. |
| Name | Type | Description |
|---|---|---|
| id | int | An array of item ids. |
| name | string | The name of the skin. |
| type | string | The skin type. Either Armor, Weapon or Back |
| flags | array | Additional skin flags. |
| restrictions | array | Race restrictions that apply to the skin, e.g. Human will be a listed restriction, if the skin can only be applies to human characters. |
| icon | string | The full icon URL. |
| description | string | Optional skin description. |
| details | object | Additional skin details if applicable, depending on the skin type. |
continents v2
This resource returns static information about the continents, floors, regions, maps, sectors, points of interest and tasks.
https://api.guildwars2.com/v2/continents/
Controls for this endpoint are still under construction.
| Method | Name | Value | Type | Required | Description |
|---|---|---|---|---|---|
| get | lang | string | No | Request localized information. |
| Name | Type | Description |
|---|---|---|
| id | int | The id of the continent. |
| name | string | The name of the continent. |
| continent_dims | array | The width and height dimensions of the continent |
| min_zoom | int | The minimal zoom level for use with the map tile service. |
| max_zoom | int | The maximum zoom level for use with the map tile service. |
| floors | array | A list of floors available for this continent. |
maps v2
This resource returns details about maps in the game, including details about floor and translation data on how to translate between world coordinates and map coordinates.
https://api.guildwars2.com/v2/maps/
Controls for this endpoint are still under construction.
| Method | Name | Value | Type | Required | Description |
|---|---|---|---|---|---|
| get | lang | string | No | Request localized information. |
| Name | Type | Description |
|---|---|---|
| id | int | The map id. |
| name | string | The map name. |
| min_level | int | The minimal level of this map. |
| max_level | int | The maximum level of this map. |
| default_floor | int | The default floor of this map. |
| floors | array | A list of available floors for this map. |
| region_id | int | The id of the region this map belongs to. |
| region_name | string | The name of the region this map belongs to. |
| continent_id | int | The id of the continent this map belongs to. |
| continent_name | string | The name of the continent this map belongs to. |
| map_rect | array | The dimensions of the map, given as the coordinates of the lower-left (SW) and upper-right (NE) corners. |
| continent_rect | array | The dimensions of the map within the continent coordinate system, given as the coordinates of the upper-left (NW) and lower-right (SE) corners. |
commerce/listings v2
This resource returns current buy and sell listings from the trading post.
https://api.guildwars2.com/v2/commerce/listings/
| Method | Name | Value | Type | Required | Description |
|---|---|---|---|---|---|
| get | ids | string | No | Optional parameter to get details about specific IDs. Seperate with a comma. | |
| get | page | int | No | Pagination. |
| Name | Type | Description |
|---|---|---|
| id | int | The item id. |
| buys | array | A list of all buy listings, ascending from lowest buy order. |
| sells | array | A list of all sell listings, ascending from lowest sell offer. |
commerce/exchange v2
This resource returns a list of accepted resources for the gem exchange.
https://api.guildwars2.com/v2/commerce/exchange/
| Method | Name | Value | Type | Required | Description |
|---|---|---|---|---|---|
| get | quantity | int | Yes | The amount to exchange. |
| Name | Type | Description |
|---|---|---|
| coins_per_gem | int | Depending on the 2nd level endpoint either the number of coins you get per gem (/commerce/exchange/gems) or the number of coins you need for one gem (/commerce/exchange/coins). |
| quantity | int | The number of coins or gems you get for the specified quantity. |
commerce/prices v2
This resource returns a list of accepted resources for the gem exchange.
https://api.guildwars2.com/v2/commerce/prices/
| Method | Name | Value | Type | Required | Description |
|---|---|---|---|---|---|
| get | ids | string | No | Optional parameter to get details about specific IDs. Seperate with a comma. | |
| get | page | int | No | Pagination. |
| Name | Type | Description |
|---|---|---|
| id | int | The item id. |
| buys | object | Buy information. |
| sells | object | Sell information. |
build v2
This resource returns the current build id of the game. This can be used, for example, to register when event timers reset due to server restarts.
https://api.guildwars2.com/v2/build/
| Method | Name | Value | Type | Required | Description |
|---|---|---|---|---|---|
| None | |||||
| Name | Type | Description |
|---|---|---|
| id | int | The build id. |
colors v2
This resource returns all dye colors in the game, including localized names and their color component information.
https://api.guildwars2.com/v2/colors/
| Method | Name | Value | Type | Required | Description |
|---|---|---|---|---|---|
| get | ids | string | No | Optional parameter to get details about specific IDs. Seperate with a comma. | |
| get | lang | string | No | Request localized information. | |
| get | page | int | No | Pagination. |
| Name | Type | Description |
|---|---|---|
| id | int | The color id. |
| name | string | The color name. |
| base_rgb | array | The base RGB values. |
| cloth | object | Detailed information on its appearance when applied on cloth armor. |
| leather | object | Detailed information on its appearance when applied on leather armor. |
| object | Detailed information on its appearance when applied on metal armor. |
files v2
This resource returns commonly requested in-game assets that may be used to enhance API-derived applications.
https://api.guildwars2.com/v2/files/
| Method | Name | Value | Type | Required | Description |
|---|---|---|---|---|---|
| get | ids | string | No | Dyes to request via its ID. Seperate multiple with a comma. | |
| get | page | int | No | Pagination. |
| Name | Type | Description |
|---|---|---|
| id | string | The file identifier. |
| icon | string | The URL to the image. |
quaggans v2
This resource returns quaggan images.
https://api.guildwars2.com/v2/quaggans/
| Method | Name | Value | Type | Required | Description |
|---|---|---|---|---|---|
| get | ids | string | No | The quaggan identifier. |
| Name | Type | Description | |||
|---|---|---|---|---|---|
| get | ids | string | No | Optional parameter to get details about specific IDs. Seperate with a comma. | |
| url | string | The URL to the quaggan image. |
worlds v2
This resource returns information about the available worlds, or servers.
https://api.guildwars2.com/v2/worlds/
| Method | Name | Value | Type | Required | Description |
|---|---|---|---|---|---|
| get | ids | string | No | Optional parameter to get details about specific IDs. Seperate with a comma. | |
| get | lang | string | No | Request localized information. | |
| get | page | int | No | Pagination. |
| Name | Type | Description |
|---|---|---|
| id | int | The world id. |
| name | string | The world name. |