API:2/recipes

From Guild Wars 2 Wiki
Jump to navigationJump to search

/v2/recipes

HTTP method
GET
Format
json
API version
version 2
Release date
2014-10-24
Scope
none
Optional
none

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

Response

If the root endpoint (/v2/recipes) 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 recipe id, an object with the following properties is returned:

  • id (number) – The recipe id.
  • type (string) – The recipe type. Possible values:
    • Weapon recipes: Axe, Dagger, Focus, Greatsword, Hammer, Harpoon, LongBow, Mace, Pistol, Rifle, Scepter, Shield, ShortBow, Speargun, Staff, Sword, Torch, Trident, Warhorn
    • Armor recipes: Boots, Coat, Gloves, Helm, Leggings, Shoulders
    • Trinket recipes: Amulet, Earring, Ring
    • Food recipes: Dessert, Feast, IngredientCooking, Meal, Seasoning, Snack, Soup, Food
    • Crafting component recipes: Component, Inscription, Insignia, LegendaryComponent
    • Refinement recipes: Refinement, RefinementEctoplasm, RefinementObsidian
    • Guild recipes: GuildConsumable, GuildDecoration, GuildConsumableWvw
    • Other recipes: Backpack, Bag, Bulk, Consumable, Dye, Food, Potion, UpgradeComponent
  • output_item_id (number) – The item id of the produced item resolvable against v2/items.
  • output_item_count (number) – The amount of items produced.
  • time_to_craft_ms (number) – The time in milliseconds it takes to craft the item.
  • disciplines (array of strings) – The crafting disciplines that can use the recipe. Possible values:
    • Artificer
    • Armorsmith
    • Chef
    • Huntsman
    • Jeweler
    • Leatherworker
    • Tailor
    • Weaponsmith
    • Scribe
  • min_rating (number) – The required rating to craft the recipe.
  • flags (array of strings) – Flags applying to the recipe. Possible values:
    • AutoLearned – Indicates that a recipe automatically unlocks upon reaching the required discipline rating.
    • LearnedFromItem – Indicates that a recipe is unlocked by consuming a recipe sheet.
  • ingredients (array of objects) – List of recipe ingredients. Each object contains the following properties:
    • item_id The ingredient's id resolvable against v2/items.
    • count (number) – The quantity of this ingredient.
  • guild_ingredients (array of objects, optional) - List of recipe ingredients that come from the guild such as decorations or schematics. Each object contains the following properties:
    • upgrade_id (number) - The id of the used guild upgrade resolvable against v2/guild/upgrades.
    • count (number) - The quantity of this guild ingredient.
  • output_upgrade_id (number, optional) - The id of the produced guild upgrade resolvable against v2/guild/upgrades.
  • chat_link (string) – The chat code for the recipe.

Schema updates

As of march 2022 the latest version of the recipes endpoints has modified the ingredients fields to include currency as an option. In older schemas such recipes appear as invalid. The relevant changes are represented by

  • ingredients (array of objects) – List of recipe ingredients. Each object contains the following properties:
    • type (string) - Type of ingredient, at the moment "Currency" or "Item"
    • id (number) – The ingredient's id resolvable against v2/items or v2/currencies.
    • count (number) – The quantity of this ingredient.

Examples

https://api.guildwars2.com/v2/recipes/13598?v=2022-03-09T02:00:00.000Z

 {
   "id": 13598,
   "type": "Insignia",
   "output_item_id": 96315,
   "output_item_count": 1,
   "time_to_craft_ms": 1000,
   "disciplines": [ "Leatherworker", "Armorsmith", "Tailor" ],
   "min_rating": 400,
   "flags": [ "LearnedFromItem" ],
   "ingredients": [ 
     { "type": "Item", "id": 96471, "count": 10 },
     { "type": "Item", "id": 19721, "count": 5 },
     { "type": "Item", "id": 76614, "count": 5 },
     { "type": "Currency", "id": 61, "count": 150 }
   ],
   "chat_link": "[&CR41AAA=]"
 }

https://api.guildwars2.com/v2/recipes/7319

 {
   "id": 7319,
   "type": "RefinementEctoplasm",
   "output_item_id": 46742,
   "output_item_count": 1,
   "time_to_craft_ms": 5000,
   "disciplines": ["Leatherworker", "Armorsmith", "Tailor", "Artificer", "Weaponsmith", "Huntsman" ],
   "min_rating": 450,
   "flags": [ "AutoLearned" ],
   "ingredients": [
     { "item_id": 19684, "count": 50 },
     { "item_id": 19721, "count": 1 },
     { "item_id": 46747, "count": 10 }
   ],
   "chat_link": "[&CZccAAA=]",
   "guild_ingredients": []
 }

Notes

Scribe recipes which create guild upgrades (i.e. those producing no items which appear in the character's inventory) currently return misleading item ids within the output_item_id field. (ref)