Change on OpenSubsonic

API Reference

Mon, 01 Jan 0001 00:00:00 +0000

Parameters

Please note that all methods take the following parameters:

Parameter	Req.	OpenS.	Default	Comment
`u`	Yes**			The username.
`p`	Yes*			The password, either in clear text or hex-encoded with a “enc:” prefix. Since 1.13.0 this should only be used for testing purposes.
`t`	Yes*			(Since 1.13.0) The authentication token computed as md5(password + salt). See below for details.
`s`	Yes*			(Since 1.13.0) A random string (“salt”) used as input for computing the password hash. See below for details.
`apiKey`	Yes**	Yes		[OS] An API key used for authentication
`v`	Yes			The protocol version implemented by the client, i.e., the version of the subsonic-rest-api.xsd schema used (see below).
`c`	Yes			A unique string identifying the client application.
`f`	No		xml	Request data to be returned in this format. Supported values are “xml”, “json” (since 1.4.0) and “jsonp” (since 1.6.0). If using jsonp, specify name of javascript callback function using a `callback` parameter.

*) Either p or both t and s must be specified.

AlbumID3

Mon, 01 Jan 0001 00:00:00 +0000

{
 "id": "ad0f112b6dcf83de5e9cae85d07f0d35",
 "name": "8-bit lagerfeuer",
 "version": "Deluxe Edition",
 "artist": "pornophonique",
 "year": 2007,
 "coverArt": "al-ad0f112b6dcf83de5e9cae85d07f0d35_640a93a8",
 "starred": "2023-03-22T01:51:06Z",
 "duration": 1954,
 "playCount": 97,
 "genre": "Hip-Hop",
 "created": "2023-03-10T02:19:35.784818075Z",
 "artistId": "91c3901ac465b9efc439e4be4270c2b6",
 "songCount": 8,
 "played": "2023-03-28T00:45:13Z",
 "userRating": 4,
 "recordLabels": [
 {
 "name": "Sony"
 }
 ],
 "musicBrainzId": "189002e7-3285-4e2e-92a3-7f6c30d407a2",
 "genres": [
 {
 "name": "Hip-Hop"
 },
 {
 "name": "East coast"
 }
 ],
 "artists": [
 {
 "id": "ar-1",
 "name": "Artist 1"
 },
 {
 "id": "ar-2",
 "name": "Artist 2"
 }
 ],
 "displayArtist": "Artist 1 feat. Artist 2",
 "releaseTypes": [
 "Album",
 "Remixes"
 ],
 "moods": [
 "slow",
 "cool"
 ],
 "sortName": "lagerfeuer (8-bit)",
 "originalReleaseDate": {
 "year": 2001,
 "month": 3,
 "day": 10
 },
 "releaseDate": {
 "year": 2001,
 "month": 3,
 "day": 10
 },
 "isCompilation": false,
 "explicitStatus": "explicit",
 "discTitles": [
 {
 "disc": 0,
 "title": "Disc 0 title"
 "coverArt": "42"
 },
 {
 "disc": 2,
 "title": "Disc 1 title"
 "coverArt": "6547"
 }
 ]
}

{
 "id": "ad0f112b6dcf83de5e9cae85d07f0d35",
 "name": "8-bit lagerfeuer",
 "artist": "pornophonique",
 "year": 2007,
 "coverArt": "al-ad0f112b6dcf83de5e9cae85d07f0d35_640a93a8",
 "starred": "2023-03-22T01:51:06Z",
 "duration": 1954,
 "playCount": 97,
 "genre": "Hip-Hop",
 "created": "2023-03-10T02:19:35.784818075Z",
 "artistId": "91c3901ac465b9efc439e4be4270c2b6",
 "songCount": 8
}

