Environments
Get all environments
With no query string, returns every permanent location. Any query (filters, q, sort, fields, limit, and so on) searches permanent and event locations together and adds is_event and event to each record.
This endpoint supports filtering, searching, sorting, pagination, and
field selection via query parameters — see
Search & Querying. Sort by environment_id, id, name, order, region, status, or title.
Query parameters
- Name
qTypestringDescriptionCase-insensitive partial text search.
Properties
- Name
idTypestringDescriptionLocation slug, e.g.meadow. - Name
nameTypestringDescriptionThe environment name. - Name
articleTypestringDescriptionThe name with its article, e.g. "the Meadow". - Name
imageTypestringDescriptionImage URL. - Name
headerImageTypestringDescriptionHeader image URL. - Name
iconTypestringDescriptionIcon URL. - Name
regionTypestringDescriptionRegion slug, e.g.gnawnia. - Name
orderTypeintegerDescriptionDisplay order. - Name
titleTypestringDescriptionHunter title required to travel here, e.g.novice. - Name
title_formattedTypestringDescriptionDisplay name of the required title. - Name
environment_idTypeintegerDescriptionThe numeric environment ID used by the game. - Name
statusTypestringDescriptionWhether the environment is currentlyactiveorinactive. - Name
descriptionTypestringDescriptionThe environment description, as plain text. - Name
is_eventTypebooleanDescriptionWhether this is an event location. Only in query results. - Name
eventTypestringDescriptionThe event an event location belongs to, e.g.gwh, ornull. Only in query results.
Request
GET
https://api.mouse.rip/environments?region=gnawnia&fields=id,name,environment_idconst response = await fetch('https://api.mouse.rip/environments?region=gnawnia&fields=id,name,environment_id')
Response
[
{
"id": "meadow",
"name": "Meadow",
"environment_id": 18
},
{
"id": "town_of_gnawnia",
"name": "Town of Gnawnia",
"environment_id": 28
},
...
]
Get an environment
One location, permanent or event. Replace :id with the location's slug (e.g. meadow), its numeric environment ID (e.g. 18), or its name.
Query parameters
- Name
qTypestringDescriptionCase-insensitive partial text search.
Properties
- Name
idTypestringDescriptionLocation slug, e.g.meadow. - Name
nameTypestringDescriptionThe environment name. - Name
articleTypestringDescriptionThe name with its article, e.g. "the Meadow". - Name
imageTypestringDescriptionImage URL. - Name
headerImageTypestringDescriptionHeader image URL. - Name
iconTypestringDescriptionIcon URL. - Name
regionTypestringDescriptionRegion slug, e.g.gnawnia. - Name
orderTypeintegerDescriptionDisplay order. - Name
titleTypestringDescriptionHunter title required to travel here, e.g.novice. - Name
title_formattedTypestringDescriptionDisplay name of the required title. - Name
environment_idTypeintegerDescriptionThe numeric environment ID used by the game. - Name
statusTypestringDescriptionWhether the environment is currentlyactiveorinactive. - Name
descriptionTypestringDescriptionThe environment description, as plain text. - Name
is_eventTypebooleanDescriptionWhether this is an event location. - Name
eventTypestringDescriptionThe event an event location belongs to, e.g.gwh, ornull.
Request
GET
https://api.mouse.rip/environments/meadowconst response = await fetch('https://api.mouse.rip/environments/meadow')
Response
{
"id": "meadow",
"name": "Meadow",
"article": "the Meadow",
"image": "https://www.mousehuntgame.com/images/environments/a441eb078698da69ef2765983f4b5912.jpg",
"headerImage": "https://www.mousehuntgame.com/images/environments/6ef3ffe2f90a79250807b46105e77b68.jpg",
"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. Considered somewhat of a safe haven for novice ...",
"event": null,
"is_event": false
}
Get event environments
Event locations, each with the event it belongs to.
Properties
- Name
idTypestringDescriptionLocation slug, e.g.meadow. - Name
nameTypestringDescriptionThe environment name. - Name
articleTypestringDescriptionThe name with its article, e.g. "the Meadow". - Name
imageTypestringDescriptionImage URL. - Name
headerImageTypestringDescriptionHeader image URL. - Name
iconTypestringDescriptionIcon URL. - Name
regionTypestringDescriptionRegion slug, e.g.gnawnia. - Name
orderTypeintegerDescriptionDisplay order. - Name
eventTypestringDescriptionThe event this location belongs to, e.g.gwh. - Name
titleTypestringDescriptionHunter title required to travel here, e.g.novice. - Name
title_formattedTypestringDescriptionDisplay name of the required title. - Name
environment_idTypeintegerDescriptionThe numeric environment ID used by the game. - Name
statusTypestringDescriptionWhether the environment is currentlyactiveorinactive. - Name
descriptionTypestringDescriptionThe environment description, as plain text.
Request
GET
https://api.mouse.rip/environments-eventsconst response = await fetch('https://api.mouse.rip/environments-events')
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 fu..."
},
{
"id": "winter_hunt_workshop",
"name": "Golem Workshop",
"image": "https://www.mousehuntgame.com/images/environments/bbd5eeca404e57ec2ffb9d9a108361a2.jpg",
"icon": "https://www.mousehuntgame.com/images/environments/83ec5fb09bc903878b25ba6f5c77f07d.jpg",
"region": "events-gwh",
"event": "gwh",
"order": 2,
"title": "recruit",
"title_formatted": "Recruit",
"environment_id": 70,
"status": "inactive",
"description": "The hard-working droids that toil away in this merry manufacturing plant are the most efficient and meticulous artisans of Snow Golem parts in the entire Kin..."
},
...
]
Get M400 locations
Keyed by location slug. Each value is the location's name followed by the names of its mice.
Properties
- Name
locationTypestringDescriptionThe location ID. - Name
miceTypearray of valuesDescriptionThe array of mice in the location.
Request
GET
https://api.mouse.rip/m400-locationsconst response = await fetch('https://api.mouse.rip/m400-locations')
Response
{
"balacks_cove": [
"Balack's Cove",
"Derr Lich",
...
],
"bazaar": [
"Bazaar",
"Master Burglar",
...
],
"calm_clearing": [
"Calm Clearing"
],
...
}