Skip to main content
POST
Search the web and get titles, links and snippets
  • Endpoint: web.search
  • Returns: data has results.
  • Cost: 1 credit per 10 items, at least 1 credit. Failed calls cost nothing.
  • Paging: No.
Supports from and to dates, country, language, and domains to include or exclude.

Example

Authorizations

Authorization
string
header
required

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

Body

application/json
query
string
required
Required string length: 1 - 400
country
string

ISO 3166-1 alpha-2 country code, e.g. us. Any case is accepted.

Pattern: ^[A-Za-z]{2}$
language
string

BCP 47 language tag, e.g. en or pt-BR. Any case is accepted.

Pattern: ^[A-Za-z]{2}$
includeDomains
string[]
Maximum array length: 10
excludeDomains
string[]
Maximum array length: 10
from
string<date>
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
to
string<date>
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
limit
integer
default:10
Required range: 1 <= x <= 100
within
enum<string>
default:all
Available options:
day,
week,
month,
year,
all

Response

The data, and the credits this call used.

success
any
required
data
object
required
creditsUsed
integer
required
requestId
string
required