Scoreboards

Every scoreboard, grouped the way the game lists them, and whether each has a weekly ranking.

Get all scoreboards

GEThttps://api.mouse.rip/scoreboards

Supports filtering, searching, sorting, pagination, and field selection. See Search & Querying.

Query parameters

Name
q
Type
string
Description
Case-insensitive partial text search.

Properties

Name
id
Type
string
Description
Scoreboard ID, as the game uses it.
Name
name
Type
string
Description
Display name.
Name
group
Type
string
Description
Group the board is listed under, e.g. General or Mouse Stats - Iceberg.
Name
weekly
Type
boolean
Description
Whether the board also has a weekly ranking.

Request

GET

https://api.mouse.rip/scoreboards?group=General

const response = await fetch('https://api.mouse.rip/scoreboards?group=General')

Response

[
  {
    "id": "points",
    "name": "Points",
    "group": "General",
    "weekly": true
  },
  {
    "id": "gold",
    "name": "Gold",
    "group": "General",
    "weekly": true
  },
  ...
]

Get a scoreboard

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

Accepts a scoreboard ID.

Query parameters

Name
q
Type
string
Description
Case-insensitive partial text search.

Properties

Name
id
Type
string
Description
Scoreboard ID, as the game uses it.
Name
name
Type
string
Description
Display name.
Name
group
Type
string
Description
Group the board is listed under, e.g. General or Mouse Stats - Iceberg.
Name
weekly
Type
boolean
Description
Whether the board also has a weekly ranking.

Request

GET

https://api.mouse.rip/scoreboards/gold

const response = await fetch('https://api.mouse.rip/scoreboards/gold')

Response

{
  "id": "gold",
  "name": "Gold",
  "group": "General",
  "weekly": true
}