Sonolus Wiki

GET /sonolus/{type}/{itemName}/leaderboards/{leaderboardName}/records/list

/sonolus/{type}/{itemName}/leaderboards/{leaderboardName}/records/list provides detailed information of leaderboard of name {leaderboardName} in item of name {itemName}, and is used by Sonolus app to populate server item details view's leaderboard section's record list.

URL Parameters

URL ParameterValueDescription
typestringposts, playlists, levels, skins, backgrounds, effects, particles, engines, or replays.
itemNamestringName of item.
leaderboardNamestringName of leaderboard.

Query Parameters

Query ParameterValueDescription
localizationstringSee localization.
Configuration OptionsanySee Options Query Parameters.
pagenumberSee page.

Request Headers

HeaderValueDescription
Sonolus-SessionstringOptional, see Sonolus-Session.

Request Body

None.

Response Code

CodeDescription
200 OK
401 UnauthorizedAuthentication required or expired.
404 Not Found

Response Headers

HeaderValueDescription
Sonolus-VersionstringOptional, see Sonolus-Version.

Response Body

type ServerItemLeaderboardRecordList = {
    pageCount: number
    records: ServerItemLeaderboardRecord[]
}

pageCount

If -1 is used, the list is treated as having infinite pagination.

comments

It is recommended to keep each page short by showing only 10 records.

Examples

{
    "pageCount": 5,
    "records": [
        // ...
    ]
}