api.mouse.rip

Recipes

Every crafting recipe: what it makes and what unlocks it. Ingredients aren't included. Filter on nested fields with dots, e.g. unlock.tasks.requirements.type=keepers_assistant.

Get all recipes

GEThttps://api.mouse.rip/recipes

Supports filtering, searching, sorting, pagination, and field selection. See Search & Querying.

Query parameters

  • Name
    q
    Type
    string
    Description
    Case-insensitive partial text search.

Properties

  • Name
    type
    Type
    string
    Description
    Recipe type.
  • Name
    name
    Type
    string
    Description
    Recipe name.
  • Name
    status
    Type
    string
    Description
    active or inactive.
  • Name
    image
    Type
    string
    Description
  • Name
    result
    Type
    ItemRef
    Description
    The item the recipe makes.
  • Name
    id
    Type
    integer
    Description
    Item ID, or 0 if the item isn't known.
  • Name
    type
    Type
    string
    Description
  • Name
    name
    Type
    string
    Description
  • Name
    quantity
    Type
    integer
    Description
  • Name
    quantity
    Type
    integer
    Description
    How many of the item one craft makes.
  • Name
    max_inventory_quantity
    Type
    integer | null
    Description
    Most of the item a hunter can hold, or 0 for no limit.
  • Name
    allow_instant_unlock
    Type
    boolean
    Description
  • Name
    unlock
    Type
    object | null
    Description
    What unlocks the recipe, or null if it doesn't need unlocking.
  • Name
    minimum
    Type
    integer
    Description
    How many of the tasks must be completed.
  • Name
    tasks
    Type
    array of object
    Description
  • Name
    mode
    Type
    string
    Description
    e.g. catch, lootdrop, baitstale, add_item.
  • Name
    number
    Type
    integer
    Description
    How many times the task must be done.
  • Name
    requirements
    Type
    array of object
    Description
    What counts toward the task, e.g. catching a mouse or using a bait.

    • Request

    GET
    https://api.mouse.rip/recipes?status=active&limit=1
    const response = await fetch('https://api.mouse.rip/recipes?status=active&limit=1')

    Response

    [
  {
    "type": "ancient_cheese_3_pieces",
    "name": "Ancient Cheese (3 pieces)",
    "status": "active",
    "image": "https://www.mousehuntgame.com/images/items/bait/87a406486f5a3e3cea20fe582ba8eaec.gif",
    "result": {
      "id": 79,
      "type": "ancient_cheese",
      "name": "Ancient Cheese"
    },
    "quantity": 3,
    "max_inventory_quantity": null,
    "allow_instant_unlock": true,
    "unlock": {
      "minimum": 1,
      "tasks": [
        {...}
      ]
    }
  }
]

    Get recipes by recipe or item

    GEThttps://api.mouse.rip/recipes/:id

    Accepts a recipe type, or the ID or type of the item a recipe makes, and returns every matching recipe.

    Query parameters

    • Name
      q
      Type
      string
      Description
      Case-insensitive partial text search.

    Properties

    • Name
      type
      Type
      string
      Description
      Recipe type.
    • Name
      name
      Type
      string
      Description
      Recipe name.
    • Name
      status
      Type
      string
      Description
      active or inactive.
    • Name
      image
      Type
      string
      Description
    • Name
      result
      Type
      ItemRef
      Description
      The item the recipe makes.
    • Name
      id
      Type
      integer
      Description
      Item ID, or 0 if the item isn't known.
    • Name
      type
      Type
      string
      Description
    • Name
      name
      Type
      string
      Description
    • Name
      quantity
      Type
      integer
      Description
  • Name
    quantity
    Type
    integer
    Description
    How many of the item one craft makes.
  • Name
    max_inventory_quantity
    Type
    integer | null
    Description
    Most of the item a hunter can hold, or 0 for no limit.
  • Name
    allow_instant_unlock
    Type
    boolean
    Description
  • Name
    unlock
    Type
    object | null
    Description
    What unlocks the recipe, or null if it doesn't need unlocking.
  • Name
    minimum
    Type
    integer
    Description
    How many of the tasks must be completed.
  • Name
    tasks
    Type
    array of object
    Description
  • Name
    mode
    Type
    string
    Description
    e.g. catch, lootdrop, baitstale, add_item.
  • Name
    number
    Type
    integer
    Description
    How many times the task must be done.
  • Name
    requirements
    Type
    array of object
    Description
    What counts toward the task, e.g. catching a mouse or using a bait.

    • Request

    GET
    https://api.mouse.rip/recipes/ancient_cheese
    const response = await fetch('https://api.mouse.rip/recipes/ancient_cheese')

    Response

    [
  {
    "type": "ancient_cheese_3_pieces",
    "name": "Ancient Cheese (3 pieces)",
    "status": "active",
    "image": "https://www.mousehuntgame.com/images/items/bait/87a406486f5a3e3cea20fe582ba8eaec.gif",
    "result": {
      "id": 79,
      "type": "ancient_cheese",
      "name": "Ancient Cheese"
    },
    "quantity": 3,
    "max_inventory_quantity": null,
    "allow_instant_unlock": true,
    "unlock": {
      "minimum": 1,
      "tasks": [
        {...}
      ]
    }
  },
  {
    "type": "ancient_cheese_6_pieces",
    "name": "Ancient Cheese (6 pieces)",
    "status": "active",
    "image": "https://www.mousehuntgame.com/images/items/bait/87a406486f5a3e3cea20fe582ba8eaec.gif",
    "result": {
      "id": 79,
      "type": "ancient_cheese",
      "name": "Ancient Cheese"
    },
    "quantity": 6,
    "max_inventory_quantity": null,
    "allow_instant_unlock": true,
    "unlock": {
      "minimum": 1,
      "tasks": [
        {...}
      ]
    }
  }
]