mirror of
https://github.com/rembo10/headphones.git
synced 2026-03-26 06:39:26 +00:00
41 lines
2.2 KiB
Plaintext
41 lines
2.2 KiB
Plaintext
|
|
General structure:
|
|
http://localhost:8181 + HTTP_ROOT + /api?apikey=$apikey&cmd=$command
|
|
|
|
Data returned in json format
|
|
|
|
Commands:
|
|
getIndex (fetch data from index page. Returns: ArtistName, ArtistSortName, ArtistID, Status, DateAdded,
|
|
[LatestAlbum, ReleaseDate, AlbumID], HaveTracks, TotalTracks,
|
|
IncludeExtras)
|
|
|
|
getArtist&id=$artistid (fetch artist data. returns the artist object (see above) and album info: Status, AlbumASIN, DateAdded, AlbumTitle, ArtistName, ReleaseDate, AlbumID, ArtistID, Type)
|
|
|
|
getAlbum&id=$albumid (fetch data from album page. Returns the album object, a description object and a tracks object. Tracks contain: AlbumASIN, AlbumTitle, TrackID, Format, TrackDuration (ms), ArtistName, TrackTitle, AlbumID, ArtistID, Location, TrackNumber, CleanName (stripped of punctuation /styling), BitRate)
|
|
|
|
getUpcoming (Returns: Status, AlbumASIN, DateAdded, AlbumTitle, ArtistName, ReleaseDate, AlbumID, ArtistID, Type)
|
|
|
|
getWanted (Returns: Status, AlbumASIN, DateAdded, AlbumTitle, ArtistName, ReleaseDate, AlbumID, ArtistID, Type)
|
|
|
|
getSimilar (Returns similar artists with a higher "Count" being more likely to be similar. Returns: Count, ArtistName, ArtistID)
|
|
|
|
getHistory (Returns: Status, DateAdded, Title, URL (nzb), FolderName, AlbumID, Size (bytes))
|
|
|
|
getLogs (not working yet)
|
|
|
|
findArtist&name=$artistname[&limit=$limit] (perform artist query on musicbrainz. Returns: url, score, name, uniquename (contains disambiguation info), id)
|
|
|
|
findAlbum&name=$albumname[&limit=$limit] (perform album query on musicbrainz. Returns: title, url (artist), id (artist), albumurl, albumid, score, uniquename (artist - with disambiguation)
|
|
|
|
addArtist&id=$artistid (add an artist to the db by artistid)
|
|
|
|
delArtist&id=$artistid (delete artist from db by artistid)
|
|
|
|
pauseArtist&id=$artistid (pause an artist in db)
|
|
resumeArtist&id=$artistid (resume an artist in db)
|
|
|
|
refreshArtist&id=$artistid (refresh info for artist in db from musicbrainz)
|
|
|
|
queueAlbum&id=$albumid[&new=True&lossless=True] (Mark an album as wanted and start the searcher. Optional paramters: 'new' looks for new versions, 'lossless' looks only for lossless versions)
|
|
unqueueAlbum&id=$albumid (Unmark album as wanted / i.e. mark as skipped)
|