Related Suggestions Webservice

Search Web Services: Related Suggestions

We’re shutting down this API in February 2011. For further details, please see the Deprecated Services blog post.

Submitting Related Suggestion Queries

The Related Suggestion service provides suggestions for queries related to the submitted query. See also the other Web Search services.

Request URL

http://search.yahooapis.com/WebSearchService/V1/relatedSuggestion

Request parameters

See information on constructing REST queries

Parameter	Value	Description
appid	string (required)	The application ID. See Application IDs for more information.
query	string (required)	The query to get related searches from (UTF-8 encoded).
results	integer: default 10, max 50	The number of results to return.
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/WebSearchService/V1/relatedSuggestion?appid=YahooDemo&query=Madonna

Response fields

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

Field	Description
ResultSet	Contains all of the suggestions.
Result	The text of the suggested related search.

Sample response

The following is a sample response for the query Madonna:

<ResultSet xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="urn:yahoo:srch" xsi:schemaLocation="urn:yahoo:srch http://search.yahooapis.com/WebSearchService/V1/WebSearchRelatedResponse.xsd"> <Result>Madonna lyrics</Result> <Result>Madonna pictures</Result> </ResultSet>

Rate Limits

The Related Suggestions Web Search service is limited to 5,000 queries per IP address per day and to noncommercial use. See information on rate limiting.