Query
Returns a list of search index hits from query
search.query(SearchQueryParams**kwargs) -> hitslistlatencyfloatSearchQueryResponse
get/search
Returns a list of search index hits from query
Parameters
querystr
Search query used to retrieve relevant results from index. You may also include search operators to refine your search.
countryliteral
optional
Literal["AR", "AU", "AT", 33 more]
Country Code
freshnessliteral
optional
Literal["day", "week", "month", "year"]
Specifies the freshness of the results to return.
num_web_resultsint
optional
Specifies the maximum number of web results to return. Range 1 ≤ num_web_results ≤ 20.
minimum1
maximum20
offsetint
optional
Indicates the offset for pagination. The offset is calculated in multiples of num_web_results. For example, if num_web_results = 5 and offset = 1, results 5–10 will be returned. Range 0 ≤ offset ≤ 9.
minimum0
maximum9
safesearchliteral
optional
Literal["off", "moderate", "strict"]
Configures the safesearch filter for content moderation. off - no filtering applied. moderate - moderate content filtering (default). strict - strict content filtering.
Returns
SearchQueryResponseclass
from you_api import YouAPI
client = YouAPI(
api_key="My API Key",
)
response = client.search.query(
query="query",
)
print(response.hits)
200 Example
{
"hits": [
{
"description": "Search on YDC",
"title": "The World's Greatest Search Engine!",
"url": "https://you.com",
"favicon_url": "https://someurl.com/favicon",
"snippets": [
"I'm an AI assistant that helps you get more done. What can I help you with?"
],
"thumbnail_url": "https://www.somethumbnailsite.com/thumbnail.jpg"
}
],
"latency": 1
}