Sonolus Wiki

GET /sonolus/{type}/list

/sonolus/{type}/list provides information of items, and is used by Sonolus app to populate server item list view.

URL Parameters

URL ParameterValueDescription
typestringposts, playlists, levels, skins, backgrounds, effects, particles, engines, replays, or rooms.

Query Parameters

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

Search Parameters

When using quick search, search parameters of ?type=quick&keywords=... will be sent.

Request Headers

HeaderValueDescription
Sonolus-SessionstringOptional, see Sonolus-Session.

Request Body

None.

Response Code

CodeDescription
200 OK
401 UnauthorizedAuthentication required or expired.

Response Headers

HeaderValueDescription
Sonolus-VersionstringOptional, see Sonolus-Version.

Response Body

type ServerItemList<T> = {
    pageCount: number
    items: T[]
    searches?: ServerForm[]
}

pageCount

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

items

It is recommended to keep each page short by showing only 20 items.

Examples

{
    "pageCount": 5,
    "items": [
        // ...
    ],
    "searches": [
        // ...
    ]
}