Searching on OpenSubsonic

search

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

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

Deprecated since 1.4.0, use search2 instead.

Returns a listing of files matching the given search criteria. Supports paging through the result.

Parameter	Req.	Default	Comment
`artist`	No		Artist to search for.
`album`	No		Album to search for.
`title`	No		Song title to search for.
`any`	No		Searches all fields.
`count`	No	20	Maximum number of results to return.
`offset`	No	0	Search result offset. Used for paging.
`newerThan`	No		Only return matches that are newer than this. Given as milliseconds since 1970.

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

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

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

http://your-server/rest/search2 Since 1.4.0

Returns albums, artists and songs matching the given search criteria. Supports paging through the result.

Parameter	Req.	Default	Comment
`query`	Yes		Search query.
`artistCount`	No	20	Maximum number of artists to return.
`artistOffset`	No	0	Search result offset for artists. Used for paging.
`albumCount`	No	20	Maximum number of albums to return.
`albumOffset`	No	0	Search result offset for albums. Used for paging.
`songCount`	No	20	Maximum number of songs to return.
`songOffset`	No	0	Search result offset for songs. Used for paging.
`musicFolderId`	No		(Since 1.12.0) Only return results from the music folder with the given ID. See `getMusicFolders`.

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

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

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

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

Returns albums, artists and songs matching the given search criteria. Supports paging through the result.

Music is organized according to ID3 tags.

Parameter	Requ.	OpenS.	Default	Comment
`query`	Yes	See below*		Search query.
`artistCount`	No		20	Maximum number of artists to return.
`artistOffset`	No		0	Search result offset for artists. Used for paging.
`albumCount`	No		20	Maximum number of albums to return.
`albumOffset`	No		0	Search result offset for albums. Used for paging.
`songCount`	No		20	Maximum number of songs to return.
`songOffset`	No		0	Search result offset for songs. Used for paging.
`musicFolderId`	No			(Since 1.12.0) Only return results from music folder with the given ID. See `getMusicFolders`.

Servers must support an empty query and return all the data to allow clients to properly access all the media information for offline sync.

http://your-server/rest/search3.view?u=demo&p=demo&v=1.13.0&c=AwesomeClientName&f=json&query=""&artistCount=1&albumCount=1&songCount=1

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