Items

/item is an alias for /items. Any :id accepts a numeric ID or an item type (slug).


Get all items

Query parameters

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

Properties

  • Name
    id
    Type
    integer
    Description
  • Name
    type
    Type
    string
    Description
    Item type (slug).
  • Name
    name
    Type
    string
    Description
  • Name
    description
    Type
    string
    Description
  • Name
    classification
    Type
    string
    Description
    e.g. bait, weapon, trinket.
  • Name
    tags
    Type
    array of values
    Description
  • Name
    environment
    Type
    array of values
    Description
    Location types where the item is available.
  • Name
    images
    Type
    object
    Description
    Item image URLs.
  • Name
    is_limited_edition
    Type
    boolean
    Description
  • Name
    is_givable
    Type
    boolean
    Description
    Whether the item can be given to other hunters.
  • Name
    is_tradable
    Type
    boolean
    Description
  • 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
  • Name
    is_skin
    Type
    boolean
    Description
    Whether the item is a trap skin.
  • Name
    is_charm
    Type
    boolean
    Description
  • Name
    is_quantity_limited
    Type
    boolean
    Description
  • 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
    Most of the item a hunter can hold, or 0 for no limit.
  • Name
    category
    Type
    string
    Description
    e.g. Cheese, Trap Parts. 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 on the item's action button, e.g. Open. 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. 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, in seconds. Readable version (e.g. 1 month) in golden_shield_seconds_formatted.
  • Name
    recipes
    Type
    array of values
    Description
    Potion recipes (input, output, gold_cost, title_required). Only present on potions; [/potions](/potions) has the same data with item IDs.

Request

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

Response

[
  {
    "id": 1,
    "type": "balack_lantern_map_piece",
    "name": "Balack's Lantern",
    "description": "This magical lantern, lit with a Dragon Ember is the only light source hot enough to remain lit in the dampness of Balack's Cove.<br />\n<br />\n<b>Obtain this...",
    "classification": "map_piece",
    "tags": [
      "map_piece"
    ],
    "environment": [
      "balacks_cove"
    ],
    "images": {
      "thumbnail": "https://www.mousehuntgame.com/images/items/maps/69c29dfc90eea078ed36a05371499af3.jpg",
      "large": "",
      "thumbnail_large": "",
      "gray": "https://www.mousehuntgame.com/images/items/maps/gray/3ec0cec45164155d55cab27513dcad20.jpg",
      "transparent": "",
      "transparent_large": "",
      "best": "https://www.mousehuntgame.com/images/items/maps/69c29dfc90eea078ed36a05371499af3.jpg",
      "upscaled": "https://i.mouse.rip/upscaled/69c29dfc90eea078ed36a05371499af3.png"
    },
    "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": false,
    "is_airship_part": false,
    "has_stats": false,
    "parts": {},
    "quantity_limit": 0
  },
  {
    "id": 2,
    "type": "bazaar_map_piece",
    "name": "Ticket to the Burroughs Bazaar",
    "description": "This ticket grants access to the Burroughs Bazaar, and is dropped by a few varieties of mice in the Training Grounds.<br />\n<br />\n<b>Obtain this map piece d...",
    "classification": "map_piece",
    "tags": [
      "map_piece"
    ],
    "environment": [
      "bazaar"
    ],
    "images": {
      "thumbnail": "https://www.mousehuntgame.com/images/items/maps/45e053a16d858d237ab73e9a5dc77ba0.jpg",
      "large": "",
      "thumbnail_large": "",
      "gray": "https://www.mousehuntgame.com/images/items/maps/gray/617d0e7aeaaa2f44daf4d5c7e30ed782.jpg",
      "transparent": "",
      "transparent_large": "",
      "best": "https://www.mousehuntgame.com/images/items/maps/45e053a16d858d237ab73e9a5dc77ba0.jpg",
      "upscaled": "https://i.mouse.rip/upscaled/45e053a16d858d237ab73e9a5dc77ba0.png"
    },
    "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,
    "is_airship_part": false,
    "has_stats": false,
    "parts": {},
    "quantity_limit": 1
  },
  ...
]

