Skip to main content
GET
Search the web

Authorizations

X-API-Key
string
header
required

API key for authentication. Get your key from the API Keys page.

Query Parameters

query
string
required

Search query

Required string length: 1 - 2000
Example:

"web automation tools"

purpose
string

Why this search is being run — the underlying goal or task the results will be used for. Used to better rank results against your intent.

Required string length: 1 - 2000
Example:

"Find an open-source library for parsing PDF invoices in Python"

location
string

Country code for geo-targeted results

Example:

"US"

language
string

Language code for result language

Example:

"en"

include_domains
string

Comma-separated list of domains to restrict results to

Example:

"github.com,arxiv.org"

exclude_domains
string

Comma-separated list of domains to exclude from results

Example:

"pinterest.com,quora.com"

domain_type
enum<string>

Type of search to perform: "web" for standard results, "news" for news articles, "research_paper" for academic papers. Defaults to "web".

Available options:
web,
news,
research_paper
Example:

"news"

after_date
string

Return results after this date (YYYY-MM-DD)

Example:

"2024-01-01"

before_date
string

Return results before this date (YYYY-MM-DD)

Example:

"2024-12-31"

recency_minutes
integer

Return results from the past N minutes (1 to 5,256,000).

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

60

pub_year_min
integer

Return research papers published on or after this year (0-9999, inclusive). Only supported for domain_type=research_paper.

Required range: 0 <= x <= 9999
Example:

2019

pub_year_max
integer

Return research papers published on or before this year (0-9999, inclusive). Only supported for domain_type=research_paper.

Required range: 0 <= x <= 9999
Example:

2022

page
integer | null

Page number for pagination, starting from 0 (max 10)

Required range: 0 <= x <= 10
Example:

2

include_thumbnail
enum<string>

When "true", each result includes a thumbnail_url when available. Defaults to false.

Available options:
true,
false
Example:

"true"

fetch
string

JSON-encoded fetch configuration object.

Maximum string length: 256
Example:

"{}"

Response

Search completed successfully.

Search response with results

query
string
required

The search query that was executed

Example:

"web automation tools"

results
object[]
required

Array of search results

total_results
integer
required

Total number of results

Example:

10

page
integer
required

The current page number, starting from 0

Example:

0

request_id
string

Request correlation ID, also returned as the X-Request-ID response header. Present only when any result carries a fetch_error; include it when reporting failed fetches.

Example:

"8f9dba20-e37b-4749-a919-2269e28b4a2c"