Items

Data about every item in the game. Any endpoint that takes an :id accepts either the numeric ID or the item type (slug).


Get all items

Properties

  • Name
    id
    Type
    integer
    Description
    Item ID.
  • Name
    type
    Type
    string
    Description
    Item type (slug).
  • Name
    name
    Type
    string
    Description
    Item name.
  • Name
    description
    Type
    string
    Description
    Item description.
  • Name
    classification
    Type
    string
    Description
    Item classification.
  • Name
    tags
    Type
    array
    Description
    Item tags.
  • Name
    environment
    Type
    array
    Description
    Environments the item is available in.
  • Name
    images
    Type
    object
    Description
    Item image URLs.
  • Name
    is_limited_edition
    Type
    boolean
    Description
    Whether the item is limited edition.
  • Name
    is_givable
    Type
    boolean
    Description
    Whether the item can be given to other hunters.
  • Name
    is_tradable
    Type
    boolean
    Description
    Whether the item can be traded.
  • Name
    is_convertible
    Type
    boolean
    Description
    Whether the item can be opened/converted.
  • Name
    is_smashable
    Type
    boolean
    Description
    Whether the item breaks down into parts with the Hunter’s Hammer.
  • Name
    is_potion
    Type
    boolean
    Description
    Whether the item is a potion.
  • Name
    is_skin
    Type
    boolean
    Description
    Whether the item is a trap skin.
  • Name
    is_charm
    Type
    boolean
    Description
    Whether the item is a charm.
  • Name
    is_quantity_limited
    Type
    boolean
    Description
    Whether the item is quantity limited.
  • Name
    has_stats
    Type
    object
    Description
    Item stats (power, luck, etc.) when applicable.
  • Name
    parts
    Type
    object
    Description
    Parts the item breaks down into when smashed. Empty for items that can’t be smashed.
  • Name
    quantity_limit
    Type
    integer
    Description
    Item quantity limit.
  • Name
    category
    Type
    string
    Description
    Item category, e.g. Blueprints. Only present on some items.
  • Name
    status
    Type
    string
    Description
    active, inactive, or removed. Only present on some items.
  • Name
    action_verb
    Type
    string
    Description
    Verb used for the item’s action, e.g. Unwrap. Only present on some items.
  • Name
    button_text
    Type
    string
    Description
    Text on the item’s action button. Only present on some items.
  • Name
    message
    Type
    string
    Description
    Plain-text message shown when the item is used. Only present on some items.
  • Name
    page_text_front
    Type
    string
    Description
    Plain-text front of a torn page or similar item. Pairs with page_text_back, and with images.page_front / images.page_back.
  • Name
    required_title
    Type
    string
    Description
    Minimum hunter title needed for the item, with a display name in required_title_formatted.
  • Name
    consume_method
    Type
    string
    Description
    How a charm gets used up: always, catch, custom, encounter, fail_to_attract, fail_to_catch, or stale_or_encounter. The game’s wording is in consume_method_formatted.
  • Name
    golden_shield_seconds
    Type
    integer
    Description
    Golden Shield time the item grants, with a readable version (e.g. 1 month) in golden_shield_seconds_formatted.
  • Name
    recipes
    Type
    array
    Description
    Potion recipes (input, output, gold_cost, title_required). Only present on potions — see /potions for the same data with item IDs.

Request

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

Response

[
  {
    "id": 1168,
    "type": "hot_tub_weapon",
    "name": "Mouse Hot Tub",
    "description": "Instead of harming a mouse, give it a soothing place to relax ...",
    "classification": "weapon",
    "tags": ["physical", "weapon"],
    "environment": ["cape_clawed", "derr_dunes", "dracano"],
    "images": {
      "thumbnail": "https://www.mousehuntgame.com/images/items/weapons/a84f9ea42272cb2f19592f90fbf199c8.jpg?cv=2",
      "large": "https://www.mousehuntgame.com/images/items/weapons/trap_small/f1cbf7275abfcead8bab92d49b21a592.png?cv=2",
      "gray": "https://www.mousehuntgame.com/images/items/weapons/gray/6bd5591a5f54daec926239a131374496.jpg?cv=2",
      "transparent": "",
      "transparent_large": "",
      "best": "https://www.mousehuntgame.com/images/items/weapons/trap_small/f1cbf7275abfcead8bab92d49b21a592.png?cv=2"
    },
    "is_limited_edition": false,
    "is_givable": false,
    "is_tradable": false,
    "is_convertible": false,
    "is_smashable": false,
    "is_potion": false,
    "is_skin": false,
    "is_charm": false,
    "is_quantity_limited": true,
    "has_stats": {
      "power_type": "physical",
      "power": 70,
      "power_bonus_formatted": "3%",
      "attraction_bonus_formatted": "35%",
      "luck": 2,
      "cheese_effect": "No Effect",
      "min_title": "novice"
    },
    "quantity_limit": 1
  }
]

