Mice - MouseHunt API Reference

Get mouse by ID

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

Query parameters

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

Properties

Name
id
Type
integer
Description
Name
type
Type
string
Description
Mouse type (slug).
Name
name
Type
string
Description
Name
abbreviated_name
Type
string
Description
Name
description
Type
string
Description
Name
points
Type
integer
Description
Points awarded for catching the mouse.
Name
points_formatted
Type
string
Description
Points, comma-formatted.
Name
gold
Type
integer
Description
Gold awarded for catching the mouse.
Name
gold_formatted
Type
string
Description
Gold, comma-formatted.
Name
group
Type
string
Description
Group name, e.g. Mountain Mice.
Name
group_id
Type
string
Description
Group type, e.g. mountain.
Name
subgroup
Type
string
Description
Subgroup name. Empty if none.
Name
subgroup_id
Type
string
Description
Subgroup type. Empty if none.
Name
images
Type
object
Description
Name
thumbnail
Type
string
Description
Name
silhouette_thumbnail
Type
string
Description
Name
medium
Type
string
Description
Name
silhouette_medium
Type
string
Description
Name
large
Type
string
Description
Name
silhouette_large
Type
string
Description
Name
square
Type
string
Description
Name
is_landscape
Type
boolean
Description

Get power type mastery for a power type or mouse

GEThttps://api.mouse.rip/mice-powertype-mastery/:id

Pass a power type (e.g. arcane) to get its mice, or a mouse's ID or type to get the power type it counts toward.

Request

GET

https://api.mouse.rip/mice-powertype-mastery/thunderlord

const response = await fetch('https://api.mouse.rip/mice-powertype-mastery/thunderlord')

Response

{
  "id": 903,
  "type": "thunderlord",
  "power_type": "draconic"
}

Get power type mastery mice

GEThttps://api.mouse.rip/mice-powertype-mastery

Mouse types (slugs) that count toward each power type's mastery, keyed by power type.

Request

GET

https://api.mouse.rip/mice-powertype-mastery

const response = await fetch('https://api.mouse.rip/mice-powertype-mastery')

Response

{
  "arcane": [
    "gargoyle",
    "gate_guardian",
    ...
  ],
  "draconic": [
    "draconic_warden",
    "dragon",
    ...
  ],
  "event": [
    "birthday",
    "candy_cane",
    ...
  ],
  "forgotten": [
    "acolyte",
    "balack_the_banished",
    ...
  ],
  "hydro": [
    "alchemist",
    "alnitak",
    ...
  ],
  "law": [
    "burglar",
    "master_burglar",
    ...
  ],
  "multi": [
    "abominable_snow",
    "big_bad_burroughs",
    ...
  ],
  "physical": [
    "aged",
    "bandit",
    ...
  ],
  "rift": [
    "rift_bionic",
    "rift_brown",
    ...
  ],
  "shadow": [
    "aquos",
    "bat",
    ...
  ],
  "tactical": [
    "alnilam",
    "archer",
    ...
  ]
}

Get CRE mice groups

GEThttps://api.mouse.rip/cre-mice-groups

Groups of related mice used by the catch rate estimator.

Properties

Name
[group]
Type
array of values
Description
Keyed by group slug (e.g. dragon); each value is an array of mouse types.

Request

GET

https://api.mouse.rip/cre-mice-groups

const response = await fetch('https://api.mouse.rip/cre-mice-groups')

Response

{
  "dragon": [
    "dragon",
    "icewing",
    ...
  ],
  "fort_rox": {
    "cosmic": [
      "moonstone_slinger",
      "arcane_summoner",
      ...
    ],
    "weremice": [
      "good_supply_night",
      "werehauler",
      ...
    ]
  },
  "fiery_warpath": {
    "archers": [
      "desert_archer_weak",
      "desert_archer",
      ...
    ],
    "cavalry": [
      "desert_cavalry",
      "desert_cavalry_strong"
    ],
    "mages": [
      "desert_mage",
      "desert_mage_strong"
    ],
    "scouts": [
      "desert_scout_weak",
      "desert_scout",
      ...
    ],
    "warriors": [
      "desert_warrior_weak",
      "desert_warrior",
      ...
    ],
    "commanders": [
      "desert_general"
    ]
  },
  "sand_dunes": [
    "king_grub",
    "king_scarab"
  ],
  "rift_whisker_woods": [
    "rift_cyclops",
    "rift_centaur",
    ...
  ],
  "zugzwang_tower": {
    "mystic": [
      "mystic_bishop",
      "mystic_king",
      ...
    ],
    "technic": [
      "tech_bishop",
      "tech_king",
      ...
    ],
    "rooks": [
      "mystic_rook",
      "technic_rook"
    ]
  }
}

