v9

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-01211389.1 KB

Results

Retrieve search results or queue a search for later retrieval.

get/search

Query parameters

idstring uuid
Example:078fd246-f0f7-44a0-aabb-cadd7b12454f

The identifier returned by this endpoint of the queued search to retrieve; if given, all other params are ignored; either an ID or terms are required.

termsstring
Example:foo bar baz

The broad or exact word or phrase to query (e.g., foo bar baz or "foo bar baz"); the terms require form or URL encoding (with any space character being replaced by a + character or %20 sequence); either terms or an ID are required.

engine'google' | 'bing (coming soon)'
Example:google

The search engine to use.

serpsinteger
Example:1

The number of results pages to fetch.

sizeinteger

The number of results per page to fetch; page size is unset by default.

offsetinteger

The number of initial results to skip; results aren’t offset by default.

devicestring

The name as returned by the devices resource of the device to emulate searching on (these names are case insensitive but must include form- or URL-encoded spaces and punctuation marks); device emulation is unused by default.

countrystring

The two-letter ISO code of the country to search from (these codes are case insensitive); a random country is used by default.

subdivisionstring

The alphanumeric second part (proceeding the separator) of a first-level subdivision code in the (prerequisite) country to search from (these codes are case insensitive); a random subdivision is used by default.

citystring

The commonly spelled name of the city in the (prerequisite) country to search from (these names are temporarily case sensitive and required to include form- or URL-encoded spaces and punctuation marks); a random city is used by default.

uulestring

The proprietary encoded string for emulating the location to search from; if possible, the actual location is searched from not emulated; location emulation is unused by default.

languagestring

The commonly spelled name, two-letter ISO code, or Google code of the language to search in (these names and codes are case insensitive but required to include form- or URL-encoded spaces and punctuation marks); the language is unset by default.

displaystring

The commonly spelled name, two-letter ISO code, or Google code of the search interface’s display language (these names and codes are case insensitive but required to include form- or URL-encoded spaces and punctuation marks); the display language is unset by default or set to the language if given.

urlstring uri
Example:https%3A%2F%2Fwww.google.com%2Fsearch%3Fq%3Dfoo%2Bbar%2Bbaz%26hl%3Dfr%26gl%3Dfr%26ie%3DUTF-8

The encoded URL of the results page to retrieve; if given, the URL overrides any of the above params.

awaiting'ai' | 'answers' | 'ads'
Example:ai

The lazy result features to wait to load; any AI overview, which can take significant time to generate, is awaited for a maximum of 1 minute; multiple features can be provided by repeating the key; lazy results aren’t awaited by default.

expirationinteger

The age in days of when to consider cached results expired, where 0 disables caching.

mode'sync' | 'async'
Example:sync

The synchronous or asynchronous mode of results retrieval (retrieve async results by providing the returned ID).

callbackstring
Example:https%3A%2F%2Fwebhook.site%2F02e249f8-1faf-4fab-bcf5-78ce683e85a8

The encoded HTTP or HTTPS callback URL or Amazon SQS queue URL or ARN to notify when the (prerequisite) async results have been retrieved; any SQS queue must grant sqs:SendMessage permission to the arn:aws:iam::180363035301:role/api-instance AWS principal.

Response

The search results.

All 21 operations