Field	Type	Req.	OpenS.	Details
`id`	`string`	Yes		The id of the album
`name`	`string`	Yes		The album name.
`version`	`string`	No	Yes	The album version name (Remastered, Anniversary Box Set, …).
`artist`	`string`	No		Artist name.
`artistId`	`string`	No		The id of the artist
`coverArt`	`string`	No		A covertArt id.
`songCount`	`int`	Yes		Number of songs
`duration`	`int`	Yes		Total duration of the album in seconds
`playCount`	`long`	No		Number of play of the album
`created`	`string`	Yes		Date the album was added. [ISO 8601]
`starred`	`string`	No		Date the album was starred. [ISO 8601]
`year`	`int`	No		The album year
`genre`	`string`	No		The album genre
`played`	`string`	No	Yes	Date the album was last played. [ISO 8601]
`userRating`	`int`	No	Yes	The user rating of the album. [1-5]
`recordLabels`	Array of `RecordLabel`	No	Yes	The labels producing the album.
`musicBrainzId`	`string`	No	Yes	The album MusicBrainzID.
`genres`	Array of `ItemGenre`	No	Yes	The list of all genres of the album.
`artists`	Array of `ArtistID3`	No	Yes	The list of all album artists of the album. (Note: Only the required `ArtistID3` fields should be returned by default)
`displayArtist`	`string`	No	Yes	The single value display artist.
`releaseTypes`	Array of `string`	No	Yes	The types of this album release. (Album, Compilation, EP, Remix, …).
`moods`	Array of `string`	No	Yes	The list of all moods of the album.
`sortName`	`string`	No	Yes	The album sort name.
`originalReleaseDate`	`ItemDate`	No	Yes	Date the album was originally released.
`releaseDate`	`ItemDate`	No	Yes	Date the specific edition of the album was released. Note: for files using ID3 tags, releaseDate should generally be read from the TDRL tag. Servers that use a different source for this field should document the behavior.
`isCompilation`	`boolean`	No	Yes	True if the album is a compilation.
`explicitStatus`	`string`	No	Yes	Returns “explicit” if at least one song is explicit, “clean” if no song is explicit and at least one is “clean” else “”.
`discTitles`	Array of `DiscTitle`	No	Yes	The list of all disc titles of the album.

OpenSubsonic

New fields are added:

AlbumID3WithSongs

Mon, 01 Jan 0001 00:00:00 +0000

{
 "id": "ad0f112b6dcf83de5e9cae85d07f0d35",
 "name": "8-bit lagerfeuer",
 "version": "Deluxe Edition",
 "artist": "pornophonique",
 "year": 2007,
 "coverArt": "al-ad0f112b6dcf83de5e9cae85d07f0d35_640a93a8",
 "starred": "2023-03-22T01:51:06Z",
 "duration": 1954,
 "playCount": 97,
 "genre": "Hip-Hop",
 "created": "2023-03-10T02:19:35.784818075Z",
 "artistId": "91c3901ac465b9efc439e4be4270c2b6",
 "songCount": 8,
 "played": "2023-03-28T00:45:13Z",
 "userRating": 4,
 "recordLabels": [
 {
 "name": "Sony"
 }
 ],
 "musicBrainzId": "189002e7-3285-4e2e-92a3-7f6c30d407a2",
 "genres": [
 {
 "name": "Hip-Hop"
 },
 {
 "name": "East coast"
 }
 ],
 "artists": [
 {
 "id": "ar-1",
 "name": "Artist 1"
 },
 {
 "id": "ar-2",
 "name": "Artist 2"
 }
 ],
 "displayArtist": "Artist 1 feat. Artist 2",
 "releaseTypes": [
 "Album",
 "Remixes"
 ],
 "moods": [
 "slow",
 "cool"
 ],
 "sortName": "lagerfeuer (8-bit)",
 "originalReleaseDate": {
 "year": 2001,
 "month": 3,
 "day": 10
 },
 "releaseDate": {
 "year": 2001,
 "month": 3,
 "day": 10
 },
 "isCompilation": false,
 "explicitStatus": "explicit",
 "discTitles": [
 {
 "disc": 0,
 "title": "Disc 0 title"
 "coverArt": "100000111",
 },
 {
 "disc": 2,
 "title": "Disc 1 title"
 "coverArt": "100000117",
 }
 ],
 "song": [
 {
 "id": "300000116",
 "parent": "200000021",
 "title": "Can I Help U?",
 "isDir": false,
 "isVideo": false,
 "type": "music",
 "albumId": "200000021",
 "album": "Forget and Remember",
 "artistId": "100000036",
 "artist": "Comfort Fit",
 "coverArt": "300000116",
 "duration": 103,
 "bitRate": 216,
 "bitDepth": 16,
 "samplingRate": 44100,
 "channelCount": 2,
 "track": 1,
 "year": 2005,
 "genre": "Hip-Hop",
 "size": 2811819,
 "discNumber": 1,
 "suffix": "mp3",
 "explicitStatus": "explicit",
 "contentType": "audio/mpeg",
 "path": "user/Comfort Fit/Forget And Remember/1 - Can I Help U?.mp3"
 },
 {
 "id": "300000121",
 "parent": "200000021",
 "title": "Planetary Picknick",
 "isDir": false,
 "isVideo": false,
 "type": "music",
 "albumId": "200000021",
 "album": "Forget and Remember",
 "artistId": "100000036",
 "artist": "Comfort Fit",
 "coverArt": "300000121",
 "duration": 358,
 "bitRate": 238,
 "bitDepth": 16,
 "samplingRate": 44100,
 "channelCount": 2,
 "track": 2,
 "year": 2005,
 "genre": "Hip-Hop",
 "size": 10715592,
 "discNumber": 1,
 "suffix": "mp3",
 "explicitStatus": "clean",
 "contentType": "audio/mpeg",
 "path": "user/Comfort Fit/Forget And Remember/2 - Planetary Picknick.mp3"
 }
 ]
}

