Potions

Every potion and its recipes — what it consumes, what it produces, the gold cost, and the title required for each recipe tier.


Get all potions

Properties

  • Name
    id
    Type
    integer
    Description

    Potion item ID.

  • Name
    type
    Type
    string
    Description

    Potion item type (slug).

  • Name
    name
    Type
    string
    Description

    Potion name.

  • Name
    image
    Type
    string
    Description

    Potion image URL.

  • Name
    recipes
    Type
    array
    Description
  • Name
    input
    Type
    object
    Description

    The item consumed: id, type, name, and quantity.

  • Name
    output
    Type
    object
    Description

    The item produced: id, type, name, and quantity.

  • Name
    gold_cost
    Type
    integer
    Description

    Gold cost to brew this recipe.

  • Name
    title_required
    Type
    string
    Description

    Minimum hunter title for this recipe, e.g. novice or lord_lady.

Request

GET
https://api.mouse.rip/potions
const potions = await fetch('https://api.mouse.rip/potions')
console.log(potions)

Response

[
  {
    "id": 123,
    "type": "brie_cheese_potion",
    "name": "Brie Potion",
    "image": "https://www.mousehuntgame.com/images/items/potions/large/5abdee75aaffeac082b9af21a568700e.png",
    "recipes": [
      {
        "input": {
          "id": 117,
          "type": "swiss_cheese",
          "name": "Swiss Cheese",
          "quantity": 20
        },
        "output": {
          "id": 80,
          "type": "brie_cheese",
          "name": "Brie Cheese",
          "quantity": 20
        },
        "gold_cost": 50,
        "title_required": "novice"
      },
      ...
    ]
  },
  ...
]

Get potions by ID

Replace :id with a potion's ID or type, or the ID or type of an item a potion uses or makes. Always returns an array of matching potions, which is empty when nothing matches.

Properties

Same as /potions.

Request

GET
https://api.mouse.rip/potions/:id
// A potion by type or ID
const potion = await fetch('https://api.mouse.rip/potions/brie_cheese_potion')
console.log(potion)

// Every potion that uses or makes Brie Cheese
const briePotions = await fetch('https://api.mouse.rip/potions/brie_cheese')
console.log(briePotions)

Response

[
  {
    "id": 122,
    "type": "ancient_cheese_potion",
    "name": "Ancient Potion",
    "image": "https://www.mousehuntgame.com/images/items/potions/large/9ca0dcfad630fd8dc5fdedb86bb502bb.png",
    "recipes": [ ... ]
  },
  {
    "id": 123,
    "type": "brie_cheese_potion",
    "name": "Brie Potion",
    "image": "https://www.mousehuntgame.com/images/items/potions/large/5abdee75aaffeac082b9af21a568700e.png",
    "recipes": [ ... ]
  },
  ...
]