Skip to main content
POST
Search the web

Authorizations

X-API-Key
string
header
required

Body

application/json
query
string
required

What to search the web for.

Maximum string length: 500
Example:

"best open source vector databases"

limit
number

How many ranked results to return. Omit for the default.

Required range: 1 <= x <= 15
Example:

5

scrapeResults
boolean

When true, each result also comes back with its page fetched and returned as clean data, at 1 additional credit per page scraped. Defaults to false, which returns just the ranked title, url and snippet for the flat search credit.

Example:

false

scrapeOptions
object
timeRange
enum<string>

Restrict results to a recency window relative to now.

Available options:
day,
week,
month,
year
Example:

"week"

country
string

ISO 3166 alpha-2 country code to bias results toward a region.

Example:

"us"

includeDomains
string[]

Only return results from these domains.

Maximum array length: 15
Example:
excludeDomains
string[]

Drop results from these domains.

Maximum array length: 15
Example:

Response

The ranked search results.

data
object
required