Maps

Data about treasure maps: which maps a scroll case opens, the chests they award, and which maps a mouse can appear on.

Get maps for a mouse

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

The treasure maps a mouse can appear on, from MHCT. Only maps where the mouse was seen at least 5 times are returned, and retired maps are left out unless include_retired=true. Replace :id with the mouse type or ID.

Query parameters

Name
include_retired
Type
boolean
Description
Include retired content: maps and items MHCT marks (Retired), and items the game marks inactive or removed. Left out by default.

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/map/mouse/948

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

Response

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

Get map relations

GEThttps://api.mouse.rip/map/relations

Every scroll case, the treasure map it opens into, and the chests that map awards. For one scroll case, map, or chest, use /map/relations/:id.

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 of values
Description
The treasure chests the map awards, each with id, type, name, and rare.

Request

GET

https://api.mouse.rip/map/relations/chrome_scroll_case_convertible

const response = await fetch('https://api.mouse.rip/map/relations/chrome_scroll_case_convertible')

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
      }
    ]
  },
  {
    "scrollCase": {
      "id": 2378,
      "type": "chrome_scroll_case_convertible",
      "name": "Chrome Scroll Case"
    },
    "map": {
      "name": "Medium Chrome Map",
      "mhctId": 83
    },
    "chests": [
      {
        "id": 2377,
        "type": "chrome_medium_treasure_chest_convertible",
        "name": "Medium Chrome Treasure Chest",
        "rare": false
      },
      {
        "id": 2384,
        "type": "rare_chrome_medium_treasure_chest_convertible",
        "name": "Rare Medium Chrome Treasure Chest",
        "rare": true
      }
    ]
  },
  ...
]

Map relations for one scroll case, map or chest

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

Accepts a scroll case or chest type or item ID, a map's MHCT ID, or a map name or slug.

Request

GET

https://api.mouse.rip/map/relations/easy_map

const response = await fetch('https://api.mouse.rip/map/relations/easy_map')

Response

[
  {
    "scrollCase": {
      "id": 921,
      "type": "treasure_map_scroll_case_convertible",
      "name": "Relic Hunter Scroll Case"
    },
    "map": {
      "name": "Easy Map",
      "mhctId": 15
    },
    "chests": [
      {
        "id": 3792,
        "type": "easy_rh_treasure_chest_convertible",
        "name": "Easy Treasure Chest",
        "rare": false
      },
      {
        "id": 3799,
        "type": "rare_easy_rh_treasure_chest_convertible",
        "name": "Rare Easy Treasure Chest",
        "rare": true
      }
    ]
  }
]

Get community map data

GEThttps://api.mouse.rip/map/community

old lists the IDs of inactive community maps.

Request

GET

https://api.mouse.rip/map/community

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

Response

{
  "old": [
    7419733,
    7419715,
    ...
  ]
}

Get scrolls to maps

GEThttps://api.mouse.rip/map/scrolls

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

Properties

Name
[scroll]
Type
array of values
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/map/scrolls

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

Response

{
  "chrome_scroll_case_convertible": [
    {
      "name": "Easy Chrome Map",
      "mhctId": 87
    },
    {
      "name": "Medium Chrome Map",
      "mhctId": 83
    },
    ...
  ],
  "party_size_chrome_scroll_case_convertible": [
    {
      "name": "Party Size Easy Chrome Map",
      "mhctId": 90043
    },
    {
      "name": "Party Size Medium Chrome Map",
      "mhctId": 90045
    },
    ...
  ],
  "chrome_boss_scroll_case_convertible": [
    {
      "name": "Easy Chrome Slayer Map",
      "mhctId": 162
    },
    {
      "name": "Medium Chrome Slayer Map",
      "mhctId": 165
    },
    ...
  ],
  ...
}