Get item by ID

Query parameters

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

Properties

  • Name
    id
    Type
    integer
    Description
  • Name
    type
    Type
    string
    Description
    Item type (slug).
  • Name
    name
    Type
    string
    Description
  • Name
    description
    Type
    string
    Description
  • Name
    classification
    Type
    string
    Description
    e.g. bait, weapon, trinket.
  • Name
    tags
    Type
    array of values
    Description
  • Name
    environment
    Type
    array of values
    Description
    Location types where the item is available.
  • Name
    images
    Type
    object
    Description
    Item image URLs.
  • Name
    is_limited_edition
    Type
    boolean
    Description
  • Name
    is_givable
    Type
    boolean
    Description
    Whether the item can be given to other hunters.
  • Name
    is_tradable
    Type
    boolean
    Description
  • 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
  • Name
    is_skin
    Type
    boolean
    Description
    Whether the item is a trap skin.
  • Name
    is_charm
    Type
    boolean
    Description
  • Name
    is_quantity_limited
    Type
    boolean
    Description
  • 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
    Most of the item a hunter can hold, or 0 for no limit.
  • Name
    category
    Type
    string
    Description
    e.g. Cheese, Trap Parts. 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 on the item's action button, e.g. Open. 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. 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, in seconds. Readable version (e.g. 1 month) in golden_shield_seconds_formatted.
  • Name
    recipes
    Type
    array of values
    Description
    Potion recipes (input, output, gold_cost, title_required). Only present on potions; [/potions](/potions) has the same data with item IDs.

Request

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

Response

{
  "id": 351,
  "type": "power_trinket",
  "name": "Power Charm",
  "description": "Slightly warm to the touch, this charm is bursting with potential power! The Power Charm provides +500 Power and a 5% Power Bonus to your trap with each hunt.",
  "classification": "trinket",
  "tags": [
    "mountain",
    "trinket"
  ],
  "environment": [],
  "images": {
    "thumbnail": "https://www.mousehuntgame.com/images/items/trinkets/97b4024a0753b17a8ba7a036956ebef4.gif",
    "large": "https://www.mousehuntgame.com/images/items/trinkets/large/b0fb665f8649eb72432c66b0575c9516.png",
    "thumbnail_large": "",
    "gray": "",
    "transparent": "https://www.mousehuntgame.com/images/items/trinkets/transparent_thumb/b7ad7ad3953a3ed96dd7cf61e4d51ad5.png",
    "transparent_large": "https://www.mousehuntgame.com/images/items/trinkets/large/b0fb665f8649eb72432c66b0575c9516.png",
    "best": "https://www.mousehuntgame.com/images/items/trinkets/large/b0fb665f8649eb72432c66b0575c9516.png",
    "upscaled": "https://www.mousehuntgame.com/images/items/trinkets/large/b0fb665f8649eb72432c66b0575c9516.png"
  },
  "is_limited_edition": false,
  "is_givable": false,
  "is_tradable": false,
  "is_convertible": false,
  "is_smashable": false,
  "is_potion": false,
  "is_skin": false,
  "is_charm": true,
  "is_quantity_limited": false,
  "is_airship_part": false,
  "has_stats": {
    "power_type": "",
    "has_power": true,
    "power": 500,
    "power_formatted": "500",
    "has_power_bonus": true,
    "power_bonus": 0.05,
    "power_bonus_formatted": "5%",
    "has_attraction_bonus": false,
    "attraction_bonus": 0,
    "attraction_bonus_formatted": "None",
    "has_luck": false,
    "luck": 0,
    "luck_formatted": "None",
    "has_cheese_effect": false,
    "cheese_effect": "No Effect",
    "has_skins": false,
    "skins": [],
    "has_min_title": false,
    "has_min_points": false,
    "min_title": "",
    "min_points": 0,
    "min_points_formatted": ""
  },
  "parts": {},
  "quantity_limit": 0,
  "consume_method": "encounter",
  "consume_method_formatted": "Encountering a Mouse"
}

Get slim items

