Search Endpoints¶

Search Everything.¶

GET /api/v1/search

Parameters¶

Property	Type	Description
`search`	String	What to search for.

Response¶

Property	Type	Description
`users`	Array<UserDocument>	The array of users whose usernames look like the search criterion.
`songs`	(SongDocument With __textScore and `game`.)[]	An array of songs from all games, with `__textScore` and `game` properties attached.

Example¶

Request¶

GET /api/v1/search?search=freedom

Response¶

{
    users: [{
        username: "FreedomDiver",
        // ...
    }],
    songs: [{
        title: "FREEDOM",
        __textScore: 2,
        game: "iidx",
        // ...
    }, {
        title: "FREEDOM DiVE",
        __textScore: 1,
        game: "bms",
        // ...
    }]
}

Info

For more details on how searching works, see Search Implementation.