OpenSubsonic API

API details and methods.

See API Reference for the basic API documentation. (Mandatory parameters, authentication, error handling, …)

Be sure to read OpenSubsonic changes to easily identify the changes brought by OpenSubsonic.

File structure vs ID3 tags

Starting with version 1.8.0, the API provides methods for accessing the media collection organized according to ID3 tags, rather than file structure.

For instance, browsing through the collection using ID3 tags should use the getArtists, getArtist and getAlbum methods. To browse using file structure you would use getIndexes and getMusicDirectory.

Correspondingly, there are two sets of methods for searching, starring and album lists. Refer to the method documentation for details.

API methods

Systemping getLicense getOpenSubsonicExtensions tokenInfo
BrowsinggetMusicFolders getIndexes getMusicDirectory getGenres getArtists getArtist getAlbum getSong getVideos getVideoInfo getArtistInfo getArtistInfo2 getAlbumInfo getAlbumInfo2 getSimilarSongs getSimilarSongs2 getTopSongs
Album/song listsgetAlbumList getAlbumList2 getRandomSongs getSongsByGenre getNowPlaying getStarred getStarred2
Searchingsearch search2 search3
PlaylistsgetPlaylists getPlaylist createPlaylist updatePlaylist deletePlaylist
Media retrievalstream download hls getCaptions getCoverArt getLyrics getAvatar getLyricsBySongId
Media annotationstar unstar setRating scrobble
SharinggetShares createShare updateShare deleteShare
PodcastgetPodcasts getNewestPodcasts refreshPodcasts createPodcastChannel deletePodcastChannel deletePodcastEpisode downloadPodcastEpisode
JukeboxjukeboxControl
Internet radiogetInternetRadioStations createInternetRadioStation updateInternetRadioStation deleteInternetRadioStation
ChatgetChatMessages addChatMessage
User managementgetUser getUsers createUser updateUser deleteUser changePassword
BookmarksgetBookmarks createBookmark deleteBookmark getPlayQueue savePlayQueue
Media library scanninggetScanStatus startScan