MHCT

These endpoints surface community-collected data from MouseHunt Community Tools (MHCT). Live endpoints are cached for several hours.


Get mouse attraction rates

Live attraction rates for a mouse, by location, stage, and cheese. Replace :id with the mouse type or ID.

You can append a time filter to the ID, e.g. /mhct/948-3_months. The default is all_time.

Properties

  • Name
    location
    Type
    string
    Description

    Location name.

  • Name
    stage
    Type
    string
    Description

    Location stage, or null when not applicable.

  • Name
    cheese
    Type
    string
    Description

    Cheese used.

  • Name
    total_hunts
    Type
    integer
    Description

    Number of hunts the rate is based on.

  • Name
    rate
    Type
    integer
    Description

    Attraction rate out of 10,000 (divide by 100 for a percentage).

Request

GET
https://api.mouse.rip/mhct/:id
const rates = await fetch('https://api.mouse.rip/mhct/948')
console.log(rates)

Response

[
  {
    "location": "Prickly Plains",
    "stage": null,
    "total_hunts": 12500,
    "rate": 10000,
    "cheese": "Flamin' Queso"
  }
]

Get item drop rates

Live drop rates for an item, by location, stage, and cheese. Replace :id with the item type or ID.

Properties

  • Name
    location
    Type
    string
    Description

    Location name.

  • Name
    stage
    Type
    string
    Description

    Location stage, or null when not applicable.

  • Name
    cheese
    Type
    string
    Description

    Cheese used.

  • Name
    total_hunts
    Type
    integer
    Description

    Number of hunts the rate is based on.

  • Name
    total_catches
    Type
    integer
    Description

    Number of catches in the sample.

  • Name
    total_drops
    Type
    integer
    Description

    Number of drops in the sample.

  • Name
    drop_pct
    Type
    string
    Description

    Drop rate as a percentage.

  • Name
    min_amt
    Type
    integer
    Description

    Minimum quantity dropped.

  • Name
    max_amt
    Type
    integer
    Description

    Maximum quantity dropped.

Request

GET
https://api.mouse.rip/mhct-item/:id
const drops = await fetch('https://api.mouse.rip/mhct-item/3058')
console.log(drops)

Response

[
  {
    "location": "Floating Islands",
    "stage": "Low Tier Loot",
    "cheese": "Cloudy Cheesecake",
    "total_hunts": 8000,
    "total_catches": 6200,
    "total_drops": 1240,
    "drop_pct": "20.00",
    "min_amt": 1,
    "max_amt": 3
  }
]

Get convertible contents

The possible rewards (and odds) from opening a convertible item. Replace :id with the item type or ID.

Properties

  • Name
    id
    Type
    integer
    Description

    Reward item ID (0 if unknown).

  • Name
    name
    Type
    string
    Description

    Reward item name.

  • Name
    min
    Type
    integer
    Description

    Minimum quantity awarded.

  • Name
    max
    Type
    integer
    Description

    Maximum quantity awarded.

  • Name
    chance
    Type
    string
    Description

    Chance of receiving the reward, as a percentage.

Request

GET
https://api.mouse.rip/convertible/:id
const rewards = await fetch('https://api.mouse.rip/convertible/super_brie_cheese')
console.log(rewards)

Response

[
  {
    "id": 114,
    "name": "SUPER|brie+",
    "min": 70,
    "max": 70,
    "chance": "100.00"
  }
]

Get MHCT mappings

Maps mouse.rip IDs to the IDs MHCT uses internally. Used by the other MHCT endpoints to translate IDs.

Properties

  • Name
    mice
    Type
    object
    Description

    Mouse ID → MHCT mouse ID.

  • Name
    items
    Type
    object
    Description

    Item ID → MHCT item ID.

  • Name
    type
    Type
    object
    Description

    Type slug → ID mappings.

Request

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

Response

{
  "items": { "1267": "1281", "2027": "2026" },
  "mice": { "...": "..." },
  "type": { "...": "..." }
}

Get all convertibles

A bulk dump of every convertible item and its possible contents. For a single convertible, prefer /convertible/:id.

