Skip to main content
POST
Best when you want web results, news, images or all three at once, grouped by type, with the page text of the top web results if you ask for it. Send categories research for scholarly papers with authors, venue and citation counts, companies for company profiles filtered by place, industry, size and founding year, people for people by role, company, place or research topic, or developer for passages from GitHub issues, pull requests, releases, READMEs, developer docs and API operations.
Works without an API key, up to 10 calls a minute and 50 a day per IP. See Rate limits.

Price

2 credits per 10 results from each source and each research, companies, people or developer list, plus 1 credit for each web result that comes back with its page text when scrapeOptions is on. See Pricing for what credits cost.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

maxTextLength
integer

Cut every text value in the response to this many characters. A value that was cut ends with …, and a page whose text was cut has isTruncated set to true. A screenshot is never cut. Leave it out to get the full text.

Required range: x >= 1

Body

application/json
query
string
required
Required string length: 1 - 400
sources
enum<string> · object · object[]

What to search: web, news, images. Each is a string or {type}. Default web, or none when categories asks for research, companies, people or developer.

Required array length: 1 - 3 elements
Available options:
web,
news,
images
categories
enum<string> · object · object[]

pdf: web results that are PDF files. research: scholarly papers, in a research list, ranked by relevance then citations. companies: companies that match the query, in a companies list, best matches first. The query can name a place, industry, employee count, founding year and funding stage, like fintech startups in Berlin, 50-200 employees. people: people that match the query, in a people list, best matches first. The query can name a role, company, place or research topic, like CFO of Stripe, founders of fintech startups in Berlin, or researchers on CRISPR base editing. Each person has roles, affiliations and public profile links, never contact details. developer: passages from GitHub READMEs, issues, merged pull requests, releases, developer docs and API operations, in a developer list; send it as an object to filter by repos, types, language and minStars.

Available options:
developer,
gov,
research,
pdf,
companies,
people
maxAge
integer

Accept a stored answer up to this many milliseconds old, at most 30 days. Without it, 15 minutes for news and 1 hour for web and images. 0 always searches live.

Required range: 0 <= x <= 9007199254740991
limit
integer

Most results to return for each source. Default 10, or 5 with scrapeOptions, which reads at most 5 pages. News returns at most 50.

Required range: 1 <= x <= 100
tbs
string

Time filter: qdr:h, qdr:d, qdr:w, qdr:m or qdr:y, or cdr:1,cd_min:MM/DD/YYYY,cd_max:MM/DD/YYYY. Web takes both; news takes qdr only; images take none.

Minimum string length: 1
location
string

Where to search from, like Germany or San Francisco,California,United States. The last part is the country and replaces country. A city before it narrows web results to that place.

Minimum string length: 1
country
string

Two-letter country to search from, like us. Image results are always US.

Pattern: ^[A-Za-z]{2}$
includeDomains
string[]
Maximum array length: 10
excludeDomains
string[]
Maximum array length: 10
safe
boolean

Hide explicit web and image results when true.

timeout
integer
default:60000

Milliseconds to wait for the sources.

Required range: 1000 <= x <= 9007199254740991
ignoreInvalidURLs
boolean
default:false

Leave out results whose address cannot be read as a page.

highlights
boolean
default:true

On by default. When a web result's page is already stored, its description is the passages of that page that best match the query. Send false for the snippet the search engine shows.

domainTools
boolean
toolDetail
string
Allowed value: "compact"
enterprise
string[]
threatProtection
object
scrapeOptions
object

Reads the top web results, up to 5, and puts the passages that best match the query in each description. Add "markdown" to formats to get the whole page text too. Costs 1 more credit for each page read.

Response

The data, and the credits this call used.

success
boolean
required
creditsUsed
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
data
object
warning
string