MoeNotes

English

简体中文
繁體中文
日本語
한국어

English

简体中文
繁體中文
日本語
한국어

Appearance

Open Platform documentation ​

Integrate public profiles, rankings, gacha data and authorized gzip archive downloads with the Moenotes API.

Developer console · Account and save consent

Overview ​

Register an application to receive a client ID and secret immediately. No bot, verification code or review is required.

This platform is not an official game publisher API. Application registration, API key issuance, and key revocation are managed in the developer console on the main site (this static documentation site is for reference only). Applications do not require manual review. Each application may maintain up to two active keys at a time: update and verify your client services with the new key before explicitly revoking the old one.

Public event and music rankings ​

For event, music, and challenge rankings, we recommend using the public service consumed by the main site at https://api.bdon.moe/api/v1. This service is independent of the Passport authentication system: all public endpoints accept unauthenticated GET requests without a clientSecret, and do not consume Passport's 100 requests/minute or 10000 requests/day quota. Please note that public endpoints do not guarantee a fixed refresh interval or arbitrary third-party browser CORS support, nor do they allow unlimited high-frequency polling. Please cache responses locally where appropriate.

Public event and music rankings

Getting started ​

Getting started · Authentication, scopes and regions · Archive download · Limits and security · Error handling

API reference ​

  • Profiles and favorites — moenotes:profiles: Read one player's public profile, fetch several profiles at once, or list a player's favorites.
  • Profile card images — moenotes:profile-images: Render one page of a player's profile card as a PNG image.
  • Rankings — moenotes:rankings: Music, event, challenge and arena ranking boards.
  • Top decks — moenotes:decks: Deck composition used in event rankings and arena deck trends.
  • Circles — moenotes:circles: Look up a circle by id or search circles by name and filters.
  • Gacha rates — moenotes:gacha: Published rates of a gacha pool and its pickup cards.
  • Announcements — moenotes:announcements: In-game announcement list and single announcement details.