Get mice effectiveness values

GEThttps://api.mouse.rip/effs

Power type effectiveness percentages for each mouse, from the Minimum Luck Values spreadsheet.

/effs-raw has the unprocessed data, keyed by mouse name.

Properties

Name
id
Type
integer
Description
Mouse ID.
Name
type
Type
string
Description
Mouse type (slug).
Name
name
Type
string
Description
Mouse name.
Name
effectivenesses
Type
object
Description
Effectiveness value per power type (power, arcane, draconic, forgotten, hydro, parental, physical, shadow, tactical, law, rift).

Request

GET

https://api.mouse.rip/effs

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

Response

[
  {
    "id": 1,
    "type": "abominable_snow",
    "name": "Abominable Snow Mouse",
    "effectivenesses": {
      "power": 1900,
      "arcane": 100,
      "draconic": 100,
      "forgotten": 100,
      "hydro": 100,
      "physical": 100,
      "shadow": 100,
      "tactical": 100,
      "law": 100,
      "rift": 0
    }
  },
  {
    "id": 2,
    "type": "acolyte",
    "name": "Acolyte Mouse",
    "effectivenesses": {
      "power": 18000,
      "arcane": 25,
      "draconic": 0,
      "forgotten": 175,
      "hydro": 0,
      "physical": 0,
      "shadow": 25,
      "tactical": 0,
      "law": 0,
      "rift": 0
    }
  },
  ...
]

Get mice minlucks

GEThttps://api.mouse.rip/minlucks

The minimum luck that guarantees a catch with each power type, from the Minimum Luck Values spreadsheet.

/minlucks-raw has the unprocessed data, keyed by mouse name.

Properties

Name
id
Type
integer
Description
Mouse ID.
Name
type
Type
string
Description
Mouse type (slug).
Name
name
Type
string
Description
Mouse name.
Name
minlucks
Type
object
Description
Minluck per power type (arcane, draconic, forgotten, hydro, physical, shadow, tactical, law, rift). 0 means the mouse cannot be caught with that power type.

Request

GET

https://api.mouse.rip/minlucks

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

Response

[
  {
    "id": 1,
    "type": "abominable_snow",
    "name": "Abominable Snow Mouse",
    "minlucks": {
      "arcane": 31,
      "draconic": 31,
      "forgotten": 31,
      "hydro": 31,
      "physical": 31,
      "shadow": 31,
      "tactical": 31,
      "law": 31,
      "rift": 0
    }
  },
  {
    "id": 2,
    "type": "acolyte",
    "name": "Acolyte Mouse",
    "minlucks": {
      "arcane": 380,
      "draconic": 0,
      "forgotten": 68,
      "hydro": 0,
      "physical": 0,
      "shadow": 380,
      "tactical": 0,
      "law": 0,
      "rift": 0
    }
  },
  ...
]

Get mice wisdom

GEThttps://api.mouse.rip/wisdom

Wisdom for each mouse, from the MH Wisdom Values spreadsheet.

/wisdom-raw has the unprocessed data, keyed by mouse name.

Properties

Name
id
Type
integer
Description
Mouse ID.
Name
type
Type
string
Description
Mouse type (slug).
Name
name
Type
string
Description
Mouse name.
Name
wisdom
Type
integer
Description
Mouse wisdom.

Request

GET

https://api.mouse.rip/wisdom

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

Response

[
  {
    "id": 1,
    "type": "abominable_snow",
    "name": "Abominable Snow Mouse",
    "wisdom": 1000
  },
  {
    "id": 2,
    "type": "acolyte",
    "name": "Acolyte Mouse",
    "wisdom": 3185
  },
  ...
]

Get mice groups

GEThttps://api.mouse.rip/mice-groups

Every mouse group, with its description, banner image, and mouse_ids.

Properties

Name
id
Type
string
Description
Mouse group ID.
Name
name
Type
string
Description
Mouse group name.

Request

GET

https://api.mouse.rip/mice-groups

const response = await fetch('https://api.mouse.rip/mice-groups')

Response