{
 "id": "200000021",
 "parent": "100000036",
 "album": "Forget and Remember",
 "title": "Forget and Remember",
 "name": "Forget and Remember",
 "isDir": true,
 "coverArt": "al-200000021",
 "songCount": 20,
 "created": "2021-07-22T02:09:31+00:00",
 "duration": 4248,
 "playCount": 0,
 "artistId": "100000036",
 "artist": "Comfort Fit",
 "year": 2005,
 "genre": "Hip-Hop",
 "song": [
 {
 "id": "300000116",
 "parent": "200000021",
 "title": "Can I Help U?",
 "isDir": false,
 "isVideo": false,
 "type": "music",
 "albumId": "200000021",
 "album": "Forget and Remember",
 "artistId": "100000036",
 "artist": "Comfort Fit",
 "coverArt": "300000116",
 "duration": 103,
 "bitRate": 216,
 "bitDepth": 16,
 "samplingRate": 44100,
 "channelCount": 2,
 "track": 1,
 "year": 2005,
 "genre": "Hip-Hop",
 "size": 2811819,
 "discNumber": 1,
 "suffix": "mp3",
 "contentType": "audio/mpeg",
 "path": "user/Comfort Fit/Forget And Remember/1 - Can I Help U?.mp3"
 },
 {
 "id": "300000121",
 "parent": "200000021",
 "title": "Planetary Picknick",
 "isDir": false,
 "isVideo": false,
 "type": "music",
 "albumId": "200000021",
 "album": "Forget and Remember",
 "artistId": "100000036",
 "artist": "Comfort Fit",
 "coverArt": "300000121",
 "duration": 358,
 "bitRate": 238,
 "bitDepth": 16,
 "samplingRate": 44100,
 "channelCount": 2,
 "track": 2,
 "year": 2005,
 "genre": "Hip-Hop",
 "size": 10715592,
 "discNumber": 1,
 "suffix": "mp3",
 "contentType": "audio/mpeg",
 "path": "user/Comfort Fit/Forget And Remember/2 - Planetary Picknick.mp3"
 }
 ]
}

Field	Type	Req.	OpenS.	Details
`id`	`string`	Yes		The id of the album
`name`	`string`	Yes		The album name.
`version`	`string`	No	Yes	The album version name (Remastered, Anniversary Box Set, …).
`artist`	`string`	No		Artist name.
`artistId`	`string`	No		The id of the artist
`coverArt`	`string`	No		A covertArt id.
`songCount`	`int`	Yes		Number of songs
`duration`	`int`	Yes		Total duration of the album in seconds
`playCount`	`long`	No		Number of play of the album
`created`	`string`	Yes		Date the album was added. [ISO 8601]
`starred`	`string`	No		Date the album was starred. [ISO 8601]
`year`	`int`	No		The album year
`genre`	`string`	No		The album genre
`played`	`string`	No	Yes	Date the album was last played. [ISO 8601]
`userRating`	`int`	No	Yes	The user rating of the album. [1-5]
`recordLabels`	Array of `RecordLabel`	No	Yes	The labels producing the album.
`musicBrainzId`	`string`	No	Yes	The album MusicBrainzID.
`genres`	Array of `ItemGenre`	No	Yes	The list of all genres of the album.
`artists`	Array of `ArtistID3`	No	Yes	The list of all album artists of the album.
`displayArtist`	`string`	No	Yes	The single value display artist.
`releaseTypes`	Array of `string`	No	Yes	The types of this album release. (Album, Compilation, EP, Remix, …).
`moods`	Array of `string`	No	Yes	The list of all moods of the album.
`sortName`	`string`	No	Yes	The album sort name.
`originalReleaseDate`	`ItemDate`	No	Yes	Date the album was originally released.
`releaseDate`	`ItemDate`	No	Yes	Date the specific edition of the album was released. Note: for files using ID3 tags, releaseDate should generally be read from the TDRL tag. Servers that use a different source for this field should document the behavior.
`isCompilation`	`boolean`	No	Yes	True if the album is a compilation.
`explicitStatus`	`string`	No	Yes	Returns “explicit” if at least one song is explicit, “clean” if no song is explicit and at least one is “clean” else “”.
`discTitles`	Array of `DiscTitle`	No	Yes	The list of all disc titles of the album.
`song`	Array of `Child`	No		The list of songs