Every item with only its identifying fields and images; a smaller alternative to /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
    classification
    Type
    string
    Description
    Item classification.
  • Name
    tags
    Type
    array of values
    Description
    Item tags.
  • Name
    images
    Type
    object
    Description
    Image URLs (thumbnail, best, upscaled).

Request

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

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"
    }
  },
  {
    "id": 2,
    "type": "bazaar_map_piece",
    "name": "Ticket to the Burroughs Bazaar",
    "classification": "map_piece",
    "tags": [
      "map_piece"
    ],
    "images": {
      "thumbnail": "https://www.mousehuntgame.com/images/items/maps/45e053a16d858d237ab73e9a5dc77ba0.jpg",
      "best": "https://www.mousehuntgame.com/images/items/maps/45e053a16d858d237ab73e9a5dc77ba0.jpg",
      "upscaled": "https://i.mouse.rip/upscaled/45e053a16d858d237ab73e9a5dc77ba0.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 response = await fetch('https://api.mouse.rip/items-tradable')

Response

[
  {
    "id": 103,
    "type": "maki_cheese",
    "name": "Maki Cheese",
    "image": "https://www.mousehuntgame.com/images/items/bait/large/c606cbeb8f98722fbb0ba7fe73930ec8.png",
    "truncated_name": "Maki Cheese"
  },
  {
    "id": 105,
    "type": "moon_cheese",
    "name": "Moon Cheese",
    "image": "https://www.mousehuntgame.com/images/items/bait/large/0d69edd56ca4ff2a1919654b4104013b.png",
    "truncated_name": "Moon Cheese"
  },
  ...
]

Get item abbreviations

The names hunters use for items, keyed by item type. A term can name more than one item: some are shared abbreviations (ff is four cheeses) and some name a group (charm matches 12 weapons and bases, hal the four High Altitude Loot items). /search matches these terms.

Request

GET
https://api.mouse.rip/item-abbreviations
const response = await fetch('https://api.mouse.rip/item-abbreviations')

Response

{
  "acronym_weapon": [
    "acronym"
  ],
  "ambrosial_portal_weapon": [
    "amb"
  ],
  "arcane_blast_weapon": [
    "arby"
  ],
  ...
}

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 response = await fetch('https://api.mouse.rip/item-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"
  },
  {
    "id": 2,
    "type": "bazaar_map_piece",
    "image": "https://www.mousehuntgame.com/images/items/maps/45e053a16d858d237ab73e9a5dc77ba0.jpg",
    "thumb": "https://www.mousehuntgame.com/images/items/maps/45e053a16d858d237ab73e9a5dc77ba0.jpg"
  },
  ...
]

Get item names to IDs

A lookup map of item display name to item ID.

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 response = await fetch('https://api.mouse.rip/items-names-to-ids')

Response

{
  "Balack's Lantern": 1,
  "Ticket to the Burroughs Bazaar": 2,
  "Key to the Town of Digby": 3,
  ...
}

Get hidden Marketplace items

Items MouseHunt Improved hides in the Marketplace, each with id and name.

Request

GET
https://api.mouse.rip/marketplace-hidden-items
const response = await fetch('https://api.mouse.rip/marketplace-hidden-items')

Response

[
  {
    "id": 401,
    "name": "Halloween Basket"
  },
  {
    "id": 430,
    "name": "Wishing Well Basket"
  },
  ...
]

Get upscaled images

Higher resolution or transparent versions of game images, keyed by the original image's path under https://www.mousehuntgame.com/images/.

Request

GET
https://api.mouse.rip/upscaled-images
const response = await fetch('https://api.mouse.rip/upscaled-images')

Response

{
  "drawprizes/100sb.png": "items/bait/transparent_thumb/3a23203e08a847b23f7786b322b36f7a.png",
  "drawprizes/25sb.png": "items/bait/transparent_thumb/3a23203e08a847b23f7786b322b36f7a.png",
  "drawprizes/500sb.png": "items/bait/transparent_thumb/3a23203e08a847b23f7786b322b36f7a.png",
  ...
}