search_album

🟡 Incomplete

This API's output may have additions in the future.


Input a string, retrieve an array of Album's, sorted by how similar their titles are to the input.

Inputs

FieldTypeDescription
inputstringThe string to match against, to use as input
kindstring, one of all, sim60, sim70, sim80, top25, top5, top1See Search/Kind

Outputs

FieldTypeDescription
albumsarray of Album objectsAn array of Album objects, sorted by most similar title first

Example Request

festival-cli search_album --input time --kind sim70
curl http://localhost:18425 -d '{"jsonrpc":"2.0","id":0,"method":"search_album","params":{"input":"time","kind":"sim70"}}'

Example Response

{
  "jsonrpc": "2.0",
  "result": {
    "albums": [
      {
        "title": "TIME",
        "key": 271,
        "artist": 42,
        "release": "2014-01-21",
        "runtime": 2904,
        "song_count": 3,
        "songs": [
          3058,
          3095,
          3121
        ],
        "discs": 0,
        "art": 1264656,
        "genre": null
      }
    ]
  },
  "id": 0
}