[
  {
    "id": "common",
    "name": "Indigenous Mice",
    "display_order": 0,
    "description_short": "Commonly found throughout the Kingdom",
    "description": "Indigenous mice are most often found in the region of Gnawnia. Physical traps work best against indigenous mice, and they prefer normal flavours of cheese, s...",
    "banner": "https://www.mousehuntgame.com/images/mice/group_banners/common_640.jpg",
    "mouse_ids": [
      545,
      217,
      ...
    ]
  },
  {
    "id": "dock",
    "name": "Dock Dwellers",
    "display_order": 1,
    "description_short": "Bullion-seeking thieves that are scourge of the Harbour",
    "description": "Blimey! These pirates are frequently found harassing ships at the Harbour in search of valuable cargo to steal.",
    "banner": "https://www.mousehuntgame.com/images/mice/group_banners/dock_640.jpg",
    "mouse_ids": [
      860,
      862,
      ...
    ]
  },
  ...
]

Get mice regions

GEThttps://api.mouse.rip/mice-regions

Every region and the mouse_ids of its mice.

Properties

Name
id
Type
string
Description
Mouse region ID.
Name
name
Type
string
Description
Mouse region name.

Request

GET

https://api.mouse.rip/mice-regions

const response = await fetch('https://api.mouse.rip/mice-regions')

Response

[
  {
    "id": "winter_hunt_grove",
    "name": "Cinnamon Hill",
    "mouse_ids": [
      680,
      27,
      ...
    ]
  },
  {
    "id": "winter_hunt_workshop",
    "name": "Golem Workshop",
    "mouse_ids": [
      680,
      295,
      ...
    ]
  },
  ...
]

Get mice thumbnails

GEThttps://api.mouse.rip/mice-thumbnails

A lightweight list of every mouse and its image URLs.

Properties

Name
id
Type
integer
Description
Mouse ID.
Name
type
Type
string
Description
Mouse type (slug).
Name
thumb
Type
string
Description
Thumbnail image URL.
Name
large
Type
string
Description
Large image URL.
Name
square
Type
string
Description
Square image URL.

Request

GET

https://api.mouse.rip/mice-thumbnails

const response = await fetch('https://api.mouse.rip/mice-thumbnails')

Response

[
  {
    "id": 1,
    "type": "abominable_snow",
    "square": "https://www.mousehuntgame.com/images/mice/square/06ac7ccf66820ff45e337b23d6bc05b0_voverhall.jpg",
    "large": "https://www.mousehuntgame.com/images/mice/large/190dfb893cea33795a15054183ad4cc8_voverhall.jpg",
    "thumb": "https://www.mousehuntgame.com/images/mice/thumb/321f0b701764a7ad3cf9d04bf42d2d36_voverhall.gif"
  },
  {
    "id": 2,
    "type": "acolyte",
    "square": "https://www.mousehuntgame.com/images/mice/square/186735e39cbd9430f80c616902980492.jpg",
    "large": "https://www.mousehuntgame.com/images/mice/large/ea009182f66232f6fe9fb7d4deffe502.jpg",
    "thumb": "https://www.mousehuntgame.com/images/mice/thumb/a672a508c1007c9741f83faeb438f2a4.gif"
  },
  ...
]

Get mice silhouettes

GEThttps://api.mouse.rip/mice-silhouettes

Every mouse's silhouette image URLs, plus its full-art image.

Properties

Name
id
Type
integer
Description
Mouse ID.
Name
type
Type
string
Description
Mouse type (slug).
Name
large
Type
string
Description
Large silhouette image URL.
Name
medium
Type
string
Description
Medium silhouette image URL.
Name
art
Type
string
Description
Full-art (non-silhouette) image URL.

Request

GET

https://api.mouse.rip/mice-silhouettes

const response = await fetch('https://api.mouse.rip/mice-silhouettes')

Response

[
  {
    "id": 1,
    "type": "abominable_snow",
    "large": "https://www.mousehuntgame.com/images/mice/silhouette_large/58a119943b8dc4a132438b8c19f1b83b_voverhall.jpg",
    "medium": "https://www.mousehuntgame.com/images/mice/silhouette_medium/0ec05f2f974673f7897ddd9302c4f17e_voverhall.jpg",
    "art": "https://www.mousehuntgame.com/images/mice/large/190dfb893cea33795a15054183ad4cc8_voverhall.jpg"
  },
  {
    "id": 2,
    "type": "acolyte",
    "large": "https://www.mousehuntgame.com/images/mice/silhouette_large/6be8356f8d13da7f28ec66a26ff07a0e.jpg",
    "medium": "https://www.mousehuntgame.com/images/mice/silhouette_medium/96b080c4e196f239c4c5538529992c83.jpg",
    "art": "https://www.mousehuntgame.com/images/mice/large/ea009182f66232f6fe9fb7d4deffe502.jpg"
  },
  ...
]