Query

API Reference

Returns a list of search index hits from query

client.search.query(, ?):

get/search

Returns a list of search index hits from query

Parameters

query

Hide ParametersShow Parameters

querystring

Search query used to retrieve relevant results from index. You may also include search operators to refine your search.

countryunion

optional

"AR" | "AU" | "AT" | 33 more

Country Code

Hide ParametersShow Parameters

"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"

freshnessunion

optional

"day" | "week" | "month" | "year"

Specifies the freshness of the results to return.

Hide ParametersShow Parameters

"day"

"week"

"month"

"year"

num_web_resultsnumber

optional

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

minimum1

maximum20

offsetnumber

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

safesearchunion

optional

"off" | "moderate" | "strict"

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

Hide ParametersShow Parameters

"off"

"moderate"

"strict"

Returns

SearchQueryResponse

Hide ParametersShow Parameters

hitsarray

Array<Hit>

Hide ParametersShow Parameters

descriptionstring

A brief description of the content of the search result

titlestring

The title or name of the search result

urlstring

The URL of the specific search result

favicon_urlstring

optional

The URL of the favicon of the search result's domain

snippetsarray

optional

Array<string>

An array of text snippets from the search result, providing a preview of the content

thumbnail_urlstring

optional

URL of the thumbnail

latencynumber

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

import YouAPI from 'you-api';

const client = new YouAPI({
  apiKey: 'My API Key',
});

const response = await client.search.query({ query: 'query' });

console.log(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
}