API:2/skins

From Guild Wars 2 Wiki
Jump to navigationJump to search

/v2/skins

HTTP method
GET
Format
json
API version
version 2
Release date
2015-02-13
Scope
none
Optional
none

This resource returns information about skins that were discovered by players in the game.

Endpoint

  • /v2/skins
  • /v2/skins/{id}

Parameters

  • ids | (optional) – a comma separated list of ids.
  • lang | (optional) – Request localized information.

Response

  • The root endpoint (/v2/skins) will return a list of all ids.
  • The id endpoint (/v2/skins/{id}) will return the details of a single id
  • Using the ids parameter, will return a list of skin objects.

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

  • id (number) – The skin id.
  • name (string) – The name of the skin.
  • type (string) – The skin type, either Armor, Weapon, Back or Gathering.
  • flags (array of string) – Additional skin flags. Possible flags are:
    • ShowInWardrobe – When displayed in the account wardrobe (set for all skins listed in the API).
    • NoCost – When applying the skin is free.
    • HideIfLocked – When the skin is hidden until it is unlocked.
    • OverrideRarity - When the skin overrides item rarity when applied
  • restrictions (array of string) – Race restrictions that apply to the skin, e.g. Human will be a listed restriction, if the skin can only be applied to human characters.
  • icon (string) – The full icon URL.
  • rarity (string) - The rarity of the skin
  • description (string) – Optional skin description.
  • details (object, optional) – Additional skin details if applicable, depending on the skin type (see below).

Armor

For armor skins, the details object contains the following properties:

  • type (string) – The armor type (slot).
  • weight_class (string) – The armor weight, either Clothing, Light, Medium or Heavy.
  • dye_slots (object) - An object containing information on default slots and skin overrides. If the array item is null, this means dye cannot be applied to that slot, except if otherwise overriden by non-null values in the overrides array.
    • default (array of objects)
      • color_id (number) - The id of the default color, to be resolved against v2/colors
      • material (string) - The type of material. Either cloth, leather, metal
    • overrides (object) - Object of race/gender overrides. Each sub-object follows the same structure as default. The possible override sub-objects are: AsuraMale, AsuraFemale, CharrMale, CharrFemale, HumanMale, HumanFemale, NornMale, NornFemale, SylvariMale, SylvariFemale

Weapons

For weapon skins, the details object contains the following properties:

  • type (string) – The weapon type.
  • damage_type (string) – The damage type, either Physical, Fire, Lightning, Ice or Choking.

Gathering

For gathering tool skins, the details object contains the following properies:

  • type (string) - The tool type, either Foraging, Logging or Mining

Example

https://api.guildwars2.com/v2/skins/10

 {
   "name": "Seer Pants",
   "type": "Armor",
   "flags": [
       "ShowInWardrobe"
   ],
   "restrictions": [ ],
   "rarity": "Basic",
   "id": 10,
   "icon": "https://render.guildwars2.com/file/1920ACA302E656B60C38605521760351F147809D/61088.png",
   "details": {
       "type": "Leggings",
       "weight_class": "Light",
       "dye_slots": {
           "default": [
               {
                   "color_id": 48,
                   "material": "cloth"
               },
               {
                   "color_id": 127,
                   "material": "cloth"
               },
               {
                   "color_id": 615,
                   "material": "metal"
               },
               null
           ],
           "overrides": { }
       }
   }
 }

https://api.guildwars2.com/v2/skins?ids=1,2,3

 [{
   "name": "Chainmail Leggings",
   "type": "Armor",
   "flags": [
     "ShowInWardrobe"
   ],
   "restrictions": [],
   "rarity": "Basic",
   "id": 1,
   "icon": "https://render.guildwars2.com/file/9321FD09DF90E8D10D80B5C41D722F357FE5970A/61104.png",
   "details": {
     "type": "Leggings",
     "weight_class": "Heavy",
     "dye_slots": {
       "default": [
         {
           "color_id": 1,
           "material": "metal"
         },
         {
           "color_id": 1,
           "material": "metal"
         },
         {
           "color_id": 1,
           "material": "leather"
         },
         null
       ],
       "overrides": {}
     }
   }
 },
 {
   "name": "Chainmail Chestpiece",
   "type": "Armor",
   "flags": [
     "ShowInWardrobe"
   ],
   "restrictions": [],
   "rarity": "Basic",
   "id": 2,
   "icon": "https://render.guildwars2.com/file/A2D0D6DA90056E76F1BE244F0C9EF333F95D9746/61098.png",
   "details": {
     "type": "Coat",
     "weight_class": "Heavy",
     "dye_slots": {
       "default": [
         {
           "color_id": 1,
           "material": "metal"
         },
         {
           "color_id": 1,
           "material": "metal"
         },
         {
           "color_id": 1,
           "material": "leather"
         },
         null
       ],
       "overrides": {}
     }
   }
 },
 {
   "name": "Apprentice Pants",
   "type": "Armor",
   "flags": [
     "ShowInWardrobe"
   ],
   "restrictions": [],
   "rarity": "Basic",
   "id": 3,
   "icon": "https://render.guildwars2.com/file/AAB41A903B03C7DEB833A8CC4E08CF0A02A67BD5/61404.png",
   "details": {
     "type": "Leggings",
     "weight_class": "Light",
     "dye_slots": {
       "default": [
         {
           "color_id": 1,
           "material": "cloth"
         },
         {
           "color_id": 1,
           "material": "metal"
         },
         {
           "color_id": 1,
           "material": "cloth"
         },
         null
       ],
       "overrides": {}
     }
   }
 }]

Notes

  • Returned color_ids are almost entirely random for most skins and will frequently change when the API cache updates.
  • Although several back items can be dyed, no dye information is reported by this endpoint for back items.