terms | ✅ | The broad or exact word or phrase of up to 255 characters 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) |
engine | ⬜ | The search engine to use, google or bing (coming soon); google is the default engine |
serps | ⬜ | The number of results pages to retrieve, from 1 to 10 inclusive; 1 is the default count |
size | ⬜ | The number of results per page to retrieve, from 0 to 100 inclusive; page size is unset by default |
offset | ⬜ | The number of initial results to skip, from 0 to 100 inclusive; results aren’t offset by default |
device | ⬜ | 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 |
uule | ⬜ | 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 |
language | ⬜ | 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 |
display | ⬜ | 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 |
url | ⬜ | The encoded URL of up to 2,047 characters of the results page to retrieve; if given, the URL overrides any of the above params |
awaiting | ⬜ | The lazy result features to wait to load, an ai overview, “People also ask” answers, or sponsored ads; 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 |
expiration | ⬜ | The age in days of when to consider cached results expired, where 0 disables caching; 1 is the default number of days before expiration |
callback | ⬜ | The encoded HTTP or HTTPS callback URL or Amazon SQS queue URL or ARN of up to 2,047 characters to notify when the (prerequisite) asynchronous results have been retrieved; any SQS queue must grant sqs:SendMessage permission to the arn:aws:iam::180363035301:role/api-instance AWS principal |