Properties

  • Name
    id
    Type
    integer
    Description

    Item ID.

  • Name
    type
    Type
    string
    Description

    Item type (slug).

  • Name
    mhct_id
    Type
    integer
    Description

    MHCT item ID.

  • Name
    name
    Type
    string
    Description

    Item name.

  • Name
    convertibles
    Type
    array
    Description

    Possible rewards, each with item, min_item_quantity, max_item_quantity, single_opens, and times_with_any.

Request

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

Response

[
  {
    "id": 805,
    "type": "valentines_2012_gift_basket_convertible",
    "mhct_id": 805,
    "name": "<3 Gift Basket",
    "convertibles": [
      {
        "item": "super_brie_cheese",
        "min_item_quantity": 70,
        "max_item_quantity": 70,
        "single_opens": 20,
        "times_with_any": 20
      }
    ]
  }
]

Get reverse convertibles

The inverse of /mhct-convertibles — for each reward item, the convertibles it can come from.

Properties

  • Name
    id
    Type
    string
    Description

    Item ID.

  • Name
    type
    Type
    string
    Description

    Item type (slug).

  • Name
    mhct_id
    Type
    integer
    Description

    MHCT item ID.

  • Name
    name
    Type
    string
    Description

    Item name.

  • Name
    convertibles
    Type
    array
    Description

    Convertibles this item drops from, each with convertible, total, total_items, single_opens, times_with_any, and quantity fields.

Request

GET
https://api.mouse.rip/mhct-reverse-convertibles
const reverse = await fetch('https://api.mouse.rip/mhct-reverse-convertibles')
console.log(reverse)

Response

[
  {
    "id": "114",
    "type": "super_brie_cheese",
    "mhct_id": 114,
    "name": "SUPER|brie+",
    "convertibles": [
      {
        "convertible": "valentines_2012_gift_basket_convertible",
        "total": 1400,
        "total_items": 1,
        "single_opens": 20,
        "times_with_any": 20,
        "min_item_quantity": 70,
        "max_item_quantity": 70,
        "total_quantity_when_any": 1400
      }
    ]
  }
]

Get mapper

For each treasure map, the mice that appear on it along with attraction rates.

Properties

  • Name
    mhct_id
    Type
    integer
    Description

    MHCT map ID.

  • Name
    name
    Type
    string
    Description

    Map name.

  • Name
    mice
    Type
    array
    Description

    Mice on the map, each with id, type, name, rate (out of 10,000), seen, and total.

Request

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

Response

[
  {
    "mhct_id": 145,
    "name": "10th Birthday Event Map",
    "mice": [
      { "id": 18, "type": "birthday", "name": "Birthday", "rate": 10000, "seen": 10, "total": 10 }
    ]
  }
]

Get reverse mapper

For each mouse, the maps it can appear on along with appearance rates.

Properties

  • Name
    id
    Type
    integer
    Description

    Mouse ID.

  • Name
    type
    Type
    string
    Description

    Mouse type (slug).

  • Name
    mhct_id
    Type
    integer
    Description

    MHCT mouse ID.

  • Name
    name
    Type
    string
    Description

    Mouse name.

  • Name
    maps
    Type
    array
    Description

    Maps the mouse appears on, each with map, rate (out of 10,000), seen, and total.

Request

GET
https://api.mouse.rip/mhct-reverse-mapper
const reverseMapper = await fetch('https://api.mouse.rip/mhct-reverse-mapper')
console.log(reverseMapper)

Response

[
  {
    "id": 903,
    "type": "thunderlord",
    "mhct_id": 1040,
    "name": "Thunderlord",
    "maps": [
      { "map": "Origin of Dragons Map", "rate": 10000, "seen": 14383, "total": 14383 }
    ]
  }
]

MHCT redirects

Convenience redirects to the relevant page on mhct.win. These return an HTML redirect rather than JSON.

  • /mhct-redirect/:id — mouse attraction page for a mouse.
  • /mhct-redirect-item/:id — loot page for an item.

Replace :id with the mouse or item type or ID.

Request

GET
https://api.mouse.rip/mhct-redirect/:id
// Opens the MHCT attraction page for the mouse
window.location = 'https://api.mouse.rip/mhct-redirect/948'

// Opens the MHCT loot page for the item
window.location = 'https://api.mouse.rip/mhct-redirect-item/3058'

Response

302 redirect to the matching mhct.win page.