Lyrics in LoboTune

A server for LoboTune implements LoboTune's lyrics interface. It consists of one request:

GET <address>/api/search?track_name=<title>&artist_name=<artist>

• The address may have a path: https://example.org/lyrics becomes https://example.org/lyrics/api/search?….
• HTTPS only. The app does not accept addresses starting with http://.
• Optionally exactly one header carrying a key, for example X-Api-Key. The app sends it only to this address, not after a redirect to another host.
• Response: status 200 and a JSON list. If nothing matches, the list is empty ([]). With 401 or 403 the app reports that a valid key is missing.

[
  {
    "trackName": "Greensleeves",
    "artistName": "Traditional",
    "plainLyrics": "Alas, my love, you do me wrong,\nTo cast me off discourteously.\n…",
    "syncedLyrics": null,
    "instrumental": false
  }
]

• trackName, artistName: title and artist of the hit. The app compares them with the song playing.
• plainLyrics: the lyrics, lines separated by \n, verses by an empty line.
• syncedLyrics: optional, lines with timestamps such as [00:12.50]. LoboTune uses it only when plainLyrics is missing, and shows it without the timestamps.
• instrumental: true for pieces without lyrics.

Missing fields are allowed, unknown ones are ignored. When you save the address, the app asks once with track_name=lobotune&artist_name=lobotune and expects a list; an empty one will do. After that it only asks when you open the lyrics of a song, and then sends that song's artist and title to your server.

1. Open Settings → Lyrics server.
2. Enter your server's address under Server address.
3. If your server asks for a key, fill in Header name and Header value. The key is kept encrypted on the device and is not part of the backup file.
4. Tap Check and use. The app keeps the address only once the server answers correctly.

Use sample server shows how entering a server works. The sample server delivers no lyrics, only a notice. With Remove, LoboTune asks nobody for lyrics again.