API:2/achievements
From Guild Wars 2 Wiki
< API:2
Jump to navigationJump to search
/v2/achievements
- HTTP method
- GET
- Format
- json
- API version
- version 2
- Release date
- 2015-10-08
- Scope
- none
- Optional
- none
This resource returns all [1] achievements in the game, including localized names and icons.
Parameters
- Optional parameters
lang
– The language to query the names for.
Response
If the root endpoint (/v2/achievements
) is accessed without specifying an id, a list of all ids is returned. When multiple ids are requested using the ids
parameter, a list of response objects is returned.
For each requested achievement id, an object with the following properties is returned:
id
- The achievement id.icon
(string, optional) – The achievement icon.name
(string) – The achievement name.description
(string) – The achievement description.requirement
(string) – The achievement requirement as listed in-game.locked_text
(string) – The achievement description prior to unlocking it.type
(string) – The achievement type. Possible values:Default
- A default achievement.ItemSet
- Achievement is linked to Collections
flags
(array of strings) - Achievement categories. Possible values:Pvp
- can only get progress in PvP or WvWCategoryDisplay
- is a meta achievementMoveToTop
- affects in-game UI collationIgnoreNearlyComplete
- doesn't appear in the "nearly complete" UIRepeatable
- can be repeated multiple timesHidden
- hidden achievement; must fulfil unlock requirements before making progress or showing in the hero panelRequiresUnlock
- must fulfil unlock requirements before making progress but will show in the hero panel before unlockingRepairOnLogin
- unknownDaily
- Flags an achievement as resetting daily.Weekly
- Flags an achievement as resetting weekly.Monthly
- Flags an achievement as resetting monthly.Permanent
- Flags an achievement as progress never reseting.
tiers
(array of objects) - Describes the achievement's tiers. Each object contains:count
(number) - The number of "things" (achievement-specific) that must be completed to achieve this tier.points
(number) The amount of AP awarded for completing this tier.
prerequisites
(array of numbers) (optional) - Contains an array of achievementid
s required to progress the given achievement.rewards
(array of objects, optional) - Describes the rewards given for the achievement. Each object contains:type
(string) - The type of reward. Additional fields appear for different values oftype
.- If
Coins
:count
(number) - The number of Coins to be rewarded.
- If
Item
:id
(number) - The item ID to be rewarded.count
(number) - The number ofid
to be rewarded.
- If
Mastery
:id
(number) - The mastery point ID to be rewarded.region
(string) - The region the Mastery Point applies to. EitherTyria
,Maguuma
,Desert
orTundra
.
- If
Title
:id
(number) - The title id.
- If
bits
(array of objects, optional) - Contains a number of objects, each corresponding to a bitmask value that can give further information on the progress towards the achievement. Each object has the following values:type
(string) - The type of bit. Can beText
,Item
,Minipet
, orSkin
.id
(number, optional) - The ID of the item, mini, or skin, if applicable.text
(string, optional) - The text for the bit, iftype
isText
.
point_cap
(number, optional) - The maximum number of AP that can be rewarded by an achievement flagged asRepeatable
.
Example
https://api.guildwars2.com/v2/achievements?ids=1840,910,2258
[ { "id": 1840, "name": "Daily Completionist", "description": "", "requirement": "Complete any PvE, WvW, or PvP Daily Achievements.", "locked_text": "", "type": "Default", "flags": [ "Pvp", "CategoryDisplay" ], "tiers": [ { "count": 3, "points": 10 } ], "rewards": [ { "type": "Item", "id": 70047, "count": 1 }, { "type": "Coins", "count": 20000 } ] }, { "id": 910, "name": "Tequatl the Sunless", "description": "", "requirement": "Complete Tequatl achievements.", "locked_text": "", "type": "Default", "flags": [ "CategoryDisplay" ], "tiers": [ { "count": 10, "points": 50 } ], "rewards": [ { "type": "Mastery", "region": "Tyria", "id": 247 }, { "type": "Title", "id": 175 } ] }, { "id": 2258, "name": "Mistward Legguards", "description": "", "requirement": "Collect all items and skins to forge your Mistward Legguards.", "locked_text": "Complete the Invocation revenant specialization to unlock the Mistward Legguards collection.", "type": "ItemSet", "flags": [ "IgnoreNearlyComplete", "Pvp", "RepairOnLogin", "RequiresUnlock" ], "bits": [ { "type": "Skin", "id": 208 }, ... { "type": "Item", "id": 70944 }, { "type": "Item", "id": 74774 } ], "tiers": [ { "count": 1, "points": 1 }, { "count": 3, "points": 1 }, { "count": 7, "points": 1 } ], "rewards": [ { "type": "Item", "id": 70598, "count": 1 } ] } ]
Notes
References
- ^ As with every endpoint a caveat to this is that any content which has not been internally whitelisted will not be retrievable. Several achievements have been known to un-whitelist themselves and their details are therefore no longer visible through the API.