Web Search & News API - Real-time Intelligence for AI Agents

Thank you for subscribing to the You.com Search API on AWS Marketplace. These instructions will guide you on how to use the API to integrate our powerful search capabilities into your applications.

All API requests must include an API key in the X-API-Key header. You will be able to generate an API Key once you launch the product through AWS and create an account on api.you.com.

Header: X-API-Key: YOUR_API_KEY

Make sure to replace YOUR_API_KEY with the actual key you received.

Endpoint: GET <https://api.ydc-index.io/search>

This endpoint performs a web search based on your query and returns a list of relevant results.

You can find extensive documentation and implementation guides for our APIs at documentation.you.com . An API reference has been provided below for convenience as well.

Parameter	Type	Description
query	string	Required. The search query. You can use search operators (see full documentation on docs.you.com) to refine results.
num_web_results	integer	The maximum number of web results to return. The value must be between 1 and 20.
freshness	string	Specifies the freshness of results. Valid options are day, week, month, and year.
offset	integer	The offset for pagination. For example, if num_web_results=10 and offset=1, results 11-20 are returned. The value must be between 0 and 9.
country	string	A two-letter country code to localize search results (e.g., US, DE).
safesearch	string	Configures content moderation. Options are off, moderate (default), and strict.

You can use the following operators in your query to get more specific results:

Operator	Description	Example
site	Searches a specific domain and its subdomains.	site:uscourts.gov USA v. Enron
filetype	Searches for a specific file type.	USA v. Enron filetype:pdf
lang	Searches for pages in a specific language (ISO 639-1 code).	Modelo lang:es
+	Results must contain the term after the +.	Enron +GAAP
-	Results will not contain the term after the -.	guitar -prs
AND	Logical operator to combine expressions.	guitar +prs AND +silversky
OR	Logical operator to combine expressions.	guitar -prs OR -silversky
NOT	Negates an expression.	USA v. Enron NOT site:uscourts.gov

Here is an example of how to make a request using curl:

curl "<https://api.ydc-index.io/search?query=USA+v.+Enron+filetype:pdf&country=US>" \ -H "X-API-Key: YOUR_API_KEY"

The API returns a JSON object with the following structure:

{ "hits": [ { "url": "string", "title": "string", "description": "string", "favicon_url": "string", "thumbnail_url": "string", "snippets": [ "string" ] } ], "latency": "number" }

If an error occurs, the API will return a response with an appropriate HTTP status code and a JSON body describing the error.

Status	Meaning
401	Unauthorized. Your API key is invalid or missing.
429	Too Many Requests. You have exceeded your rate limit.
500	Server Error. There was an issue on our end.

Your API usage is subject to rate limits based on your AWS Marketplace subscription plan. Please refer to your subscription details for information on your specific rate limits. Exceeding the rate limit will result in an HTTP 429 Too Many Requests error.