Skip to content

Subsonic API Reference ​

Tunecamp exposes a full Subsonic API at /rest, compatible with Subsonic API version 1.16.1. This makes it compatible with all major Subsonic clients.

Tested Clients ​

ClientPlatformStatus
DSubAndroidβœ…
SymfoniumAndroidβœ…
TempoiOSβœ…
SubstreamerMultiβœ…
AmuseAndroidβœ…
play:SubiOSβœ…

Connection Settings ​

  • Server URL: https://your-server.com/rest
  • Username: Your Tunecamp username (administrator or artist)
  • Password: Your account password

NOTE

Roaming Users: To use Subsonic on a new instance, you must first log in to that instance via the web interface at least once. This triggers the Lazy Account Creation (roaming) which sets up your local profile and credentials required for Subsonic authentication.

Supported Endpoints ​

System ​

EndpointDescription
ping.viewCheck server connectivity
getLicense.viewReturns valid license
getOpenSubsonicExtensions.viewOpenSubsonic extensions list

Browsing ​

EndpointDescription
getMusicFolders.viewList music folders
getIndexes.viewList artists alphabetically indexed
getMusicDirectory.viewBrowse directory (artist β†’ albums β†’ tracks)
getArtists.viewList all artists (ID3)
getArtist.viewGet artist details with albums
getAlbum.viewGet album details with tracks
getSong.viewGet single track details
getGenres.viewList all genres
getArtistInfo.view / getArtistInfo2.viewArtist biography and images
getAlbumInfo.view / getAlbumInfo2.viewAlbum notes and images
getSimilarSongs.view / getSimilarSongs2.viewDiscover similar songs
getTopSongs.viewTop/popular songs

Album/Song Lists ​

EndpointDescription
getAlbumList.view / getAlbumList2.viewAlbum lists (random, newest, alphabetical, frequent, recent, starred, byGenre, byYear)
getRandomSongs.viewRandom track selection
getSongsByGenre.viewFilter songs by genre
getStarred.view / getStarred2.viewGet starred (favorited) items

Media ​

EndpointDescription
stream.viewStream audio files
download.viewDownload audio files
getCoverArt.viewGet cover art images
getLyrics.viewGet track lyrics
EndpointDescription
search.view / search2.view / search3.viewFull-text search across artists, albums, tracks

Playlists ​

EndpointDescription
getPlaylists.viewList all playlists
getPlaylist.viewGet playlist with tracks
createPlaylist.viewCreate or update a playlist
updatePlaylist.viewAdd/remove songs, rename
deletePlaylist.viewDelete a playlist

Stars & Favorites ​

EndpointDescription
star.viewStar (favorite) artists, albums, songs
unstar.viewRemove star from items

User & Scrobbling ​

EndpointDescription
getUser.viewGet user details and permissions
getUsers.viewList all users
scrobble.viewRecord track plays (local SQLite)
getNowPlaying.viewCurrently playing tracks

Play Queue & Bookmarks ​

EndpointDescription
getPlayQueue.viewGet saved play queue
savePlayQueue.viewSave play queue state
getBookmarks.viewGet bookmarks
createBookmark.viewCreate a bookmark
deleteBookmark.viewDelete a bookmark

System & Misc ​

EndpointDescription
getScanStatus.viewMedia library scan status
startScan.viewTrigger library scan
getAvatar.viewGet user avatar
getPodcasts.viewPodcast channels (stub)
getInternetRadioStations.viewRadio stations (stub)
getShares.viewShared items (stub)
jukeboxControl.viewJukebox control (stub)

Released under the MIT License.