Skip to main content
POST
Web Search

Authorizations

Authorization
string
header
required

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

Headers

X-Mdlx-User-Id
string
required

Stable end-user identifier supplied by the API caller.

Required string length: 8 - 128
Pattern: ^[A-Za-z0-9_-]+$

Body

application/json
query
string
required

Search query. Whitespace-only values are rejected by the service.

Minimum string length: 1
Pattern: .*\S.*
depth
enum<string>
default:standard
Available options:
lite,
standard,
rich
max_results
integer
default:5
Required range: 1 <= x <= 20
include_domains
string[]
Maximum array length: 50
exclude_domains
string[]
Maximum array length: 50
time_range
enum<string> | null
Available options:
day,
week,
month,
year
start_date
string<date>

Optional inclusive start date. It must not be after end_date.

end_date
string<date>

Optional inclusive end date.

topic
enum<string>
default:general
Available options:
general,
news,
finance
country
string | null

ISO 3166-1 alpha-2 country code.

Pattern: ^[A-Za-z]{2}$
include_answer
boolean
default:false

Must be false when depth is lite.

Response

Search completed and billed once according to depth.

query
string
required
depth
enum<string>
required
Available options:
lite,
standard,
rich
answer
string | null
required
results
object[]
required
warnings
string[]
required
billing
object
required
request_id
string
required