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.


System	`ping` `getLicense` `getOpenSubsonicExtensions` `tokenInfo`
Browsing	`getMusicFolders` `getIndexes` `getMusicDirectory` `getGenres` `getArtists` `getArtist` `getAlbum` `getSong` `getVideos` `getVideoInfo` `getArtistInfo` `getArtistInfo2` `getAlbumInfo` `getAlbumInfo2` `getSimilarSongs` `getSimilarSongs2` `getTopSongs`
Album/song lists	`getAlbumList` `getAlbumList2` `getRandomSongs` `getSongsByGenre` `getNowPlaying` `getStarred` `getStarred2`
Searching	`search` `search2` `search3`
Playlists	`getPlaylists` `getPlaylist` `createPlaylist` `updatePlaylist` `deletePlaylist`
Media retrieval	`stream` `download` `hls` `getCaptions` `getCoverArt` `getLyrics` `getAvatar` `getLyricsBySongId`
Media annotation	`star` `unstar` `setRating` `scrobble`
Sharing	`getShares` `createShare` `updateShare` `deleteShare`
Podcast	`getPodcasts` `getNewestPodcasts` `refreshPodcasts` `createPodcastChannel` `deletePodcastChannel` `deletePodcastEpisode` `downloadPodcastEpisode`
Jukebox	`jukeboxControl`
Internet radio	`getInternetRadioStations` `createInternetRadioStation` `updateInternetRadioStation` `deleteInternetRadioStation`
Chat	`getChatMessages` `addChatMessage`
User management	`getUser` `getUsers` `createUser` `updateUser` `deleteUser` `changePassword`
Bookmarks	`getBookmarks` `createBookmark` `deleteBookmark` `getPlayQueue` `savePlayQueue`
Media library scanning	`getScanStatus` `startScan`