Browsing on OpenSubsonic

findSonicPath

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

http://your-server/rest/findSonicPath

Finds a path of songs connecting a start song to an end song, navigating through audio similarity space.

Parameters

Parameter	Req.	Default	Comment
`startSongId`	Yes		The ID of the starting song.
`endSongId`	Yes		The ID of the ending/target song.
`count`	No	25	Maximum number of songs in the path.

Example

http://your-server/rest/findSonicPath.view?startSongId=100&endSongId=200&count=5&u=demo&p=demo&v=1.13.0&c=AwesomeClientName&f=json

Result

A subsonic-response element with a top-level sonicMatch array on success. The returned path MUST contain the start song as the first entry and the end song as the last entry.

getAlbum

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

http://your-server/rest/getAlbum Since 1.8.0

Returns details for an album, including a list of songs. This method organizes music according to ID3 tags.

Parameters

Parameter	Req.	OpenS.	Default	Comment
`id`	Yes			The album ID.

Example

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

Result

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

{
 "subsonic-response": {
 "status": "ok",
 "version": "1.16.1",
 "type": "AwesomeServerName",
 "serverVersion": "0.1.3 (tag)",
 "openSubsonic": true,
 "album": {
 "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"
 }
 ]
 }
 }
}

{
 "subsonic-response": {
 "status": "ok",
 "version": "1.16.1",
 "album": {
 "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
`album`	`AlbumID3WithSongs`	Yes		The album

getAlbumInfo

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

http://your-server/rest/getAlbumInfo Since 1.14.0

Returns album notes, image URLs etc, using data from last.fm.

Parameters

Parameter	Req.	OpenS.	Default	Comment
`id`	Yes			The album ID or song ID.

Example

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

Result

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

{
 "subsonic-response": {
 "status": "ok",
 "version": "1.16.1",
 "type": "AwesomeServerName",
 "serverVersion": "0.1.3 (tag)",
 "openSubsonic": true,
 "albumInfo": {
 "notes": "Download the full release here (creative commons). These cripsy beats are ripe with thumping funk and techno influences, sample wizardry and daring shuffles. Composed with the help of unique sound plugins which were especially programmed to measure Comfort Fit’s needs and wishes, we think the chances aren’t bad that you’ll fall for the unique sound signature, bounce and elegance of this unusual Hip Hop production. Ltj bukem / Good looking Rec., UK: \"Really love this music.\" Velanche / XLR8R, UK: \"Awesome job he's done... overall production is dope.\" Kwesi / BBE Music, UK: \"Wooooooowwwww... WHAT THE FUCK! THIS IS WHAT",
 "musicBrainzId": "6e1d48f7-717c-416e-af35-5d2454a13af2",
 "smallImageUrl": "http://localhost:8989/play/art/0f8c3cbd6b0b22c3b5402141351ac812/album/21/thumb34.jpg",
 "mediumImageUrl": "http://localhost:8989/play/art/41b16680dc1b3aaf5dfba24ddb6a1712/album/21/thumb64.jpg",
 "largeImageUrl": "http://localhost:8989/play/art/e6fd8d4e0d35c4436e56991892bfb27b/album/21/thumb174.jpg"
 }
 }
}

{
 "subsonic-response": {
 "status": "ok",
 "version": "1.16.1",
 "albumInfo": {
 "notes": "Download the full release here (creative commons). These cripsy beats are ripe with thumping funk and techno influences, sample wizardry and daring shuffles. Composed with the help of unique sound plugins which were especially programmed to measure Comfort Fit’s needs and wishes, we think the chances aren’t bad that you’ll fall for the unique sound signature, bounce and elegance of this unusual Hip Hop production. Ltj bukem / Good looking Rec., UK: \"Really love this music.\" Velanche / XLR8R, UK: \"Awesome job he's done... overall production is dope.\" Kwesi / BBE Music, UK: \"Wooooooowwwww... WHAT THE FUCK! THIS IS WHAT",
 "musicBrainzId": "6e1d48f7-717c-416e-af35-5d2454a13af2",
 "smallImageUrl": "http://localhost:8989/play/art/0f8c3cbd6b0b22c3b5402141351ac812/album/21/thumb34.jpg",
 "mediumImageUrl": "http://localhost:8989/play/art/41b16680dc1b3aaf5dfba24ddb6a1712/album/21/thumb64.jpg",
 "largeImageUrl": "http://localhost:8989/play/art/e6fd8d4e0d35c4436e56991892bfb27b/album/21/thumb174.jpg"
 }
 }
}

Field	Type	Req.	OpenS.	Details
`albumInfo`	`albumInfo`	Yes		The album info

getAlbumInfo2

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

http://your-server/rest/getAlbumInfo2 Since 1.14.0

Similar to getAlbumInfo, but organizes music according to ID3 tags.

Parameters

Parameter	Req.	OpenS.	Default	Comment
`id`	Yes			The album ID or song ID.

Example

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

Result

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

{
 "subsonic-response": {
 "status": "ok",
 "version": "1.16.1",
 "type": "AwesomeServerName",
 "serverVersion": "0.1.3 (tag)",
 "openSubsonic": true,
 "albumInfo": {
 "notes": "Download the full release here (creative commons). These cripsy beats are ripe with thumping funk and techno influences, sample wizardry and daring shuffles. Composed with the help of unique sound plugins which were especially programmed to measure Comfort Fit’s needs and wishes, we think the chances aren’t bad that you’ll fall for the unique sound signature, bounce and elegance of this unusual Hip Hop production. Ltj bukem / Good looking Rec., UK: \"Really love this music.\" Velanche / XLR8R, UK: \"Awesome job he's done... overall production is dope.\" Kwesi / BBE Music, UK: \"Wooooooowwwww... WHAT THE FUCK! THIS IS WHAT",
 "musicBrainzId": "6e1d48f7-717c-416e-af35-5d2454a13af2",
 "smallImageUrl": "http://localhost:8989/play/art/0f8c3cbd6b0b22c3b5402141351ac812/album/21/thumb34.jpg",
 "mediumImageUrl": "http://localhost:8989/play/art/41b16680dc1b3aaf5dfba24ddb6a1712/album/21/thumb64.jpg",
 "largeImageUrl": "http://localhost:8989/play/art/e6fd8d4e0d35c4436e56991892bfb27b/album/21/thumb174.jpg"
 }
 }
}

{
 "subsonic-response": {
 "status": "ok",
 "version": "1.16.1",
 "albumInfo": {
 "notes": "Download the full release here (creative commons). These cripsy beats are ripe with thumping funk and techno influences, sample wizardry and daring shuffles. Composed with the help of unique sound plugins which were especially programmed to measure Comfort Fit’s needs and wishes, we think the chances aren’t bad that you’ll fall for the unique sound signature, bounce and elegance of this unusual Hip Hop production. Ltj bukem / Good looking Rec., UK: \"Really love this music.\" Velanche / XLR8R, UK: \"Awesome job he's done... overall production is dope.\" Kwesi / BBE Music, UK: \"Wooooooowwwww... WHAT THE FUCK! THIS IS WHAT",
 "musicBrainzId": "6e1d48f7-717c-416e-af35-5d2454a13af2",
 "smallImageUrl": "http://localhost:8989/play/art/0f8c3cbd6b0b22c3b5402141351ac812/album/21/thumb34.jpg",
 "mediumImageUrl": "http://localhost:8989/play/art/41b16680dc1b3aaf5dfba24ddb6a1712/album/21/thumb64.jpg",
 "largeImageUrl": "http://localhost:8989/play/art/e6fd8d4e0d35c4436e56991892bfb27b/album/21/thumb174.jpg"
 }
 }
}

Field	Type	Req.	OpenS.	Details
`albumInfo`	`albumInfo`	Yes		The album info

getArtist

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

http://your-server/rest/getArtist Since 1.8.0

Returns details for an artist, including a list of albums. This method organizes music according to ID3 tags.

Parameters

Parameter	Req.	OpenS.	Default	Comment
`id`	Yes			The artist ID.

Example

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

Result

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

{
 "subsonic-response": {
 "status": "ok",
 "version": "1.16.1",
 "type": "AwesomeServerName",
 "serverVersion": "0.1.3 (tag)",
 "openSubsonic": true,
 "artist": {
 "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"
 ],
 "album": [
 {
 "id": "200000002",
 "parent": "100000002",
 "album": "Colorsmoke EP",
 "title": "Colorsmoke EP",
 "name": "Colorsmoke EP",
 "isDir": true,
 "coverArt": "al-200000002",
 "songCount": 12,
 "created": "2021-02-23T04:24:48+00:00",
 "duration": 4568,
 "playCount": 1,
 "artistId": "100000002",
 "artist": "Synthetic",
 "year": 2007,
 "genre": "Electronic",
 "userRating": 5,
 "averageRating": 3,
 "starred": "2021-02-22T05:51:53Z"
 }
 ]
 }
 }
}

{
 "subsonic-response": {
 "status": "ok",
 "version": "1.16.1",
 "artist": {
 "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",
 "album": [
 {
 "id": "200000002",
 "parent": "100000002",
 "album": "Colorsmoke EP",
 "title": "Colorsmoke EP",
 "name": "Colorsmoke EP",
 "isDir": true,
 "coverArt": "al-200000002",
 "songCount": 12,
 "created": "2021-02-23T04:24:48+00:00",
 "duration": 4568,
 "playCount": 1,
 "artistId": "100000002",
 "artist": "Synthetic",
 "year": 2007,
 "genre": "Electronic",
 "userRating": 5,
 "averageRating": 3,
 "starred": "2021-02-22T05:51:53Z"
 }
 ]
 }
 }
}

Field	Type	Req.	OpenS.	Details
`artist`	`artist`	Yes		The artist

getArtistInfo

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

http://your-server/rest/getArtistInfo Since 1.11.0

Returns artist info with biography, image URLs and similar artists, using data from last.fm.

Parameters

Parameter	Req.	Default	Comment
`id`	Yes		The artist, album or song ID.
`count`	No	20	Max number of similar artists to return.
`includeNotPresent`	No	false	Whether to return artists that are not present in the media library.

Example

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

Result

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

getArtistInfo2

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

http://your-server/rest/getArtistInfo2 Since 1.11.0

Similar to getArtistInfo, but organizes music according to ID3 tags.

Parameters

Parameter	Req.	Default	Comment
`id`	Yes		The artist, album or song ID.
`count`	No	20	Max number of similar artists to return.
`includeNotPresent`	No	false	Whether to return artists that are not present in the media library.

Example

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

Result

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

{
 "subsonic-response": {
 "status": "ok",
 "version": "1.16.1",
 "type": "AwesomeServerName",
 "serverVersion": "0.1.3 (tag)",
 "openSubsonic": true,
 "artistInfo2": {
 "biography": "Empty biography",
 "musicBrainzId": "1",
 "smallImageUrl": "http://localhost:8989/play/art/f20070e8e11611cc53542a38801d60fa/artist/2/thumb34.jpg",
 "mediumImageUrl": "http://localhost:8989/play/art/2b9b6c057cd4bf21089ce7572e7792b6/artist/2/thumb64.jpg",
 "largeImageUrl": "http://localhost:8989/play/art/e18287c23a75e263b64c31b3d64c1944/artist/2/thumb174.jpg"
 }
 }
}

{
 "subsonic-response": {
 "status": "ok",
 "version": "1.16.1",
 "artistInfo2": {
 "biography": "Empty biography",
 "musicBrainzId": "1",
 "smallImageUrl": "http://localhost:8989/play/art/f20070e8e11611cc53542a38801d60fa/artist/2/thumb34.jpg",
 "mediumImageUrl": "http://localhost:8989/play/art/2b9b6c057cd4bf21089ce7572e7792b6/artist/2/thumb64.jpg",
 "largeImageUrl": "http://localhost:8989/play/art/e18287c23a75e263b64c31b3d64c1944/artist/2/thumb174.jpg"
 }
 }
}

Field	Type	Req.	OpenS.	Details
`artistInfo2`	`artistInfo2`	Yes		The album info

getArtists

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

http://your-server/rest/getArtists Since 1.8.0

Similar to getIndexes, but organizes music according to ID3 tags.

Parameters

Parameter	Req.	OpenS.	Default	Comment
`musicFolderId`	No			If specified, only return artists in the music folder with the given ID. See `getMusicFolders`.

Example

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

Result

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

{
 "subsonic-response": {
 "status": "ok",
 "version": "1.16.1",
 "type": "AwesomeServerName",
 "serverVersion": "0.1.3 (tag)",
 "openSubsonic": true,
 "artists": {
 "ignoredArticles": "The An A Die Das Ein Eine Les Le La",
 "index": [
 {
 "name": "C",
 "artist": [
 {
 "id": "100000016",
 "name": "CARNÚN",
 "coverArt": "ar-100000016",
 "albumCount": 1
 },
 {
 "id": "100000027",
 "name": "Chi.Otic",
 "coverArt": "ar-100000027",
 "albumCount": 0
 }
 ]
 },
 {
 "name": "I",
 "artist": [
 {
 "id": "100000013",
 "name": "IOK-1",
 "coverArt": "ar-100000013",
 "albumCount": 1
 }
 ]
 }
 ]
 }
 }
}

{
 "subsonic-response": {
 "status": "ok",
 "version": "1.16.1",
 "artists": {
 "ignoredArticles": "The An A Die Das Ein Eine Les Le La",
 "index": [
 {
 "name": "C",
 "artist": [
 {
 "id": "100000016",
 "name": "CARNÚN",
 "coverArt": "ar-100000016",
 "albumCount": 1
 },
 {
 "id": "100000027",
 "name": "Chi.Otic",
 "coverArt": "ar-100000027",
 "albumCount": 0
 }
 ]
 },
 {
 "name": "I",
 "artist": [
 {
 "id": "100000013",
 "name": "IOK-1",
 "coverArt": "ar-100000013",
 "albumCount": 1
 }
 ]
 }
 ]
 }
 }
}

Field	Type	Req.	OpenS.	Details
`artists`	`artists`	Yes		The artist list

getGenres

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

http://your-server/rest/getGenres Since 1.9.0

Returns all genres.

Parameters

Takes no extra parameters.

Example

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

Result

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

{
 "subsonic-response": {
 "status": "ok",
 "version": "1.16.1",
 "type": "AwesomeServerName",
 "serverVersion": "0.1.3 (tag)",
 "openSubsonic": true,
 "genres": {
 "genre": [
 {
 "songCount": 1,
 "albumCount": 1,
 "value": "Punk"
 },
 {
 "songCount": 4,
 "albumCount": 1,
 "value": "Dark Ambient"
 },
 {
 "songCount": 6,
 "albumCount": 1,
 "value": "Noise"
 },
 {
 "songCount": 11,
 "albumCount": 1,
 "value": "Electronica"
 },
 {
 "songCount": 11,
 "albumCount": 1,
 "value": "Dance"
 },
 {
 "songCount": 12,
 "albumCount": 1,
 "value": "Electronic"
 },
 {
 "songCount": 20,
 "albumCount": 1,
 "value": "Hip-Hop"
 }
 ]
 }
 }
}

{
 "subsonic-response": {
 "status": "ok",
 "version": "1.16.1",
 "genres": {
 "genre": [
 {
 "songCount": 1,
 "albumCount": 1,
 "value": "Punk"
 },
 {
 "songCount": 4,
 "albumCount": 1,
 "value": "Dark Ambient"
 },
 {
 "songCount": 6,
 "albumCount": 1,
 "value": "Noise"
 },
 {
 "songCount": 11,
 "albumCount": 1,
 "value": "Electronica"
 },
 {
 "songCount": 11,
 "albumCount": 1,
 "value": "Dance"
 },
 {
 "songCount": 12,
 "albumCount": 1,
 "value": "Electronic"
 },
 {
 "songCount": 20,
 "albumCount": 1,
 "value": "Hip-Hop"
 }
 ]
 }
 }
}

Field	Type	Req.	OpenS.	Details
`genres`	`genres`	Yes		The genre list

getIndexes

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

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

Returns an indexed structure of all artists.

Parameters

Parameter	Req.	OpenS.	Default	Comment
`musicFolderId`	No			If specified, only return artists in the music folder with the given ID. See `getMusicFolders`.
`ifModifiedSince`	No			If specified, only return a result if the artist collection has changed since the given time (in milliseconds since 1 Jan 1970).

Example

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

Result

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

getMusicDirectory

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

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

Returns a listing of all files in a music directory. Typically used to get list of albums for an artist, or list of songs for an album.

Parameters

Parameter	Req.	OpenS.	Default	Comment
`id`	Yes			A string which uniquely identifies the music folder. Obtained by calls to getIndexes or getMusicDirectory.

Example

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

Result

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

{
 "subsonic-response": {
 "status": "ok",
 "version": "1.16.1",
 "type": "AwesomeServerName",
 "serverVersion": "0.1.3 (tag)",
 "openSubsonic": true,
 "directory": {
 "id": "1",
 "name": "music",
 "child": [
 {
 "id": "100000016",
 "parent": "1",
 "isDir": true,
 "title": "CARNÚN",
 "artist": "CARNÚN",
 "coverArt": "ar-100000016"
 },
 {
 "id": "100000027",
 "parent": "1",
 "isDir": true,
 "title": "Chi.Otic",
 "artist": "Chi.Otic",
 "coverArt": "ar-100000027"
 }
 ]
 }
 }
}

{
 "subsonic-response": {
 "status": "ok",
 "version": "1.16.1",
 "directory": {
 "id": "1",
 "name": "music",
 "child": [
 {
 "id": "100000016",
 "parent": "1",
 "isDir": true,
 "title": "CARNÚN",
 "artist": "CARNÚN",
 "coverArt": "ar-100000016"
 },
 {
 "id": "100000027",
 "parent": "1",
 "isDir": true,
 "title": "Chi.Otic",
 "artist": "Chi.Otic",
 "coverArt": "ar-100000027"
 }
 ]
 }
 }
}

Field	Type	Req.	OpenS.	Details
`directory`	`directory`	Yes		The directory content

getMusicFolders

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

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

Returns all configured top-level music folders. Takes no extra parameters.

Parameters

Takes no extra parameters.

Example

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

Result

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

{
 "subsonic-response": {
 "status": "ok",
 "version": "1.16.1",
 "type": "AwesomeServerName",
 "serverVersion": "0.1.3 (tag)",
 "openSubsonic": true,
 "musicFolders": {
 "musicFolder": [
 {
 "id": 1,
 "name": "music"
 },
 {
 "id": 4,
 "name": "upload"
 }
 ]
 }
 }
}

{
 "subsonic-response": {
 "status": "ok",
 "version": "1.16.1",
 "musicFolders": {
 "musicFolder": [
 {
 "id": 1,
 "name": "music"
 },
 {
 "id": 4,
 "name": "upload"
 }
 ]
 }
 }
}

Field	Type	Req.	OpenS.	Details
`musicFolders`	`musicFolders`	Yes		The directory content

getPodcastEpisode

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

OpenSubsonic version: 1

OpenSubsonic extension name getPodcastEpisode (As returned by getOpenSubsonicExtensions) http://your-server/rest/getPodcastEpisode

Returns details for a podcast episode.

Parameters

Parameter	Req.	OpenS.	Default	Comment
`id`	Yes	Yes		The podcast episode ID.

Example

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

Result

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

{
 "subsonic-response": {
 "status": "ok",
 "version": "1.16.1",
 "type": "AwesomeServerName",
 "serverVersion": "0.1.3 (tag)",
 "openSubsonic": true,
 "podcastEpisode": {
 "id": "7390",
 "parent": "7389",
 "isDir": "false",
 "title": "Jonas Gahr Støre",
 "album": "NRK – Hallo P3",
 "artist": "Podcast",
 "year": "2015",
 "coverArt": "7389",
 "size": "41808585",
 "contentType": "audio/mpeg",
 "suffix": "mp3",
 "duration": "2619",
 "bitRate": "128",
 "isVideo": "false",
 "created": "2015-09-07T20:07:31.000Z",
 "artistId": "453",
 "type": "podcast",
 "streamId": "7410",
 "channelId": "17",
 "description": "Jonas Gahr Støre fra Arbeiderpartiet er med i dagens partilederutspørring i Hallo P3!",
 "status": "completed",
 "publishDate": "2015-09-07T15:29:00.000Z"
 }
 }
}

Does not exist

Field	Type	Req.	OpenS.	Details
`podcastEspisode`	`podcastEpisode`	Yes		The podcast episode

getSimilarSongs

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

http://your-server/rest/getSimilarSongs Since 1.11.0

Returns a random collection of songs from the given artist and similar artists, using data from last.fm. Typically used for artist radio features.

Parameters

Parameter	Req.	OpenS.	Default	Comment
`id`	Yes			The artist, album or song ID.
`count`	No		50	Max number of songs to return.

OpenSubsonic

In the original Subsonic, the specification for getSimilarSongs2 implies that it should be used instead of this endpoint if the client and/or server organizes by ID3 tags.

getSimilarSongs2

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

http://your-server/rest/getSimilarSongs2 Since 1.11.0

Similar to getSimilarSongs, but organizes music according to ID3 tags.

Parameters

Parameter	Req.	OpenS.	Default	Comment
`id`	Yes			The artist ID.
`count`	No		50	Max number of songs to return.

Example

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

Result

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

{
 "subsonic-response": {
 "status": "ok",
 "version": "1.16.1",
 "type": "AwesomeServerName",
 "serverVersion": "0.1.3 (tag)",
 "openSubsonic": true,
 "similarSongs2": {
 "song": [
 {
 "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": "300000055",
 "parent": "200000002",
 "title": "Red&GreenSmoke",
 "isDir": false,
 "isVideo": false,
 "type": "music",
 "albumId": "200000002",
 "album": "Colorsmoke EP",
 "artistId": "100000002",
 "artist": "Synthetic",
 "coverArt": "300000055",
 "duration": 400,
 "bitRate": 64,
 "bitDepth": 16,
 "samplingRate": 44100,
 "channelCount": 2,
 "track": 5,
 "year": 2007,
 "genre": "Electronic",
 "size": 3209886,
 "discNumber": 1,
 "suffix": "mp3",
 "contentType": "audio/mpeg",
 "path": "Synthetic/Synthetic_-_Colorsmoke_EP-20k217-2007(1)/05-Synthetic_-_RedGreenSmokePM20k22khS_64kb.mp3"
 }
 ]
 }
 }
}

{
 "subsonic-response": {
 "status": "ok",
 "version": "1.16.1",
 "similarSongs2": {
 "song": [
 {
 "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": "300000055",
 "parent": "200000002",
 "title": "Red&GreenSmoke",
 "isDir": false,
 "isVideo": false,
 "type": "music",
 "albumId": "200000002",
 "album": "Colorsmoke EP",
 "artistId": "100000002",
 "artist": "Synthetic",
 "coverArt": "300000055",
 "duration": 400,
 "bitRate": 64,
 "bitDepth": 16,
 "samplingRate": 44100,
 "channelCount": 2,
 "track": 5,
 "year": 2007,
 "genre": "Electronic",
 "size": 3209886,
 "discNumber": 1,
 "suffix": "mp3",
 "contentType": "audio/mpeg",
 "path": "Synthetic/Synthetic_-_Colorsmoke_EP-20k217-2007(1)/05-Synthetic_-_RedGreenSmokePM20k22khS_64kb.mp3"
 }
 ]
 }
 }
}

Field	Type	Req.	OpenS.	Details
`similarSongs2`	`similarSongs2`	Yes		The similar songs list

getSong

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

http://your-server/rest/getSong Since 1.8.0

Returns details for a song.

Parameters

Parameter	Req.	OpenS.	Default	Comment
`id`	Yes			The song ID.

Example

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

Result

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

{
 "subsonic-response": {
 "status": "ok",
 "version": "1.16.1",
 "type": "AwesomeServerName",
 "serverVersion": "0.1.3 (tag)",
 "openSubsonic": true,
 "song": {
 "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",
 "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"
 ],
 "replayGain": {
 "trackGain": 0.1,
 "albumGain": 1.1,
 "trackPeak": 9.2,
 "albumPeak": 9,
 "baseGain": 0
 }
 }
 }
}

{
 "subsonic-response": {
 "status": "ok",
 "version": "1.16.1",
 "song": {
 "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
`song`	`Child`	Yes		The song

getSonicSimilarTracks

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

http://your-server/rest/getSonicSimilarTracks

Returns tracks that are sonically similar to a given track, based on audio analysis. Each result includes its normalized distance from the query track.

Parameters

Parameter	Req.	OpenS.	Default	Comment
`id`	Yes			The ID of the song.
`count`	No		10	Max number of similar tracks to return.

Example

http://your-server/rest/getSonicSimilarTracks.view?id=100&count=5&u=demo&p=demo&v=1.13.0&c=AwesomeClientName&f=json

Result

A subsonic-response element with a top-level sonicMatch array on success.

{
 "subsonic-response": {
 "status": "ok",
 "version": "1.16.1",
 "type": "AwesomeServerName",
 "serverVersion": "0.1.3 (tag)",
 "openSubsonic": true,
 "sonicMatch": [
 {
 "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,
 "track": 4,
 "year": 2007,
 "genre": "Electronic",
 "size": 792375,
 "discNumber": 1,
 "suffix": "wma",
 "contentType": "audio/x-ms-wma",
 "path": "Synthetic/Synthetic_-_Colorsmoke_EP/04-Synthetic_-_BrownSmoke.wma"
 },
 "similarity": 0.05
 },
 {
 "entry": {
 "id": "300000055",
 "parent": "200000002",
 "title": "Red&GreenSmoke",
 "isDir": false,
 "isVideo": false,
 "type": "music",
 "albumId": "200000002",
 "album": "Colorsmoke EP",
 "artistId": "100000002",
 "artist": "Synthetic",
 "coverArt": "300000055",
 "duration": 400,
 "bitRate": 64,
 "bitDepth": 16,
 "samplingRate": 44100,
 "channelCount": 2,
 "track": 5,
 "year": 2007,
 "genre": "Electronic",
 "size": 3209886,
 "discNumber": 1,
 "suffix": "mp3",
 "contentType": "audio/mpeg",
 "path": "Synthetic/Synthetic_-_Colorsmoke_EP/05-Synthetic_-_RedGreenSmoke.mp3"
 },
 "similarity": 0.12
 }
 ]
 }
 }
}

Does not exist.

Field	Type	Req.	OpenS.	Details
`sonicMatch`	Array of `sonicMatch`	Yes		The similar tracks with per-track similarity

getTopSongs

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

http://your-server/rest/getTopSongs Since 1.13.0

Returns top songs for the given artist, using data from last.fm.

Parameters

Parameter	Req.	OpenS.	Default	Comment
`artist`	Yes			The artist name.
`count`	No		50	Max number of songs to return.

Example

http://your-server/rest/getTopSongs.view?artist=toto&u=demo&p=demo&v=1.13.0&c=AwesomeServerName&f=json

Result

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

{
 "subsonic-response": {
 "status": "ok",
 "version": "1.16.1",
 "type": "AwesomeServerName",
 "serverVersion": "0.1.3 (tag)",
 "openSubsonic": true,
 "topSongs": {
 "song": [
 {
 "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": "300000055",
 "parent": "200000002",
 "title": "Red&GreenSmoke",
 "isDir": false,
 "isVideo": false,
 "type": "music",
 "albumId": "200000002",
 "album": "Colorsmoke EP",
 "artistId": "100000002",
 "artist": "Synthetic",
 "coverArt": "300000055",
 "duration": 400,
 "bitRate": 64,
 "bitDepth": 16,
 "samplingRate": 44100,
 "channelCount": 2,
 "track": 5,
 "year": 2007,
 "genre": "Electronic",
 "size": 3209886,
 "discNumber": 1,
 "suffix": "mp3",
 "contentType": "audio/mpeg",
 "path": "Synthetic/Synthetic_-_Colorsmoke_EP-20k217-2007(1)/05-Synthetic_-_RedGreenSmokePM20k22khS_64kb.mp3"
 }
 ]
 }
 }
}

{
 "subsonic-response": {
 "status": "ok",
 "version": "1.16.1",
 "topSongs": {
 "song": [
 {
 "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": "300000055",
 "parent": "200000002",
 "title": "Red&GreenSmoke",
 "isDir": false,
 "isVideo": false,
 "type": "music",
 "albumId": "200000002",
 "album": "Colorsmoke EP",
 "artistId": "100000002",
 "artist": "Synthetic",
 "coverArt": "300000055",
 "duration": 400,
 "bitRate": 64,
 "bitDepth": 16,
 "samplingRate": 44100,
 "channelCount": 2,
 "track": 5,
 "year": 2007,
 "genre": "Electronic",
 "size": 3209886,
 "discNumber": 1,
 "suffix": "mp3",
 "contentType": "audio/mpeg",
 "path": "Synthetic/Synthetic_-_Colorsmoke_EP-20k217-2007(1)/05-Synthetic_-_RedGreenSmokePM20k22khS_64kb.mp3"
 }
 ]
 }
 }
}

Field	Type	Req.	OpenS.	Details
`topSongs`	`topSongs`	Yes		The top songs list

getVideoInfo

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

http://your-server/rest/getVideoInfo Since 1.14.0

Returns details for a video, including information about available audio tracks, subtitles (captions) and conversions.

Parameters

Parameter	Req.	OpenS.	Default	Comment
`id`	Yes			The video ID.

Example

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

Result

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

// TODO

// TODO

Field	Type	Req.	OpenS.	Details
`videoInfo`	`videoInfo`	Yes		The song

getVideos

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

http://your-server/rest/getVideos Since 1.8.0

Returns all video files.

Parameters

Takes no extra parameters.

Example

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

Result

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

// TODO

// TODO

Field	Type	Req.	OpenS.	Details
`videos`	`videos`	Yes		The videos