api.mouse.rip

Catch Rate

Work out the chance of catching a mouse from your trap's power, luck, and power type.

Get catch rates

GEThttps://api.mouse.rip/catch-rate

The chance a trap catches a mouse, using the community's catch rate formula:

catch rate = min(1, (E·P + 2·⌊min(E, 1.4)·L⌋²) / (E·P + M))

where E is the trap's effectiveness against the mouse (1 = 100%), P the trap's power, L its luck, and M the mouse's power.

Pass your trap's total power and luck (as shown in game) and its power_type, then either:

  • mouse for one mouse,
  • mice (comma-separated) for several, or
  • location and cheese (plus stage, charm, and source if more than one setup matches) for every mouse that setup attracts, with an overall_catch_rate weighted by attraction rate.

Effectiveness and mouse power come from community data, so treat the results as estimates.

Query parameters

  • Name
    power_type
    Type
    string
    Description
    The trap's power type, e.g. hydro (see /power-types).
  • Name
    power
    Type
    number
    Description
    The trap's total power.
  • Name
    luck
    Type
    number
    Description
    The trap's total luck.
  • Name
    mouse
    Type
    string
    Description
    A mouse ID or type.
  • Name
    mice
    Type
    string
    Description
    Comma-separated mouse IDs or types.
  • Name
    location
    Type
    string
    Description
    A location slug, to rate everything a setup attracts (see /attraction). Needs cheese.
  • Name
    cheese
    Type
    string
    Description
    With location: the cheese type.
  • Name
    stage
    Type
    string
    Description
    With location: the stage, if the location has more than one.
  • Name
    charm
    Type
    string
    Description
    With location: the charm type. Defaults to - (none).
  • Name
    source
    Type
    string
    Description
    With location: mh-tools or mhct, if both have the setup.

Properties

  • Name
    power_type
    Type
    string
    Description
    The power type used.
  • Name
    power
    Type
    number
    Description
    The trap power used.
  • Name
    luck
    Type
    number
    Description
    The trap luck used.
  • Name
    mouse
    Type
    object
    Description
    The mouse's id, type, and name.
  • Name
    effectiveness
    Type
    integer
    Description
    The power type's effectiveness against the mouse, as a percentage (0 means it can't be caught).
  • Name
    mouse_power
    Type
    number
    Description
    The mouse's power.
  • Name
    catch_rate
    Type
    number
    Description
    The chance of catching the mouse, from 0 to 1.
  • Name
    minluck
    Type
    integer
    Description
    The luck that catches the mouse every time with this power type, or null if it can't be caught.
  • Name
    guaranteed
    Type
    boolean
    Description
    Whether luck is at least the minluck.
  • Name
    attraction_rate
    Type
    number
    Description
    With location: how often the setup attracts the mouse, as a percentage.
  • Name
    setup
    Type
    object
    Description
    With location: the attraction setup used (location, stage, cheese, charm, source, sample_size).
  • Name
    overall_catch_rate
    Type
    number
    Description
    With location: the chance of catching whatever the setup attracts, from 0 to 1.
  • Name
    mice
    Type
    array of object
    Description
    With mice or location: one entry per mouse.
  • Name
    mouse
    Type
    object
    Description
    The mouse's id, type, and name.
  • Name
    effectiveness
    Type
    integer
    Description
    The power type's effectiveness against the mouse, as a percentage (0 means it can't be caught).
  • Name
    mouse_power
    Type
    number
    Description
    The mouse's power.
  • Name
    catch_rate
    Type
    number
    Description
    The chance of catching the mouse, from 0 to 1.
  • Name
    minluck
    Type
    integer
    Description
    The luck that catches the mouse every time with this power type, or null if it can't be caught.
  • Name
    guaranteed
    Type
    boolean
    Description
    Whether luck is at least the minluck.
  • Name
    attraction_rate
    Type
    number
    Description
    With location: how often the setup attracts the mouse, as a percentage.

Request

GET
https://api.mouse.rip/catch-rate?mouse=abominable_snow&power=1000&luck=10&power_type=hydro
const response = await fetch('https://api.mouse.rip/catch-rate?mouse=abominable_snow&power=1000&luck=10&power_type=hydro')

Response

{
  "power_type": "hydro",
  "power": 1000,
  "luck": 10,
  "mouse": {
    "id": 1,
    "type": "abominable_snow",
    "name": "Abominable Snow Mouse"
  },
  "effectiveness": 100,
  "mouse_power": 1900,
  "catch_rate": 0.4138,
  "minluck": 31,
  "guaranteed": false
}