GET
/
search

Before You Get Started

To register for usage of our Search API, please reach out via email at api@you.com.

Authorizations

X-API-Key
string
header
required

Query Parameters

query
string
required

Search query used to retrieve relevant results from index

num_web_results
integer

Specifies the maximum number of web results to return. Range 1 ≤ num_web_results ≤ 20.

offset
integer

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.

country
string

Country Code, one of ['AR', 'AU', 'AT', 'BE', 'BR', 'CA', 'CL', 'DK', 'FI', 'FR', 'DE', 'HK', 'IN', 'ID', 'IT', 'JP', 'KR', 'MY', 'MX', 'NL', 'NZ', 'NO', 'CN', 'PL', 'PT', 'PH', 'RU', 'SA', 'ZA', 'ES', 'SE', 'CH', 'TW', 'TR', 'GB', 'US'].

safesearch
string

Configures the safesearch filter for content moderation. off - no filtering applied.moderate - moderate content filtering (default). strict - strict content filtering.

Response

200 - application/json
hits
object[]
latency
number

Indicates the time (in seconds) taken by the API to generate the response.