Environments

Get all environments

GEThttps://api.mouse.rip/environments

Properties

Name
id
Type
string
Description
The environment ID.
Name
name
Type
string
Description
The environment name.
Name
article
Type
string
Description
The environment name with article.
Name
image
Type
string
Description
The environment image.
Name
headerImage
Type
string
Description
The environment header image.
Name
icon
Type
string
Description
The environment icon.
Name
region
Type
string
Description
The environment region.
Name
order
Type
integer
Description
The environment order.
Name
title
Type
string
Description
The title needed to be able to access the environment.
Name
title_formatted
Type
string
Description
Display name of the required title.
Name
environment_id
Type
integer
Description
The numeric environment ID used by the game.
Name
status
Type
string
Description
Whether the environment is currently active or inactive.
Name
description
Type
string
Description
The environment description, as plain text.

Request

GET

https://api.mouse.rip/environments

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

Response

[
  {
    "id": "meadow",
    "name": "Meadow",
    "article": "the Meadow",
    "image": "https://www.mousehuntgame.com/images/environments/a441eb078698da69ef2765983f4b5912.jpg?cv=2",
    "headerImage": "https://www.mousehuntgame.com/images/environments/6ef3ffe2f90a79250807b46105e77b68.jpg?cv=2",
    "icon": "https://www.mousehuntgame.com/images/environments/b1a5b70c94dc8f19f0e52468a16289b7.jpg",
    "region": "gnawnia",
    "order": 10,
    "title": "novice",
    "title_formatted": "Novice",
    "environment_id": 18,
    "status": "active",
    "description": "Slightly secluded from the human population, the Meadow is mostly inhabited by the more timid breeds of mice. ..."
  },
  {
    "id": "town_of_gnawnia",
    "name": "Town of Gnawnia",
    "article": "the Town of Gnawnia",
    "image": "https://www.mousehuntgame.com/images/environments/231c9b4d583f98c365efcbbd50fddb76_v2.jpg?cv=2",
    "headerImage": "https://www.mousehuntgame.com/images/environments/4f61abe7975e99a3c780c5fd895dc07c_v2.jpg?cv=2",
    "region": "gnawnia",
    "order": 11,
    "title": "recruit"
  },
  ...
]

Get event environments

GEThttps://api.mouse.rip/environments-events

Properties

Name
id
Type
string
Description
The environment ID.
Name
name
Type
string
Description
The environment name.
Name
article
Type
string
Description
The environment name with article.
Name
image
Type
string
Description
The environment image.
Name
headerImage
Type
string
Description
The environment header image.
Name
icon
Type
string
Description
The environment icon.
Name
region
Type
string
Description
The environment region.
Name
order
Type
integer
Description
The environment order.
Name
event
Type
string
Description
The associated event.
Name
title
Type
string
Description
The title needed to be able to access the environment.
Name
title_formatted
Type
string
Description
Display name of the required title.
Name
environment_id
Type
integer
Description
The numeric environment ID used by the game.
Name
status
Type
string
Description
Whether the environment is currently active or inactive.
Name
description
Type
string
Description
The environment description, as plain text.

Request

GET

https://api.mouse.rip/environments-events

const eventEnvironments = await fetch('https://api.mouse.rip/environments-events')
console.log(eventEnvironments)

Response

[
  {
    "id": "winter_hunt_grove",
    "name": "Cinnamon Hill",
    "image": "https://www.mousehuntgame.com/images/environments/9116f87ec4f9ef3be13a1a833a61aec4.jpg",
    "icon": "https://www.mousehuntgame.com/images/environments/e3a7b6767899075d59bb3bb90b4aca2b.jpg",
    "region": "events-gwh",
    "event": "gwh",
    "order": 1,
    "title": "recruit",
    "title_formatted": "Recruit",
    "environment_id": 69,
    "status": "inactive",
    "description": "Possibly the most delightfully aromatic place in all of Gnawnia, Cinnamon Hill is the source of the Kingdom's cleanest, most efficient, and most delicious fuel source!"
  },
  ...
]

Get M400 locations

GEThttps://api.mouse.rip/m400-locations

Get all M400 locations and associated mice.

Properties

Name
location
Type
string
Description
The location ID.
Name
mice
Type
array
Description
The array of mice in the location.

Request

GET

https://api.mouse.rip/m400-locations

const m400Locations = await fetch('https://api.mouse.rip/m400-locations')
console.log(m400Locations)

Response

{
  "balacks_cove": [
    "Balack's Cove",
    "Derr Lich",
    "Elub Lich",
    "Nerg Lich"
  ],
  ...
}