Skip to content

Rankings ​

Scope: moenotes:rankings

Music, event, challenge and arena ranking boards.

TIP

For event cutoffs, music boards and challenge boards, prefer the public data API without sending a secret. These are collected snapshots; their limits are separate from Passport quotas.

Endpoints ​

Full paths; supply only the parameters listed for the chosen endpoint.

/arena/ranking ​

http
GET /api/open/v1/moenotes/{region}/arena/ranking
ParameterLocationRequired
arenaSeasonIdqueryRequired
bandIdqueryOptional
rankingStartqueryRequired
rankingEndqueryRequired

/arena/{arenaSeasonId}/ranking/{rankingStart}/{rankingEnd} ​

http
GET /api/open/v1/moenotes/{region}/arena/{arenaSeasonId}/ranking/{rankingStart}/{rankingEnd}
ParameterLocationRequired
arenaSeasonIdpathRequired
bandIdqueryOptional
rankingStartpathRequired
rankingEndpathRequired

/arena/{arenaSeasonId}/ranking/{rankingStart}/{rankingEnd}/band/{bandId} ​

http
GET /api/open/v1/moenotes/{region}/arena/{arenaSeasonId}/ranking/{rankingStart}/{rankingEnd}/band/{bandId}
ParameterLocationRequired
arenaSeasonIdpathRequired
bandIdpathRequired
rankingStartpathRequired
rankingEndpathRequired

/event/challenge-ranking ​

http
GET /api/open/v1/moenotes/{region}/event/challenge-ranking
ParameterLocationRequired
challengeMusicIdqueryRequired

/event/challenge/{challengeMusicId}/ranking ​

http
GET /api/open/v1/moenotes/{region}/event/challenge/{challengeMusicId}/ranking
ParameterLocationRequired
challengeMusicIdpathRequired

/event/ranking ​

http
GET /api/open/v1/moenotes/{region}/event/ranking
ParameterLocationRequired
eventIdqueryRequired
ranksqueryRequired

/event/{eventId}/ranking/{ranks} ​

http
GET /api/open/v1/moenotes/{region}/event/{eventId}/ranking/{ranks}
ParameterLocationRequired
eventIdpathRequired
rankspathRequired

/music/ranking ​

http
GET /api/open/v1/moenotes/{region}/music/ranking
ParameterLocationRequired
musicIdqueryRequired

/music/{musicId}/ranking ​

http
GET /api/open/v1/moenotes/{region}/music/{musicId}/ranking
ParameterLocationRequired
musicIdpathRequired

Parameters ​

ParameterDescription
musicIdSong ID used for music rankings or arena deck trends.
eventIdEvent ID for event rankings and event deck compositions.
ranks1-based inclusive rank window. Repeat query parameters (?ranks=1&ranks=100) or specify via the path form.
challengeMusicIdChallenge song ID (distinct from standard song IDs).
arenaSeasonIdArena season ID.
rankingStartFirst rank of the arena ranking window (1-based).
rankingEndLast rank of the arena ranking window.
bandIdOptional band filter for arena rankings; in path form, append /band/{bandId}.

Region differences ​

Boards are per region and are not comparable: event, challenge and arena periods differ, so an eventId or arenaSeasonId from one region is usually unknown in another. Song ids also differ between regions.

Notes ​

Ranks are one-based and inclusive, and the window is required. Pass it explicitly so cached results stay predictable.

Returns 400 invalid_request for malformed rank intervals or unknown parameters, 401 invalid_api_key for missing or invalid keys, 403 insufficient_scope if the key lacks moenotes:rankings, 404 not_found when the ranking board does not exist, and 429 when rate or quota limits are exceeded.

Example ​

sh
REGION=jp
curl --fail-with-body "https://passport.bdon.moe/api/open/v1/moenotes/$REGION/event/ranking?eventId=$EVENT_ID&ranks=1&ranks=100" \
  -H "Authorization: Bearer $CLIENT_SECRET"