Subsonic API breakdownΒΆ
This page lists all the API methods and their parameters up to the version 1.16.0 (Subsonic 6.1.2). Here youβll find details about which API features Supysonic support, plan on supporting, or wonβt.
At the moment, the current target API version is 1.12.0.
The following information was gathered by diff-ing various snapshots of the Subsonic API page.
Methods and parameters listingΒΆ
Statuses explanation:
π : planned
βοΈ: done
β: done as not supported
π΄: wonβt be implemented
β: not decided yet
The version column specifies the API version which added the related method or parameter. When no version is given, it means the item was introduced prior to or with version 1.8.0.
All methods / pseudo-TOCΒΆ
Method |
Vers. |
|
---|---|---|
βοΈ |
||
βοΈ |
||
βοΈ |
||
βοΈ |
||
βοΈ |
||
1.9.0 |
βοΈ |
|
βοΈ |
||
βοΈ |
||
βοΈ |
||
βοΈ |
||
β |
||
1.15.0 |
π΄ |
|
1.11.0 |
π |
|
1.11.0 |
π |
|
1.14.0 |
π |
|
1.14.0 |
π |
|
1.11.0 |
β |
|
1.11.0 |
β |
|
1.13.0 |
β |
|
βοΈ |
||
βοΈ |
||
βοΈ |
||
1.9.0 |
βοΈ |
|
βοΈ |
||
βοΈ |
||
βοΈ |
||
βοΈ |
||
βοΈ |
||
βοΈ |
||
βοΈ |
||
βοΈ |
||
βοΈ |
||
βοΈ |
||
βοΈ |
||
βοΈ |
||
βοΈ |
||
1.9.0 |
β |
|
1.15.0 |
π΄ |
|
βοΈ |
||
βοΈ |
||
β |
||
βοΈ |
||
βοΈ |
||
βοΈ |
||
βοΈ |
||
β |
||
β |
||
β |
||
β |
||
β |
||
1.14.0 |
β |
|
1.9.0 |
β |
|
1.9.0 |
β |
|
1.9.0 |
β |
|
1.9.0 |
β |
|
1.9.0 |
β |
|
βοΈ |
||
1.9.0 |
βοΈ |
|
1.16.0 |
βοΈ |
|
1.16.0 |
βοΈ |
|
1.16.0 |
βοΈ |
|
βοΈ |
||
βοΈ |
||
βοΈ |
||
1.9.0 |
βοΈ |
|
βοΈ |
||
1.10.2 |
βοΈ |
|
βοΈ |
||
βοΈ |
||
1.9.0 |
β |
|
1.9.0 |
β |
|
1.9.0 |
β |
|
1.12.0 |
β |
|
1.12.0 |
β |
|
1.15.0 |
βοΈ |
|
1.15.0 |
βοΈ |
GlobalΒΆ
Parameters used for any request
Vers. |
||
---|---|---|
|
βοΈ |
|
|
βοΈ |
|
|
1.13.0 |
π΄ |
|
1.13.0 |
π΄ |
|
βοΈ |
|
|
βοΈ |
|
|
βοΈ |
Error codes
# |
Vers. |
|
---|---|---|
0 |
βοΈ |
|
10 |
βοΈ |
|
20 |
βοΈ |
|
30 |
βοΈ |
|
40 |
βοΈ |
|
41 |
1.15.0 |
π |
50 |
βοΈ |
|
60 |
βοΈ |
|
70 |
βοΈ |
SystemΒΆ
ping
βοΈ
No parameter
getLicense
βοΈ
No parameter
BrowsingΒΆ
getMusicFolders
βοΈ
No parameter
getIndexes
βοΈ
Parameter
Vers.
musicFolderId
βοΈ
ifModifiedSince
βοΈ
getMusicDirectory
βοΈ
Parameter
Vers.
id
βοΈ
getGenres
βοΈ 1.9.0
No parameter
getArtists
βοΈ
Parameter
Vers.
musicFolderId
1.14.0
βοΈ
getArtist
βοΈ
Parameter
Vers.
id
βοΈ
getAlbum
βοΈ
Parameter
Vers.
id
βοΈ
getSong
βοΈ
Parameter
Vers.
id
βοΈ
getVideos
β
No parameter
getVideoInfo
π΄ 1.15.0
Parameter
Vers.
id
1.15.0
π΄
getArtistInfo
π 1.11.0
Parameter
Vers.
id
1.11.0
π
count
1.11.0
π
includeNotPresent
1.11.0
π
getArtistInfo2
π 1.11.0
Parameter
Vers.
id
1.11.0
π
count
1.11.0
π
includeNotPresent
1.11.0
π
getAlbumInfo
π 1.14.0
Parameter
Vers.
id
1.14.0
π
getAlbumInfo2
π 1.14.0
Parameter
Vers.
id
1.14.0
π
getSimilarSongs
β 1.11.0
Parameter
Vers.
id
1.11.0
β
count
1.11.0
β
getSimilarSongs2
β 1.11.0
Parameter
Vers.
id
1.11.0
β
count
1.11.0
β
getTopSongs
β 1.13.0
Parameter
Vers.
artist
1.13.0
β
count
1.13.0
β
Album/song listsΒΆ
getAlbumList
βοΈ
Parameter
Vers.
type
βοΈ
size
βοΈ
offset
βοΈ
fromYear
βοΈ
toYear
βοΈ
genre
βοΈ
musicFolderId
1.12.0
βοΈ
New in version 1.10.1:
byYear
andbyGenre
were added totype
getAlbumList2
βοΈ
Parameter
Vers.
type
βοΈ
size
βοΈ
offset
βοΈ
fromYear
βοΈ
toYear
βοΈ
genre
βοΈ
musicFolderId
1.12.0
βοΈ
New in version 1.10.1:
byYear
andbyGenre
were added totype
getRandomSongs
βοΈ
Parameter
Vers.
size
βοΈ
genre
βοΈ
fromYear
βοΈ
toYear
βοΈ
musicFolderId
βοΈ
getSongsByGenre
βοΈ 1.9.0
Parameter
Vers.
genre
1.9.0
βοΈ
count
1.9.0
βοΈ
offset
1.9.0
βοΈ
musicFolderId
1.12.0
βοΈ
getNowPlaying
βοΈ
No parameter
getStarred
βοΈ
Parameter
Vers.
musicFolderId
1.12.0
βοΈ
getStarred2
βοΈ
Parameter
Vers.
musicFolderId
1.12.0
βοΈ
SearchingΒΆ
search
βοΈ
Parameter
Vers.
artist
βοΈ
album
βοΈ
title
βοΈ
any
βοΈ
count
βοΈ
offset
βοΈ
newerThan
βοΈ
search2
βοΈ
Parameter
Vers.
query
βοΈ
artistCount
βοΈ
artistOffset
βοΈ
albumCount
βοΈ
albumOffset
βοΈ
songCount
βοΈ
songOffset
βοΈ
musicFolderId
1.12.0
βοΈ
search3
βοΈ
Parameter
Vers.
query
βοΈ
artistCount
βοΈ
artistOffset
βοΈ
albumCount
βοΈ
albumOffset
βοΈ
songCount
βοΈ
songOffset
βοΈ
musicFolderId
1.12.0
βοΈ
PlaylistsΒΆ
getPlaylists
βοΈ
Parameter
Vers.
username
βοΈ
getPlaylist
βοΈ
Parameter
Vers.
id
βοΈ
createPlaylist
βοΈ
Parameter
Vers.
playlistId
βοΈ
name
βοΈ
songId
βοΈ
updatePlaylist
βοΈ
Parameter
Vers.
playlistId
βοΈ
name
βοΈ
comment
βοΈ
public
1.9.0
βοΈ
songIdToAdd
βοΈ
songIndexToRemove
βοΈ
deletePlaylist
βοΈ
Parameter
Vers.
id
βοΈ
Media retrievalΒΆ
stream
βοΈ
Parameter
Vers.
id
βοΈ
maxBitRate
βοΈ
format
βοΈ
timeOffset
β
size
β
estimateContentLength
βοΈ
converted
1.15.0
π΄
download
βοΈ
Parameter
Vers.
id
βοΈ
hls
π΄ 1.9.0
Parameter
Vers.
id
1.9.0
π΄
bitRate
1.9.0
π΄
audioTrack
1.15.0
π΄
getCoverArt
βοΈ
Parameter
Vers.
id
βοΈ
size
βοΈ
getLyrics
βοΈ
Parameter
Vers.
artist
βοΈ
title
βοΈ
getAvatar
β
Parameter
Vers.
username
β
Media annotationΒΆ
star
βοΈ
Parameter
Vers.
id
βοΈ
albumId
βοΈ
artistId
βοΈ
unstar
βοΈ
Parameter
Vers.
id
βοΈ
albumId
βοΈ
artistId
βοΈ
setRating
βοΈ
Parameter
Vers.
id
βοΈ
rating
βοΈ
scrobble
βοΈ
Parameter
Vers.
id
βοΈ
time
1.9.0
βοΈ
submission
βοΈ
PodcastΒΆ
getPodcasts
β
Parameter
Vers.
includeEpisodes
1.9.0
β
id
1.9.0
β
getNewestPodcasts
β 1.14.0
Parameter
Vers.
count
1.14.0
β
refreshPodcasts
β 1.9.0
No parameter
createPodcastChannel
β 1.9.0
Parameter
Vers.
url
1.9.0
β
deletePodcastChannel
β 1.9.0
Parameter
Vers.
id
1.9.0
β
deletePodcastEpisode
β 1.9.0
Parameter
Vers.
id
1.9.0
β
downloadPodcastEpisode
β 1.9.0
Parameter
Vers.
id
1.9.0
β
JukeboxΒΆ
jukeboxControl
βοΈ
Parameter
Vers.
action
βοΈ
index
βοΈ
offset
βοΈ
id
βοΈ
gain
β
Internet radioΒΆ
getInternetRadioStations
β 1.9.0
No parameter
createInternetRadioStation
β 1.16.0
Parameter
Vers.
streamUrl
1.16.0
β
name
1.16.0
β
homepageUrl
1.16.0
β
updateInternetRadioStation
β 1.16.0
Parameter
Vers.
id
1.16.0
β
streamUrl
1.16.0
β
name
1.16.0
β
homepageUrl
1.16.0
β
deleteInternetRadioStation
β 1.16.0
Parameter
Vers.
id
1.16.0
β
ChatΒΆ
getChatMessages
βοΈ
Parameter
Vers.
since
βοΈ
addChatMessage
βοΈ
Parameter
Vers.
message
βοΈ
User managementΒΆ
getUser
βοΈ
Parameter
Vers.
username
βοΈ
getUsers
βοΈ 1.9.0
No parameter
createUser
βοΈ
Parameter
Vers.
username
βοΈ
password
βοΈ
email
βοΈ
ldapAuthenticated
adminRole
βοΈ
settingsRole
streamRole
jukeboxRole
βοΈ
downloadRole
uploadRole
playlistRole
coverArtRole
commentRole
podcastRole
shareRole
videoConversionRole
1.14.0
musicFolderId
1.12.0
π
updateUser
βοΈ 1.10.2
Parameter
Vers.
username
1.10.2
βοΈ
password
1.10.2
βοΈ
email
1.10.2
βοΈ
ldapAuthenticated
1.10.2
adminRole
1.10.2
βοΈ
settingsRole
1.10.2
streamRole
1.10.2
jukeboxRole
1.10.2
βοΈ
downloadRole
1.10.2
uploadRole
1.10.2
coverArtRole
1.10.2
commentRole
1.10.2
podcastRole
1.10.2
shareRole
1.10.2
videoConversionRole
1.14.0
musicFolderId
1.12.0
π
maxBitRate
1.13.0
π
deleteUser
βοΈ
Parameter
Vers.
username
βοΈ
changePassword
βοΈ
Parameter
Vers.
username
βοΈ
password
βοΈ
BookmarksΒΆ
getBookmarks
β 1.9.0
No parameter
createBookmark
β 1.9.0
Parameter
Vers.
id
1.9.0
β
position
1.9.0
β
comment
1.9.0
β
deleteBookmark
β 1.9.0
Parameter
Vers.
id
1.9.0
β
getPlayQueue
β 1.12.0
No parameter
savePlayQueue
β 1.12.0
Parameter
Vers.
id
1.12.0
β
current
1.12.0
β
position
1.12.0
β
Library scanningΒΆ
getScanStatus
βοΈ 1.15.0
No parameter
startScan
βοΈ 1.15.0
No parameter
Changes by versionΒΆ
Version 1.9.0ΒΆ
Added methods:
Added method parameters:
-
public
-
time
-
includeEpisodes
id
Version 1.10.1ΒΆ
Added method parameters:
-
fromYear
toYear
genre
-
fromYear
toYear
genre
Version 1.10.2ΒΆ
Added methods:
Version 1.11.0ΒΆ
Added methods:
Version 1.12.0ΒΆ
Added methods:
Added method parameters:
-
musicFolderId
-
musicFolderId
-
musicFolderId
-
musicFolderId
-
musicFolderId
-
musicFolderId
-
musicFolderId
-
musicFolderId
-
musicFolderId
Version 1.13.0ΒΆ
Added global parameters:
t
s
Added methods:
Added method parameters:
-
maxBitRate
Version 1.14.0ΒΆ
Added methods:
Added method parameters:
-
musicFolderId
-
videoConversionRole
-
videoConversionRole
Version 1.15.0ΒΆ
Added error code 41
Added methods:
Added method parameters:
Version 1.16.0ΒΆ
Added methods: