Audio Album Search Documentation for Yahoo! Search Web Services

Support & Community

The Album Search service is discussed on the yws-search-general mailing list.

Request URL

http://search.yahooapis.com/AudioSearchService/V1/albumSearch

Request parameters

See information on constructing REST queries

Parameter	Value	Description
appid	string (required)	The application ID. See Application IDs for more information.
artist	string	The artist or partial artist string to search for (UTF-8 encoded).
artistid	string	The specific id for an artist. Ids are internal to the Music Search Service and will be returned with artist references.
album	string	The album name or partial album string to search for (UTF-8 encoded).
albumid	string	The specific id for an album. Ids are internal to the Music Search Service and will be returned with album references. At least one of artist, artistid, album or albumid is required.
type	all (default), any, or phrase	The kind of search to submit: all returns results with all query terms. any returns results with one or more of the query terms. phrase returns results containing the query terms as a phrase.
results	integer: default 10, max 50	The number of results to return.
start	integer: default 1	The starting result position to return (1-based). The finishing position (start + results - 1) cannot exceed 1000.
output	string: xml (default), json, php	The format for the output. If json is requested, the results will be returned in JSON format. If php is requested, the results will be returned in Serialized PHP format.
callback	string	The name of the callback function to wrap around the JSON data. The following characters are allowed: A-Z a-z 0-9 . [] and _. If output=json has not been requested, this parameter has no effect. More information on the callback can be found in the Yahoo! Developer Network JSON Documentation.

Sample Request Url: http://search.yahooapis.com/AudioSearchService/V1/albumSearch?appid=YahooDemo&artistid=XXXXXXP000064565&album=Like&results=2

Response fields

The schema document for this service response is located at http://search.yahooapis.com/AudioSearchService/V1/AlbumSearchResponse.xsd

Field	Description
ResultSet	Contains all of the query responses. Has attributes: totalResultsAvailable: The number of query matches in the database. totalResultsReturned: The number of query matches returned. This may be lower than the number of results requested if there were fewer total results available. firstResultPosition: The position of the first result in the overall search.
Result	Contains each individual response. Has an attribute: id: The id associated with the album specified in this result.
Title	The title of the album.
Artist	The performer of the album (and associated id).
Publisher	The publisher of the album.
ReleaseDate	The date of the album's release.
Thumbnail	The URL of a thumbnail picture of the album cover and its height and width in pixels, if available.
RelatedAlbums	Contains a list of related albums that fans of the album in this Result might like.
Album	The individual album titles (and associated ids) of the related albums.

Sample response

The following is a sample response for the query Like and the artistid: XXXXXXP000064565 (Madonna)

<?xml version="1.0" encoding="UTF-8"??>
<ResultSet xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="urn:yahoo:srchma" xsi:schemaLocation="urn:yahoo:srchmm http://search.yahooapis.com/AudioSearchService/V1/AlbumSearchResponse.xsd" totalResultsAvailable="7" totalResultsReturned="2" firstResultPosition="1">
	<Result id="XXXXXXR000012208">
		<Title>Like a Prayer</Title>
		<Artist id="XXXXXXP000064565">Madonna</Artist>
		<Publisher>Sire</Publisher>
		<ReleaseDate>1989</ReleaseDate>
		<Thumbnail>
			<Url>http://thm-sorbet.search.vip.scd.yahoo.com/image/1900130944</Url>
			<Height>59</Height>
			<Width>60</Width>
		</Thumbnail>
		<RelatedAlbums>
			<Album id="XXXXXXR000342058">Impossible Princess</Album>
			<Album id="XXXXXXR000313849">What Have I Done to Deserve This?</Album>
		</RelatedAlbums>
	</Result>
	<Result id="XXXXXXR000538877">
		<Title>Like a Virgin [Remastered]</Title>
		<Artist id="XXXXXXP000064565">Madonna</Artist>
		<Publisher>Warner Brothers</Publisher>
		<ReleaseDate>2001</ReleaseDate>
		<Thumbnail>
			<Url>http://thm-sorbet.search.vip.scd.yahoo.com/image/1900227909</Url>
			<Height>59</Height>
			<Width>60</Width>
		</Thumbnail>
	</Result>
</ResultSet>

Rate Limit

The Album Search service is limited to 5,000 queries per IP address per day. See information on rate limiting and our Usage Policy to learn about acceptable uses and how to request additional queries.

Errors

The Album Search service returns the standard errors. There are no service-specific errors.