Get item by ID

Replace :id with the item type or ID.

Properties

  • Name
    id
    Type
    integer
    Description
    Item ID.
  • Name
    type
    Type
    string
    Description
    Item type (slug).
  • Name
    name
    Type
    string
    Description
    Item name.
  • Name
    description
    Type
    string
    Description
    Item description.
  • Name
    classification
    Type
    string
    Description
    Item classification.
  • Name
    tags
    Type
    array
    Description
    Item tags.
  • Name
    environment
    Type
    array
    Description
    Environments the item is available in.
  • Name
    images
    Type
    object
    Description
    Item image URLs.
  • Name
    is_limited_edition
    Type
    boolean
    Description
    Whether the item is limited edition.
  • Name
    is_givable
    Type
    boolean
    Description
    Whether the item can be given to other hunters.
  • Name
    is_tradable
    Type
    boolean
    Description
    Whether the item can be traded.
  • Name
    is_convertible
    Type
    boolean
    Description
    Whether the item can be opened/converted.
  • Name
    is_smashable
    Type
    boolean
    Description
    Whether the item breaks down into parts with the Hunter’s Hammer.
  • Name
    is_potion
    Type
    boolean
    Description
    Whether the item is a potion.
  • Name
    is_skin
    Type
    boolean
    Description
    Whether the item is a trap skin.
  • Name
    is_charm
    Type
    boolean
    Description
    Whether the item is a charm.
  • Name
    is_quantity_limited
    Type
    boolean
    Description
    Whether the item is quantity limited.
  • Name
    has_stats
    Type
    object
    Description
    Item stats (power, luck, etc.) when applicable.
  • Name
    parts
    Type
    object
    Description
    Parts the item breaks down into when smashed. Empty for items that can’t be smashed.
  • Name
    quantity_limit
    Type
    integer
    Description
    Item quantity limit.
  • Name
    category
    Type
    string
    Description
    Item category, e.g. Blueprints. Only present on some items.
  • Name
    status
    Type
    string
    Description
    active, inactive, or removed. Only present on some items.
  • Name
    action_verb
    Type
    string
    Description
    Verb used for the item’s action, e.g. Unwrap. Only present on some items.
  • Name
    button_text
    Type
    string
    Description
    Text on the item’s action button. Only present on some items.
  • Name
    message
    Type
    string
    Description
    Plain-text message shown when the item is used. Only present on some items.
  • Name
    page_text_front
    Type
    string
    Description
    Plain-text front of a torn page or similar item. Pairs with page_text_back, and with images.page_front / images.page_back.
  • Name
    required_title
    Type
    string
    Description
    Minimum hunter title needed for the item, with a display name in required_title_formatted.
  • Name
    consume_method
    Type
    string
    Description
    How a charm gets used up: always, catch, custom, encounter, fail_to_attract, fail_to_catch, or stale_or_encounter. The game’s wording is in consume_method_formatted.
  • Name
    golden_shield_seconds
    Type
    integer
    Description
    Golden Shield time the item grants, with a readable version (e.g. 1 month) in golden_shield_seconds_formatted.
  • Name
    recipes
    Type
    array
    Description
    Potion recipes (input, output, gold_cost, title_required). Only present on potions — see /potions for the same data with item IDs.

Request

GET
https://api.mouse.rip/items/:id
// Can use either type or ID
const item = await fetch('https://api.mouse.rip/items/power_trinket')
console.log(item)

