getKaraokeSongs(_:)

func getKaraokeSongs(_ req: Request) async throws -> KaraokeSongResponseData

GET /api/v3/karaoke

Returns an array of karaoke songs in a structure designed to support pagination. Can be called while not logged in; if logged in favorite information is returned.

This call can’t be used to browse the entire ~25000 song library. You must specify either a search string with >2 chars, or specify favorites=true.

URL Query Parameters

  • ?search=STRING - Only show songs whose artist or title contains the given string. If a single letter or %23 is sent, it will return songs where the artist matches the letter, or starts with a number.
  • ?favorite=TRUE - Only return songs that have been favorited by current user.
  • ?start=INT - Offset from start of results set

  • ?limit=INT - the maximum number of songs to retrieve: 1-200, default is 50.

Return Value

KaraokeSongResponseData

Show on GitHub