OpenSubsonic

New fields are added:

ArtistID3

Mon, 01 Jan 0001 00:00:00 +0000

{
 "id": "37ec820ca7193e17040c98f7da7c4b51",
 "name": "2 Mello",
 "coverArt": "ar-37ec820ca7193e17040c98f7da7c4b51_0",
 "albumCount": 1,
 "userRating": 5,
 "artistImageUrl": "https://demo.org/image.jpg",
 "starred": "2017-04-11T10:42:50.842Z",
 "musicBrainzId": "189002e7-3285-4e2e-92a3-7f6c30d407a2",
 "sortName": "Mello (2)",
 "roles": [
 "artist",
 "albumartist",
 "composer"
 ]
}

{
 "id": "37ec820ca7193e17040c98f7da7c4b51",
 "name": "2 Mello",
 "coverArt": "ar-37ec820ca7193e17040c98f7da7c4b51_0",
 "albumCount": 1,
 "userRating": 5,
 "artistImageUrl": "https://demo.org/image.jpg",
 "starred": "2017-04-11T10:42:50.842Z"
}

Field	Type	Req.	OpenS.	Details
`id`	`string`	Yes		The id of the artist
`name`	`string`	Yes		The artist name.
`coverArt`	`string`	No		A covertArt id.
`artistImageUrl`	`string`	No		An url to an external image source.
`albumCount`	`int`	No		Artist album count.
`starred`	`string`	No		Date the artist was starred. [ISO 8601]
`musicBrainzId`	`string`	No	Yes	The artist MusicBrainzID.
`sortName`	`string`	No	Yes	The artist sort name.
`roles`	Array of `string`	No	Yes	The list of all roles this artist has in the library.

OpenSubsonic

New fields are added:

Child

Mon, 01 Jan 0001 00:00:00 +0000

{
 "id": "082f435a363c32c57d5edb6a678a28d4",
 "parent": "e8a0685e3f3ec6f251649af2b58b8617",
 "isDir": false,
 "title": "\"polar expedition\"",
 "album": "Live at The Casbah - 2005-04-29",
 "artist": "The New Deal",
 "track": 4,
 "year": 2005,
 "coverArt": "mf-082f435a363c32c57d5edb6a678a28d4_6410b3ce",
 "size": 19866778,
 "contentType": "audio/flac",
 "suffix": "flac",
 "starred": "2023-03-27T09:45:27Z",
 "duration": 178,
 "bitRate": 880,
 "bitDepth": 16,
 "samplingRate": 44100,
 "channelCount": 2,
 "path": "The New Deal/Live at The Casbah - 2005-04-29/04 - \"polar expedition\".flac",
 "playCount": 8,
 "played": "2023-03-26T22:27:46Z",
 "discNumber": 1,
 "created": "2023-03-14T17:51:22.112827504Z",
 "albumId": "e8a0685e3f3ec6f251649af2b58b8617",
 "artistId": "97e0398acf63f9fb930d7d4ce209a52b",
 "type": "music",
 "mediaType": "song",
 "isVideo": false,
 "bpm": 134,
 "comment": "This is a song comment",
 "sortName": "Polar expedition",
 "musicBrainzId": "189002e7-3285-4e2e-92a3-7f6c30d407a2",
 "isrc": [
 "USSM18300073",
 "DELV42300297",
 "DEE868300011",
 "DEE868300007"
 ],
 "genres": [
 {
 "name": "Hip-Hop"
 },
 {
 "name": "East coast"
 }
 ],
 "artists": [
 {
 "id": "ar-1",
 "name": "Artist 1"
 },
 {
 "id": "ar-2",
 "name": "Artist 2"
 }
 ],
 "displayArtist": "Artist 1 feat. Artist 2",
 "albumArtists": [
 {
 "id": "ar-6",
 "name": "Artist 6"
 },
 {
 "id": "ar-7",
 "name": "Artist 7"
 }
 ],
 "displayAlbumArtist": "Artist 6 & Artist 7",
 "contributors": [
 {
 "role": "composer",
 "artist": {
 "id": "ar-3",
 "name": "Artist 3"
 }
 },
 {
 "role": "composer",
 "artist": {
 "id": "ar-4",
 "name": "Artist 4"
 }
 },
 {
 "role": "lyricist",
 "artist": {
 "id": "ar-5",
 "name": "Artist 5"
 }
 },
 {
 "role": "performer",
 "subRole": "Bass",
 "artist": {
 "id": "ar-5",
 "name": "Artist 5"
 }
 }
 ],
 "displayComposer": "Artist 3, Artist 4",
 "moods": [
 "slow",
 "cool"
 ],
 "explicitStatus": "explicit",
 "replayGain": {
 "trackGain": 0.1,
 "albumGain": 1.1,
 "trackPeak": 9.2,
 "albumPeak": 9,
 "baseGain": 0
 },
 "works": [
 {
 "name": "Symphony No. 5 in C minor, Op. 67",
 "musicBrainzId": "d03bff61-26fc-301b-98ac-4d8e85771cbc"
 }
 ],
 "movements": [
 {
 "name": "Andante con moto",
 "number": 2,
 "count": 4
 }
 ]
}