const item = await fetch('https://api.mouse.rip/items/351')
console.log(item)

Response

{
  "id": 351,
  "type": "power_trinket",
  "name": "Power Charm",
  "description": "Slightly warm to the touch, this charm is bursting with potential power! ...",
  "classification": "trinket",
  "tags": ["mountain", "trinket"],
  "environment": [],
  "images": { "...": "see /items above" },
  "is_tradable": false,
  "is_smashable": false,
  "is_charm": true,
  "has_stats": {
    "power": 500,
    "power_bonus_formatted": "5%",
    "cheese_effect": "No Effect"
  },
  "parts": {},
  "quantity_limit": 0,
  "consume_method": "encounter",
  "consume_method_formatted": "Encountering a Mouse"
}

Get slim items

A trimmed-down version of every item with just the identifying fields and images, for when the full /items payload is more than you need.

Properties

  • Name
    id
    Type
    integer
    Description

    Item ID.

  • Name
    type
    Type
    string
    Description

    Item type (slug).

  • Name
    name
    Type
    string
    Description

    Item name.

  • Name
    classification
    Type
    string
    Description

    Item classification.

  • Name
    tags
    Type
    array
    Description

    Item tags.

  • Name
    images
    Type
    object
    Description

    Image URLs (thumbnail, best, upscaled).

Request

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

Response

[
  {
    "id": 1,
    "type": "balack_lantern_map_piece",
    "name": "Balack's Lantern",
    "classification": "map_piece",
    "tags": ["map_piece"],
    "images": {
      "thumbnail": "https://www.mousehuntgame.com/images/items/maps/69c29dfc90eea078ed36a05371499af3.jpg",
      "best": "https://www.mousehuntgame.com/images/items/maps/69c29dfc90eea078ed36a05371499af3.jpg",
      "upscaled": "https://i.mouse.rip/upscaled/69c29dfc90eea078ed36a05371499af3.png"
    }
  }
]

Get tradable items

A lightweight list of every item that can be traded.

Properties

  • Name
    id
    Type
    integer
    Description

    Item ID.

  • Name
    type
    Type
    string
    Description

    Item type (slug).

  • Name
    name
    Type
    string
    Description

    Item name.

  • Name
    image
    Type
    string
    Description

    Item image URL.

  • Name
    truncated_name
    Type
    string
    Description

    Truncated item name.

Request

GET
https://api.mouse.rip/items-tradable
const tradableItems = await fetch('https://api.mouse.rip/items-tradable')
console.log(tradableItems)

Response

[
  {
    "id": 103,
    "type": "maki_cheese",
    "name": "Maki Cheese",
    "image": "https://www.mousehuntgame.com/images/items/bait/df0071729e6a9f91360c124a40eae8ec.jpg",
    "truncated_name": "Maki Cheese"
  }
]

Get item thumbnails

A lightweight list of every item and its image URLs.

Properties

  • Name
    id
    Type
    integer
    Description

    Item ID.

  • Name
    type
    Type
    string
    Description

    Item type (slug).

  • Name
    image
    Type
    string
    Description

    Item image URL.

  • Name
    thumb
    Type
    string
    Description

    Thumbnail image URL.

Request

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

Response

[
  {
    "id": 1,
    "type": "balack_lantern_map_piece",
    "image": "https://www.mousehuntgame.com/images/items/maps/69c29dfc90eea078ed36a05371499af3.jpg",
    "thumb": "https://www.mousehuntgame.com/images/items/maps/69c29dfc90eea078ed36a05371499af3.jpg"
  }
]

Get item names to IDs

A lookup map of item display name to item ID. Handy for resolving names from the game UI to IDs.

Properties

  • Name
    [name]
    Type
    integer
    Description

    Keyed by item display name, with the item ID as the value.

Request

GET
https://api.mouse.rip/items-names-to-ids
const namesToIds = await fetch('https://api.mouse.rip/items-names-to-ids')
console.log(namesToIds)

Response

{
  "Calm Clearing Map Piece": 16,
  "Fire Salt": 196,
  "Ancient Spear": 170,
  "Power Charm": 351
}