Python SDK

We offer a Python SDK to make interacting with our APIs simple and predictable. It is available on PyPI here. Now you can get started with our APIs with just a few lines of code.

Quickstart

$
pip install youdotcom

1
import os
2
from youdotcom import You
3
4
# Initialize the SDK with your API key
5
you = You(os.environ["YDC_API_KEY"])
6
7
# Perform a search
8
results = you.search.unified(
9
    query="latest AI developments"
10
)
11
12
# Access the results
13
print(results)

What’s next?

The Web Search API offers filters that can help you find exactly what you need, whether you want to go broader or narrower. For example, to find recent information in the United States about renewable energy from the past week limited to 10 results per source type, either web or news, write:

1
from youdotcom.models import Freshness, Country
2
3
results = you.search.unified(
4
    query="renewable energy",
5
    count=10,
6
    freshness=Freshness.WEEK,
7
    country=Country.US,
8
)

Learn more about the Web Search API in the Web Search API reference, and the Python SDK by visiting the open source repository on GitHub.

Response Structure

The Web Search API returns a SearchResponse object (see documentation):

Error Handling

Always handle potential errors when making API requests:

1
import os
2
from youdotcom import You, errors
3
4
api_key = os.getenv("YDC_API_KEY")
5
6
try:
7
    with You(api_key_auth=api_key) as you:
8
        results = you.search.unified(query="your query")
9
        print(results)
10
except errors.YouError as e:
11
    print(f"Search failed: {e.message}")
12
    print(f"Status code: {e.status_code}")

Learn More