{
 "id": "082f435a363c32c57d5edb6a678a28d4",
 "parent": "e8a0685e3f3ec6f251649af2b58b8617",
 "isDir": false,
 "title": "\"polar expedition\"",
 "album": "Live at The Casbah - 2005-04-29",
 "artist": "The New Deal",
 "track": 4,
 "year": 2005,
 "coverArt": "mf-082f435a363c32c57d5edb6a678a28d4_6410b3ce",
 "size": 19866778,
 "contentType": "audio/flac",
 "suffix": "flac",
 "starred": "2023-03-27T09:45:27Z",
 "duration": 178,
 "bitRate": 880,
 "bitDepth": 16,
 "samplingRate": 44100,
 "channelCount": 2,
 "path": "The New Deal/Live at The Casbah - 2005-04-29/04 - \"polar expedition\".flac",
 "playCount": 8,
 "discNumber": 1,
 "created": "2023-03-14T17:51:22.112827504Z",
 "albumId": "e8a0685e3f3ec6f251649af2b58b8617",
 "artistId": "97e0398acf63f9fb930d7d4ce209a52b",
 "type": "music",
 "isVideo": false
}

Field	Type	Req.	OpenS.	Details
`id`	`string`	Yes		The id of the media
`parent`	`string`	No		The id of the parent (folder/album)
`isDir`	`boolean`	Yes		The media is a directory
`title`	`string`	Yes		The media name.
`album`	`string`	No		The album name.
`artist`	`string`	No		The artist name.
`track`	`int`	No		The track number.
`year`	`int`	No		The media year.
`genre`	`string`	No		The media genre
`coverArt`	`string`	No		A covertArt id.
`size`	`long`	No		A file size of the media.
`contentType`	`string`	No		The mimeType of the media.
`suffix`	`string`	No		The file suffix of the media.
`transcodedContentType`	`string`	No		The transcoded mediaType if transcoding should happen.
`transcodedSuffix`	`string`	No		The file suffix of the transcoded media.
`duration`	`int`	No		The duration of the media in seconds.
`bitRate`	`int`	No		The bitrate of the media.
`bitDepth`	`int`	No	Yes	The bit depth of the media.
`samplingRate`	`int`	No	Yes	The sampling rate of the media.
`channelCount`	`int`	No	Yes	The number of channels of the media.
`path`	`string`	No		The full path of the media.
`isVideo`	`boolean`	No		Media is a video
`userRating`	`int`	No		The user rating of the media [1-5]
`averageRating`	`number`	No		The average rating of the media [1.0-5.0]
`playCount`	`long`	No		The play count.
`discNumber`	`int`	No		The disc number.
`created`	`string`	No		Date the media was created. [ISO 8601]
`starred`	`string`	No		Date the media was starred. [ISO 8601]
`albumId`	`string`	No		The corresponding album id
`artistId`	`string`	No		The corresponding artist id
`type`	`string`	No		The generic type of media [music/podcast/audiobook/video]
`mediaType`	`string`	No	Yes	The actual media type [song/album/artist] Note: If you support `musicBrainzId` you must support this field to ensure clients knows what the ID refers to.
`bookmarkPosition`	`long`	No		The bookmark position in seconds
`originalWidth`	`int`	No		The video original Width
`originalHeight`	`int`	No		The video original Height
`played`	`string`	No	Yes	Date the album was last played. [ISO 8601]
`bpm`	`int`	No	Yes	The BPM of the song.
`comment`	`string`	No	Yes	The comment tag of the song.
`sortName`	`string`	No	Yes	The song sort name.
`musicBrainzId`	`string`	No	Yes	The track MusicBrainzID.
`isrc`	Array of `string`	No	Yes	The track ISRC(s).
`genres`	Array of `ItemGenre`	No	Yes	The list of all genres of the song.
`artists`	Array of `ArtistID3`	No	Yes	The list of all song artists of the song. (Note: Only the required `ArtistID3` fields should be returned by default)
`displayArtist`	`string`	No	Yes	The single value display artist.
`albumArtists`	Array of `ArtistID3`	No	Yes	The list of all album artists of the song. (Note: Only the required `ArtistID3` fields should be returned by default)
`displayAlbumArtist`	`string`	No	Yes	The single value display album artist.
`contributors`	Array of `Contributor`	No	Yes	The list of all contributor artists of the song.
`displayComposer`	`string`	No	Yes	The single value display composer.
`moods`	Array of `string`	No	Yes	The list of all moods of the song.
`replayGain`	`ReplayGain`	No	Yes	The replaygain data of the song.
`explicitStatus`	`string`	No	Yes	Returns “explicit”, “clean” or “”. (For songs extracted from tags “ITUNESADVISORY”: 1 = explicit, 2 = clean, MP4 “rtng”: 1 or 4 = explicit, 2 = clean. See `albumID3` for albums)
`works`	Array of `Work`	No	Yes	The list of works associated with the song.
`movements`	Array of `Movement`	No	Yes	The list of movements associated with the song.

