Maps

Data about treasure maps — how mice are grouped on each map, which maps a scroll case opens, and which maps a given mouse can appear on.

Get map groups

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

The grouping of mice into categories for each map type. Useful for laying out a map's goals by region, power type, or theme.

Properties

Name
[map]
Type
object
Description
Keyed by map slug (e.g. sky_palace).
Name
[map].categories
Type
array
Description
The categories the map's mice are grouped into.
Name
[map].categories[].name
Type
string
Description
Category name.
Name
[map].categories[].id
Type
string
Description
Category ID.
Name
[map].categories[].icon
Type
string
Description
Category icon path.
Name
[map].categories[].color
Type
string
Description
Category color (hex).
Name
[map].categories[].mice
Type
array
Description
Mouse types in the category. Entries may be a type string or an object with extra detail.

Request

GET

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

const mapGroups = await fetch('https://api.mouse.rip/map-groups')
console.log(mapGroups)

Response

{
  "sky_palace": {
    "categories": [
      {
        "name": "Arcane",
        "id": "esp-arcane",
        "icon": "/powertypes/arcane.png",
        "color": "#b4ffff",
        "mice": ["sky_dancer", "sky_glass_glazier", "sky_glass_sorcerer"]
      }
    ]
  }
}

Get scrolls to maps

GEThttps://api.mouse.rip/scrolls-to-maps

Maps each scroll case to the treasure maps it can open, with the MHCT ID for each map.

Properties

Name
[scroll]
Type
array
Description
Keyed by scroll case type (slug).
Name
[scroll][].name
Type
string
Description
Map name.
Name
[scroll][].mhctId
Type
integer
Description
MHCT ID for the map.

Request

GET

https://api.mouse.rip/scrolls-to-maps

const scrollsToMaps = await fetch('https://api.mouse.rip/scrolls-to-maps')
console.log(scrollsToMaps)

Response

{
  "chrome_scroll_case_convertible": [
    { "name": "Easy Chrome Map", "mhctId": 87 },
    { "name": "Medium Chrome Map", "mhctId": 83 },
    { "name": "Hard Chrome Map", "mhctId": 85 }
  ]
}

Get maps for a mouse

GEThttps://api.mouse.rip/maps-for-mouse/:id

The treasure maps a mouse can appear on, sourced from MHCT. Only maps with a meaningful sample size are returned. Replace :id with the mouse type or ID.

Properties

Name
map
Type
string
Description
Map name.
Name
rate
Type
integer
Description
Appearance rate out of 10,000 (divide by 100 for a percentage).
Name
seen_maps
Type
integer
Description
Number of sampled maps the mouse was seen on.
Name
total_maps
Type
integer
Description
Total number of sampled maps.

Request

GET

https://api.mouse.rip/maps-for-mouse/:id

const maps = await fetch('https://api.mouse.rip/maps-for-mouse/948')
console.log(maps)

Response

[
  {
    "map": "Prickly Plains Map",
    "rate": 5000,
    "seen_maps": 120,
    "total_maps": 240
  }
]

Get map relations

GEThttps://api.mouse.rip/map-relations/:id?

Ties together each scroll case, the treasure map it opens into, and the chests that map awards. Omit :id for every relation, or pass a scroll case type or item ID, a chest type or item ID, a map's MHCT ID, or a map name to filter.

Properties

Name
scrollCase
Type
object
Description
The scroll case, with id, type, and name.
Name
map
Type
object
Description
The map the scroll case opens into, with name and mhctId.
Name
chests
Type
array
Description
The treasure chests the map awards, each with id, type, name, and rare.

Request

GET

https://api.mouse.rip/map-relations/:id

const mapRelations = await fetch('https://api.mouse.rip/map-relations/chrome_scroll_case_convertible')
console.log(mapRelations)

Response

[
  {
    "scrollCase": {
      "id": 2378,
      "type": "chrome_scroll_case_convertible",
      "name": "Chrome Scroll Case"
    },
    "map": {
      "name": "Easy Chrome Map",
      "mhctId": 87
    },
    "chests": [
      {
        "id": 2373,
        "type": "chrome_easy_treasure_chest_convertible",
        "name": "Easy Chrome Treasure Chest",
        "rare": false
      },
      {
        "id": 2380,
        "type": "rare_chrome_easy_treasure_chest_convertible",
        "name": "Rare Easy Chrome Treasure Chest",
        "rare": true
      }
    ]
  },
  ...
]