Skip to content

Profiles and favorites ​

Scope: moenotes:profiles

Read one player's public profile, fetch several profiles at once, or list a player's favorites.

Endpoints ​

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

/player/{playerId}/favorites ​

http
GET /api/open/v1/moenotes/{region}/player/{playerId}/favorites
ParameterLocationRequired
playerIdpathRequired

/profile ​

http
GET /api/open/v1/moenotes/{region}/profile
ParameterLocationRequired
playerProfileIdqueryRequired

/profile/favorites ​

http
GET /api/open/v1/moenotes/{region}/profile/favorites
ParameterLocationRequired
playerIdqueryRequired

/profile/{profileId} ​

http
GET /api/open/v1/moenotes/{region}/profile/{profileId}
ParameterLocationRequired
profileIdpathRequired

/profiles ​

http
GET /api/open/v1/moenotes/{region}/profiles
ParameterLocationRequired
accountIdsqueryRequired

/profiles/{accountIds} ​

http
GET /api/open/v1/moenotes/{region}/profiles/{accountIds}
ParameterLocationRequired
accountIdspathRequired

Parameters ​

ParameterDescription
profileIdPublic profile id: 11 digits starting with 2, 3 or 4 outside Japan; a positive int64 in Japan. Always a decimal string.
playerProfileIdQuery form of profileId for the single-profile endpoint. It is not interchangeable with playerId.
accountIdsUp to 100 comma-separated account ids for one batch request.
playerIdAccount id whose favorites you want. It is not interchangeable with profileId.

Region differences ​

Available on all four regions. The profileId format differs: jp accepts a positive int64, while tw/en/kr use 11 digits with a regional prefix (2, 3 and 4 respectively). An account that exists on several servers has a different id on each, and favorites are per region.

Notes ​

profileId, playerId and accountId are different identifiers and cannot be swapped. Path and query forms return the same data.

Returns 400 invalid_request for malformed or unknown parameters, 401 invalid_api_key for invalid credentials, 403 insufficient_scope when the key lacks moenotes:profiles, and 404 not_found when the player does not exist or has not made their profile public.

Example ​

sh
REGION=jp
curl --fail-with-body "https://passport.bdon.moe/api/open/v1/moenotes/$REGION/profile/$PROFILE_ID" \
  -H "Authorization: Bearer $CLIENT_SECRET"