OpenSubsonic

New fields are added:

error

Mon, 01 Jan 0001 00:00:00 +0000

{
 "code": 42,
 "message": "Authentication mechanism not supported. Use API keys",
 "helpUrl": "https://example.org/users/apiKey"
}

{
 "code": 40,
 "message": "Wrong username or password"
}

Field	Type	Req.	OpenS.	Details
`code`	`int`	Yes		The error code
`message`	`string`	No		The optional error message
`helpUrl`	`string`	No	Yes	A URL (documentation, configuration, etc) which may provide additional context for the error)

The following error codes are defined:

getNowPlaying

Mon, 01 Jan 0001 00:00:00 +0000

http://your-server/rest/getNowPlaying Since 1.0.0

Returns what is currently being played by all users. Takes no extra parameters.

Parameters

Takes no extra parameters.

Example

http://your-server/rest/getNowPlaying.view?u=demo&p=demo&v=1.13.0&c=AwesomeClientName&f=json

Result

A subsonic-response element with a nested nowPlaying element on success.

{
 "subsonic-response": {
 "status": "ok",
 "version": "1.16.1",
 "type": "AwesomeServerName",
 "serverVersion": "0.1.3 (tag)",
 "openSubsonic": true,
 "nowPlaying": {
 "entry": [
 {
 "id": "300115266",
 "parent": "200147046",
 "title": "Take the Home",
 "isDir": false,
 "isVideo": false,
 "type": "music",
 "albumId": "200147046",
 "album": "How I Learned to Love Our Robot Overlords",
 "artistId": "100002619",
 "artist": "Raggedy Angry",
 "coverArt": "300115266",
 "duration": 227,
 "bitRate": 222,
 "bitDepth": 16,
 "samplingRate": 44100,
 "channelCount": 2,
 "userRating": 3,
 "track": 7,
 "year": 2010,
 "genre": "Industrial",
 "size": 6341039,
 "discNumber": 1,
 "suffix": "mp3",
 "contentType": "audio/mpeg",
 "path": "Raggedy Angry/(2010) How I Learned to Love Our Robot Overlords/1-07 - Take the Home.mp3",
 "username": "user",
 "minutesAgo": 0,
 "playerId": 0,
 "state": "playing",
 "positionMs": 120000,
 "playbackRate": 1.0,
 }
 ]
 }
 }
}

{
 "subsonic-response": {
 "status": "ok",
 "version": "1.16.1",
 "nowPlaying": {
 "entry": [
 {
 "id": "300115266",
 "parent": "200147046",
 "title": "Take the Home",
 "isDir": false,
 "isVideo": false,
 "type": "music",
 "albumId": "200147046",
 "album": "How I Learned to Love Our Robot Overlords",
 "artistId": "100002619",
 "artist": "Raggedy Angry",
 "coverArt": "300115266",
 "duration": 227,
 "bitRate": 222,
 "bitDepth": 16,
 "samplingRate": 44100,
 "channelCount": 2,
 "userRating": 3,
 "track": 7,
 "year": 2010,
 "genre": "Industrial",
 "size": 6341039,
 "discNumber": 1,
 "suffix": "mp3",
 "contentType": "audio/mpeg",
 "path": "Raggedy Angry/(2010) How I Learned to Love Our Robot Overlords/1-07 - Take the Home.mp3",
 "username": "user",
 "minutesAgo": 0,
 "playerId": 0
 }
 ]
 }
 }
}

Field	Type	Req.	OpenS.	Details
`nowPlaying`	`nowPlaying`	Yes		The now playing content

OpenSubsonic

When the server supports extension playbackReport, entries can include state, positionMs, and playbackRate.

playlist

Mon, 01 Jan 0001 00:00:00 +0000

