API:2/pvp/heroes

From Guild Wars 2 Wiki
< API:2‎ | pvp
Jump to: navigation, search

/v2/pvp/heroes

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

This resource returns information about pvp heroess that are available in-game.

Endpoints

  • None - Request the list of all available pvp heroes ids when the root endpoint (v2/pvp/heroes) has been accessed.
  • id - (Optional) Request the pvp heroes for the specified id when accessing the endpoint (v2/pvp/heroes/id). Cannot be used when specifying the ids parameter.

Parameters

  • lang – (Optional) Request localized information.
  • page - (Optional; integer)
  • page_size - (Optional; integer)
  • ids - (Optional; Comma Delimited List|all) Request an array of pvp heroess for the specified ids or all pvp heroess. Cannot be used when accessing the id endpoint.

Response

For each requested pvp heroes id, an object with the following properties is returned:

  • id (string) - The id of the pvp heroes.
  • name (string) - The name of the pvp heroes.
  • type (string) - The flavor type describing the hero
  • stats (object) - An object reflecting the champions stats under offense, defense, or speed.
  • overlay (string) - The overlay art url for that champion.
  • underlay (string) - The underlay art url for that champion.
  • skins (array of objects)
    • id (number) - The skin id
    • name (string) - The name of the skin
    • icon (string) - The icon url for the skin
    • default (boolean) - States if the skin is the default champion skin.
    • unlock_items (array of numbers) - Item ids which unlock the skin. Can be resolved against v2/items.

Example

https://api.guildwars2.com/v2/pvp/heroes/115C140F-C2F5-40EB-8EA2-C3773F2AE468

 {
   "id": "115C140F-C2F5-40EB-8EA2-C3773F2AE468",
   "name": "Nika",
   "description": "Nika was a proficient assassin schooled in her youth at Shing Jea Monastery. She served Cantha as a member of the Obsidian Flame.",
   "type": "Specialist Hero",
   "stats": {
       "offense": 3,
       "defense": 2,
       "speed": 4
   },
   "overlay": "https://render.guildwars2.com/file/2CACF4120E370D1997A4C3D69BF592D7CC1870C8/993693.png",
   "underlay": "https://render.guildwars2.com/file/103108E0D8EDD22C577FA4171618D004A82AD955/993694.png",
   "skins": [
       {
           "id": 1,
           "name": "Nika",
           "icon": "https://render.guildwars2.com/file/4602BDC15B73422011AC664425D93750707F04F3/1058576.png",
           "default": true
       },
       {
           "id": 7,
           "name": "Shadow Assassin Nika",
           "icon": "https://render.guildwars2.com/file/01643F1BD1202007BEE8E37F7DA3EA31AEE9536C/1322841.png",
           "default": false
       },
       ...
   ]
 }