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
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.

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",
    "region": "gnawnia",
    "order": 10,
    "title": "novice"
  },
  {
    "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
region
Type
string
Description
The environment region.
Name
order
Type
integer
Description
The environment order.
Name
event
Type
string
Description
The associated event.

Request

GET

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

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

Response

[
  {
    "id": "winter_hunt_grove",
    "name": "Cinnamon Hill",
    "image": "https://www.mousehuntgame.com/images/environments/9116f87ec4f9ef3be13a1a833a61aec4.jpg",
    "region": "events-gwh",
    "event": "gwh"
  },
  ...
]

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"
  ],
  ...
}