Versions

Get endpoint versions

GEThttps://api.mouse.rip/versions

A version hash for each data endpoint, taken from the deployed data files. A hash only changes when the underlying data changes, making this useful for cache busting or checking for updates without downloading full responses. Responses are cached for five minutes.

Properties

Name
[endpoint]
Type
string
Description
Keyed by endpoint name (e.g. mice). The version hash for the endpoint's data.

Request

GET

https://api.mouse.rip/versions

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

Response

{
  "effs": "27a1300da3",
  "environments": "f8f331d849",
  "items": "e018f90744",
  "journals-events": "24678ecda5",
  "mice": "1d4984804e",
  "minlucks": "d16717de00",
  ...
}

Get the OpenAPI spec

GEThttps://api.mouse.rip/openapi

The machine-readable API contract as an OpenAPI 3.1 document, covering the item and mouse collections, query parameters, search, and facets. Also available at /openapi.json.

Request

GET

https://api.mouse.rip/openapi

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

Response

{
  "openapi": "3.1.0",
  "info": {
    "title": "MouseHunt API",
    "version": "1.0.0",
    "description": "Unofficial, read-only API for public MouseHunt data."
  },
  "servers": [{ "url": "https://api.mouse.rip" }],
  "paths": {
    "/items": { "$ref": "#/components/pathItems/Items" },
    "/items/{id}": { "$ref": "#/components/pathItems/Item" },
    ...
  },
  ...
}