{
 "id": "800000075",
 "name": "testcreate",
 "owner": "user",
 "public": true,
 "created": "2023-03-16T03:18:41+00:00",
 "changed": "2023-03-16T03:18:41+00:00",
 "songCount": 1,
 "duration": 304,
 "readonly": true,
 "validUntil": "2023-03-23T03:18:41+00:00"
}

{
 "id": "800000075",
 "name": "testcreate",
 "owner": "user",
 "public": true,
 "created": "2023-03-16T03:18:41+00:00",
 "changed": "2023-03-16T03:18:41+00:00",
 "songCount": 1,
 "duration": 304
}

Field	Type	Req.	OpenS.	Details
`id`	`string`	Yes		Id of the playlist
`name`	`string`	Yes		Name of the playlist
`comment`	`string`	No		A commnet
`owner`	`string`	No		Owner of the playlist
`public`	`boolean`	No		Is the playlist public
`songCount`	`int`	Yes		number of songs
`duration`	`int`	Yes		Playlist duration in seconds
`created`	`string`	Yes		Creation date [ISO 8601]
`changed`	`string`	Yes		Last changed date [ISO 8601]
`coverArt`	`string`	No		A cover Art Id
`allowedUser`	Array of `string`	No		A list of allowed usernames
`readonly`	`boolean`	No	Yes	If true the playlist cannot be edited by the current user
`validUntil`	`string`	No	Yes	Date the playlist contents are considered valid until [ISO 8601]

OpenSubsonic

New fields are added:

playlistWithSongs

Mon, 01 Jan 0001 00:00:00 +0000

{
 "id": "800000075",
 "name": "testcreate",
 "owner": "user",
 "public": true,
 "created": "2023-03-16T03:18:41+00:00",
 "changed": "2023-03-16T03:18:41+00:00",
 "songCount": 1,
 "duration": 304,
 "readonly": true,
 "validUntil": "2023-03-23T03:18:41+00:00",
 "entry": [
 {
 "id": "300000060",
 "parent": "200000002",
 "title": "BrownSmoke",
 "isDir": false,
 "isVideo": false,
 "type": "music",
 "albumId": "200000002",
 "album": "Colorsmoke EP",
 "artistId": "100000002",
 "artist": "Synthetic",
 "coverArt": "300000060",
 "duration": 304,
 "bitRate": 20,
 "bitDepth": 16,
 "samplingRate": 44100,
 "channelCount": 2,
 "userRating": 5,
 "averageRating": 5,
 "track": 4,
 "year": 2007,
 "genre": "Electronic",
 "size": 792375,
 "discNumber": 1,
 "suffix": "wma",
 "contentType": "audio/x-ms-wma",
 "path": "Synthetic/Synthetic_-_Colorsmoke_EP-20k217-2007/04-Synthetic_-_BrownSmokeYSBM20k22khS.wma"
 }
 ]
}

{
 "id": "800000075",
 "name": "testcreate",
 "owner": "user",
 "public": true,
 "created": "2023-03-16T03:18:41+00:00",
 "changed": "2023-03-16T03:18:41+00:00",
 "songCount": 1,
 "duration": 304,
 "entry": [
 {
 "id": "300000060",
 "parent": "200000002",
 "title": "BrownSmoke",
 "isDir": false,
 "isVideo": false,
 "type": "music",
 "albumId": "200000002",
 "album": "Colorsmoke EP",
 "artistId": "100000002",
 "artist": "Synthetic",
 "coverArt": "300000060",
 "duration": 304,
 "bitRate": 20,
 "bitDepth": 16,
 "samplingRate": 44100,
 "channelCount": 2,
 "userRating": 5,
 "averageRating": 5,
 "track": 4,
 "year": 2007,
 "genre": "Electronic",
 "size": 792375,
 "discNumber": 1,
 "suffix": "wma",
 "contentType": "audio/x-ms-wma",
 "path": "Synthetic/Synthetic_-_Colorsmoke_EP-20k217-2007/04-Synthetic_-_BrownSmokeYSBM20k22khS.wma"
 }
 ]
}

Field	Type	Req.	OpenS.	Details
`id`	`string`	Yes		Id of the playlist
`name`	`string`	Yes		Name of the playlist
`comment`	`string`	No		A comment
`owner`	`string`	No		Owner of the playlist
`public`	`boolean`	No		Is the playlist public
`songCount`	`int`	Yes		number of songs
`duration`	`int`	Yes		Playlist duration in seconds
`created`	`string`	Yes		Creation date [ISO 8601]
`changed`	`string`	Yes		Last changed date [ISO 8601]
`coverArt`	`string`	No		A cover Art Id
`allowedUser`	Array of `string`	No		A list of allowed usernames
`readonly`	`boolean`	No	Yes	If true the playlist cannot be edited by the current user
`validUntil`	`string`	No	Yes	Date the playlist contents are considered valid until [ISO 8601]
`entry`	Array of `Child`	No		The list of songs

