Mice

Data about every mouse in the game. The mice and mouse paths are interchangeable, and any endpoint that takes an :id accepts either the numeric ID or the mouse type (slug).


Get all mice

Properties

  • Name
    id
    Type
    integer
    Description
    Mouse ID.
  • Name
    type
    Type
    string
    Description
    Mouse type (slug).
  • Name
    name
    Type
    string
    Description
    Mouse name.
  • Name
    abbreviated_name
    Type
    string
    Description
    Abbreviated mouse name.
  • Name
    description
    Type
    string
    Description
    Mouse 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
    Mouse group.
  • Name
    subgroup
    Type
    string
    Description
    Mouse subgroup.
  • Name
    images
    Type
    object
    Description
  • Name
    thumbnail
    Type
    string
    Description
    Thumbnail image.
  • Name
    silhouette_thumbnail
    Type
    string
    Description
    Silhouette thumbnail image.
  • Name
    medium
    Type
    string
    Description
    Medium image.
  • Name
    silhouette_medium
    Type
    string
    Description
    Silhouette medium image.
  • Name
    large
    Type
    string
    Description
    Large image.
  • Name
    silhouette_large
    Type
    string
    Description
    Silhouette large image.
  • Name
    square
    Type
    string
    Description
    Square image.
  • Name
    is_landscape
    Type
    boolean
    Description
    Whether the image is landscape.
  • Name
    has_weaknesses
    Type
    boolean
    Description
    Whether the mouse has any effective weaknesses.
  • Name
    weaknesses
    Type
    object
    Description
  • Name
    effective
    Type
    array
    Description
    Power types the mouse is weak to.
  • Name
    minlucks
    Type
    object
    Description
  • Name
    arcane
    Type
    integer
    Description
    Arcane minluck.
  • Name
    draconic
    Type
    integer
    Description
    Draconic minluck.
  • Name
    forgotten
    Type
    integer
    Description
    Forgotten minluck.
  • Name
    hydro
    Type
    integer
    Description
    Hydro minluck.
  • Name
    physical
    Type
    integer
    Description
    Physical minluck.
  • Name
    shadow
    Type
    integer
    Description
    Shadow minluck.
  • Name
    tactical
    Type
    integer
    Description
    Tactical minluck.
  • Name
    law
    Type
    integer
    Description
    Law minluck.
  • Name
    rift
    Type
    integer
    Description
    Rift minluck.
  • Name
    wisdom
    Type
    integer
    Description
    Mouse wisdom.
  • Name
    effectivenesses
    Type
    object
    Description
  • Name
    power
    Type
    integer
    Description
    Power effectiveness value.
  • Name
    arcane
    Type
    integer
    Description
    Arcane effectiveness value.
  • Name
    draconic
    Type
    integer
    Description
    Draconic effectiveness value.
  • Name
    forgotten
    Type
    integer
    Description
    Forgotten effectiveness value.
  • Name
    hydro
    Type
    integer
    Description
    Hydro effectiveness value.
  • Name
    physical
    Type
    integer
    Description
    Physical effectiveness value.
  • Name
    shadow
    Type
    integer
    Description
    Shadow effectiveness value.
  • Name
    tactical
    Type
    integer
    Description
    Tactical effectiveness value.
  • Name
    law
    Type
    integer
    Description
    Law effectiveness value.
  • Name
    rift
    Type
    integer
    Description
    Rift effectiveness value.
  • Request

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

    Response

    [
      {
        "id": 958,
        "type": "glazed",
        "name": "Glazy Mouse",
        "abbreviated_name": "Glazy",
        "description": "Now here's a guy who knows how to enjoy the holidays! ...",
        "points": 50000,
        "points_formatted": "50,000",
        "gold": 10000,
        "gold_formatted": "10,000",
        "group": "Event Mice",
        "subgroup": "Great Winter Hunt",
        "images": {
          "thumbnail": "",
          "silhouette_thumbnail": "https://www.mousehuntgame.com/images/mice/silhouette_thumb/9b953ab270bc8f746fb4aab19ea30f8e.gif?cv=2",
          "medium": "https://www.mousehuntgame.com/images/mice/medium/f0e7f93e6599526a427b418f35064a9b.jpg?cv=2",
          "silhouette_medium": "https://www.mousehuntgame.com/images/mice/silhouette_medium/51093497ebab70fd4fc3b20aff68a41d.jpg?cv=2",
          "large": "https://www.mousehuntgame.com/images/mice/large/3e34b94eef104d099d0dd3c2166baef7.jpg?cv=2",
          "silhouette_large": "https://www.mousehuntgame.com/images/mice/silhouette_large/0dbc988470eb1d6157fe122713daa521.jpg?cv=2",
          "square": "https://www.mousehuntgame.com/images/mice/square/baab211c67d0a5e9914c8e832c8ad7a9.jpg?cv=2",
          "is_landscape": false
        },
        "has_weaknesses": true,
        "weaknesses": {
          "effective": ["Physical", "Shadow", "Tactical", "Arcane", "Forgotten", "Hydro", "Draconic", "Law", "Rift"]
        },
        "minlucks": {
          "arcane": 1, "draconic": 1, "forgotten": 1, "hydro": 1,
          "physical": 1, "shadow": 1, "tactical": 1, "law": 1, "rift": 1
        },
        "wisdom": 3600,
        "effectivenesses": {
          "power": 2, "arcane": 100, "draconic": 100, "forgotten": 100,
          "hydro": 100, "parental": 0, "physical": 100, "shadow": 100,
          "tactical": 100, "law": 100, "rift": 100
        }
      }
    ]
    

    Get mouse by ID

    Replace :id with the mouse type or ID.

    Properties

    • Name
      id
      Type
      integer
      Description
      Mouse ID.
    • Name
      type
      Type
      string
      Description
      Mouse type (slug).
    • Name
      name
      Type
      string
      Description
      Mouse name.
    • Name
      abbreviated_name
      Type
      string
      Description
      Abbreviated mouse name.
    • Name
      description
      Type
      string
      Description
      Mouse 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
      Mouse group.
    • Name
      subgroup
      Type
      string
      Description
      Mouse subgroup.
    • Name
      images
      Type
      object
      Description
    • Name
      thumbnail
      Type
      string
      Description
      Thumbnail image.
    • Name
      silhouette_thumbnail
      Type
      string
      Description
      Silhouette thumbnail image.
    • Name
      medium
      Type
      string
      Description
      Medium image.
    • Name
      silhouette_medium
      Type
      string
      Description
      Silhouette medium image.
    • Name
      large
      Type
      string
      Description
      Large image.
    • Name
      silhouette_large
      Type
      string
      Description
      Silhouette large image.
    • Name
      square
      Type
      string
      Description
      Square image.
    • Name
      is_landscape
      Type
      boolean
      Description
      Whether the image is landscape.
  • Name
    has_weaknesses
    Type
    boolean
    Description
    Whether the mouse has any effective weaknesses.
  • Name
    weaknesses
    Type
    object
    Description
  • Name
    effective
    Type
    array
    Description
    Power types the mouse is weak to.
  • Name
    minlucks
    Type
    object
    Description
  • Name
    arcane
    Type
    integer
    Description
    Arcane minluck.
  • Name
    draconic
    Type
    integer
    Description
    Draconic minluck.
  • Name
    forgotten
    Type
    integer
    Description
    Forgotten minluck.
  • Name
    hydro
    Type
    integer
    Description
    Hydro minluck.
  • Name
    physical
    Type
    integer
    Description
    Physical minluck.
  • Name
    shadow
    Type
    integer
    Description
    Shadow minluck.
  • Name
    tactical
    Type
    integer
    Description
    Tactical minluck.
  • Name
    law
    Type
    integer
    Description
    Law minluck.
  • Name
    rift
    Type
    integer
    Description
    Rift minluck.
  • Name
    wisdom
    Type
    integer
    Description
    Mouse wisdom.
  • Name
    effectivenesses
    Type
    object
    Description
  • Name
    power
    Type
    integer
    Description
    Power effectiveness value.
  • Name
    arcane
    Type
    integer
    Description
    Arcane effectiveness value.
  • Name
    draconic
    Type
    integer
    Description
    Draconic effectiveness value.
  • Name
    forgotten
    Type
    integer
    Description
    Forgotten effectiveness value.
  • Name
    hydro
    Type
    integer
    Description
    Hydro effectiveness value.
  • Name
    physical
    Type
    integer
    Description
    Physical effectiveness value.
  • Name
    shadow
    Type
    integer
    Description
    Shadow effectiveness value.
  • Name
    tactical
    Type
    integer
    Description
    Tactical effectiveness value.
  • Name
    law
    Type
    integer
    Description
    Law effectiveness value.
  • Name
    rift
    Type
    integer
    Description
    Rift effectiveness value.
  • Request

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

    Response

    {
      "id": 958,
      "type": "glazed",
      "name": "Glazy Mouse",
      "abbreviated_name": "Glazy",
      "description": "Now here's a guy who knows how to enjoy the holidays! ...",
      "points": 50000,
      "points_formatted": "50,000",
      "gold": 10000,
      "gold_formatted": "10,000",
      "group": "Event Mice",
      "subgroup": "Great Winter Hunt",
      "images": { "...": "see /mice above" },
      "has_weaknesses": true,
      "weaknesses": {
        "effective": ["Physical", "Shadow", "Tactical", "Arcane", "Forgotten", "Hydro", "Draconic", "Law", "Rift"]
      },
      "minlucks": {
        "arcane": 1, "draconic": 1, "forgotten": 1, "hydro": 1,
        "physical": 1, "shadow": 1, "tactical": 1, "law": 1, "rift": 1
      },
      "wisdom": 3600,
      "effectivenesses": {
        "power": 2, "arcane": 100, "draconic": 100, "forgotten": 100,
        "hydro": 100, "parental": 0, "physical": 100, "shadow": 100,
        "tactical": 100, "law": 100, "rift": 100
      }
    }
    

    Get mice minlucks

    The minimum luck needed to guarantee a catch for each power type. Data source is the Minimum Luck Values spreadsheet.

    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 minlucks = await fetch('https://api.mouse.rip/minlucks')
    console.log(minlucks)
    

    Response

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

    Get mice wisdom

    Data source is the MH Wisdom Values spreadsheet.

    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 wisdom = await fetch('https://api.mouse.rip/wisdom')
    console.log(wisdom)
    

    Response

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

    Get mice effectiveness values

    Power-type effectiveness percentages for each mouse. Data source is the Minimum Luck Values spreadsheet.

    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 effs = await fetch('https://api.mouse.rip/effs')
    console.log(effs)
    

    Response

    [
      {
        "id": 1,
        "type": "abominable_snow",
        "name": "Abominable Snow Mouse",
        "effectivenesses": {
          "power": 1900, "arcane": 100, "draconic": 0, "forgotten": 100,
          "hydro": 100, "parental": 0, "physical": 100, "shadow": 100,
          "tactical": 100, "law": 100, "rift": 0
        }
      }
    ]
    

    Get mice attraction rates

    Community-sourced attraction rates (mhct.win) for each mouse, broken down by location and cheese. Rates are percentages.

    Properties

    • Name
      [type]
      Type
      object
      Description

      Keyed by mouse type. Each value is an object keyed by location.

    • Name
      [type][location]
      Type
      object
      Description

      Keyed by location slug. Each value is an object keyed by cheese, with the attraction rate (percent) as the value.

    Request

    GET
    https://api.mouse.rip/mice-attraction-rates
    const rates = await fetch('https://api.mouse.rip/mice-attraction-rates')
    console.log(rates)
    

    Response

    {
      "burglar": {
        "bazaar": {
          "super_brie_cheese": 20.28,
          "brie_cheese": 10.44,
          "gilded_cheese": 15.35
        },
        "kings_arms": {
          "gilded_cheese": 24.95,
          "super_brie_cheese": 5,
          "brie_cheese": 7.46
        }
      }
    }
    

    Get 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 thumbnails = await fetch('https://api.mouse.rip/mice-thumbnails')
    console.log(thumbnails)
    

    Response

    [
      {
        "id": 1,
        "type": "abominable_snow",
        "thumb": "https://www.mousehuntgame.com/images/mice/thumb/...gif",
        "large": "https://www.mousehuntgame.com/images/mice/large/...jpg",
        "square": "https://www.mousehuntgame.com/images/mice/square/...jpg"
      }
    ]
    

    Get mice silhouettes

    A lightweight list of every mouse with its silhouette image URLs, plus the full-art version for reveals.

    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 silhouettes = await fetch('https://api.mouse.rip/mice-silhouettes')
    console.log(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"
      }
    ]
    

    Get mice groups

    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 miceGroups = await fetch('https://api.mouse.rip/mice-groups')
    console.log(miceGroups)
    

    Response

    [
      { "id": "common", "name": "Indigenous Mice" },
      { "id": "dock", "name": "Dock Dwellers" },
      { "id": "mountain", "name": "Mountain Mice" }
    ]
    

    Get mice regions

    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 miceRegions = await fetch('https://api.mouse.rip/mice-regions')
    console.log(miceRegions)
    

    Response

    [
      { "id": "acolyte_realm", "name": "Acolyte Realm" },
      { "id": "balacks_cove", "name": "Balack's Cove" },
      { "id": "bazaar", "name": "Bazaar" }
    ]
    

    Get CRE mice groups

    Groupings of related mice used for catch rate estimation, keyed by group.

    Properties

    • Name
      [group]
      Type
      array
      Description

      Keyed by group slug (e.g. dragon). An array of the mouse types in the group.

    Request

    GET
    https://api.mouse.rip/cre-mice-groups
    const creMiceGroups = await fetch('https://api.mouse.rip/cre-mice-groups')
    console.log(creMiceGroups)
    

    Response

    {
      "dragon": [
        "dragon",
        "icewing",
        "drag_goon",
        ...
      ],
      ...
    }