Developer Network Home - Help

My Web Documentation for Yahoo! Search Web Services

Version 1My Web 2.0 Web Services: URL Search

Searching for Saved URLs

The URL Search service lets you find URLs that have been tagged by My Web 2.0 users.

More My Web 2.0 Web services.

Support & Community

The My Web 2.0 URL Search service is discussed on the yws-search-general mailing list.

Request URL

http://search.yahooapis.com/MyWebService/V1/urlSearch

Request Parameters

See information on constructing REST queries

Parameter Value Description
appid string (required) The application ID. See Application IDs for more information.
tag string The tag to search for. Multiple tags may be specified (tag=tag1&tag=tag2), in which case the resulting URLs will be tagged with all of them.
yahooid string A Yahoo! username. If one is specified, only URLs saved by that user will be searched.
sort date (default), title, or url The field by which the results should be sorted. date sorts most-recent-first. title and url are sorted alphabetically.
reverse_sort 0 (default) or 1 If set to 1, reverses the sort order.
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/MyWebService/V1/urlSearch?appid=YahooDemo&yahooid=ysearchmyweb2&results=2

Response Fields

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

Field Description
ResultSet Contains all of the query responses.
Result Contains each individual response.
totalResultsAvailable The number of URLs stored in the folder.
totalResultsReturned The number of URLs 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 URL set.
Title The title of the web page.
Summary Summary text associated with the web page.
Url The URL for the web page.
ClickUrl The URL for linking to the page. See URL linking for more information.
User The Yahoo! ID of the last user to store the URL (or the user specified with the yahooid parameter).
Note Any note the Yahoo! user has chosen to annotate the URL with.
Date The date the URL was stored, in unix timestamp format.
Tags The wrapper for the tags associated with this URL.
Tag A tag associated with the URL by the user.

Sample Response

The following is a sample response for URLs tagged by the user ysearchmyweb2:

Rate Limit

The URL 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 URL Search service returns the standard errors. There are no service-specific errors.

Copyright © 2008 Yahoo! Inc. All rights reserved.

Privacy Policy - Terms of Service - Copyright Policy - Job Openings