OpenSubsonic

New fields are added:

PlayQueue

Mon, 01 Jan 0001 00:00:00 +0000

{
 "current": "1234",
 "position": 1000,
 "username": "user",
 "changed": "2023-03-10T02:19:35.784818075Z",
 "changedBy": "example client",
 "entry": [
 {
 "id": "1234",
 "parent": "200000021",
 "title": "Can I Help U?",
 "isDir": false,
 "isVideo": false,
 "type": "music",
 "albumId": "200000021",
 "album": "Forget and Remember",
 "artistId": "100000036",
 "artist": "Comfort Fit",
 "coverArt": "1234",
 "duration": 103,
 "bitRate": 216,
 "bitDepth": 16,
 "samplingRate": 44100,
 "channelCount": 2,
 "track": 1,
 "year": 2005,
 "genre": "Hip-Hop",
 "size": 2811819,
 "discNumber": 1,
 "suffix": "mp3",
 "contentType": "audio/mpeg",
 "path": "user/Comfort Fit/Forget And Remember/1 - Can I Help U?.mp3"
 }
 ]
}

{
 "current": "1234",
 "position": 1000,
 "username": "user",
 "changed": "2023-03-10T02:19:35.784818075Z",
 "changedBy": "example client",
 "entry": [
 {
 "id": "1234",
 "parent": "200000021",
 "title": "Can I Help U?",
 "isDir": false,
 "isVideo": false,
 "type": "music",
 "albumId": "200000021",
 "album": "Forget and Remember",
 "artistId": "100000036",
 "artist": "Comfort Fit",
 "coverArt": "1234",
 "duration": 103,
 "bitRate": 216,
 "bitDepth": 16,
 "samplingRate": 44100,
 "channelCount": 2,
 "track": 1,
 "year": 2005,
 "genre": "Hip-Hop",
 "size": 2811819,
 "discNumber": 1,
 "suffix": "mp3",
 "contentType": "audio/mpeg",
 "path": "user/Comfort Fit/Forget And Remember/1 - Can I Help U?.mp3"
 }
 ]
}

OpenSubsonic

Errata: In the original spec, current is required to be an int. However, as child ids are strings, this is updated to note that the id should be a string to be consistent.

Field	Type	Req.	Details
`current`	`string`	No*	ID of currently playing track
`position`	`long`	No	Position in milliseconds of currently playing track
`username`	`string`	Yes	The user this queue belongs to
`changed`	`string`	Yes	Date modified [ISO 8601]
`changedBy`	`string`	Yes	Name of client app
`entry`	Array of `Child`	No	The list of songs in the queue

OpenSubsonic

* If entry exists and is non-empty, OpenSubsonic servers must ensure that current exists and is a valid id in the list of songs.

savePlayQueue

Mon, 01 Jan 0001 00:00:00 +0000

http://your-server/rest/savePlayQueue Since 1.12.0

Saves the state of the play queue for this user. This includes the tracks in the play queue, the currently playing track, and the position within this track. Typically used to allow a user to move between different clients/apps while retaining the same play queue (for instance when listening to an audio book).

Parameters

Parameter	Req.	Comment
`id`	No	ID of a song in the play queue. Use one `id` parameter for each song in the play queue.
`current`	Yes (subsonic) / No (OpenSubsonic)*	The ID of the current playing song.
`position`	No	The position in milliseconds within the currently playing song.

Errata/OpenSubsonic

* In the original Subsonic, despite the claims that current is optional, it was required and must be in the list of id.

subsonic-response

Mon, 01 Jan 0001 00:00:00 +0000

{
 "subsonic-response": {
 "status": "ok",
 "version": "1.16.1",
 "type": "AwesomeServerName",
 "serverVersion": "0.1.3 (tag)",
 "openSubsonic": true
 }
}

{
 "subsonic-response": {
 "status": "ok",
 "version": "1.16.1"
 }
}

Field	Type	Req.	OpenS.	Details
`status`	`string`	Yes		The command result. `ok` or `failed`
`version`	`string`	Yes		The server supported Subsonic API version.
`type`	`string`	Yes	Yes	The server actual name. [Ex: `Navidrome` or `gonic`]
`serverVersion`	`string`	Yes	Yes	The server actual version. [Ex: `1.2.3 (beta)`]
`openSubsonic`	`boolean`	Yes	Yes	Must return true if the server support OpenSubsonic API v1
`error`	`error`	No		The error details when `status` is `failed`

OpenSubsonic

New fields are added: