Skip to main content
POST

Authorizations

Authorization
string
header
required

Bearer token used for request authentication. Alternatively, you can send the API key in the x-api-key header.

Body

application/json
query
string
required

The search query.

Operators

  • site:<domain>: restrict results to a single domain. For multiple domains, use include_domains and exclude_domains.
  • -site:<domain>: exclude a single domain from the results.
Maximum string length: 500
count
integer
default:5

Number of results to return.

Required range: 1 <= x <= 100
include_domains
string[]

A list of domains to specifically include in the search results. The site: query operator adds to this list. Applies to results only; subject grouping does not support domain filtering.

Maximum array length: 1200
Maximum string length: 60
Example:
exclude_domains
string[]

A list of domains to specifically exclude from the search results. The -site: query operator adds to this list. If a domain appears in both include_domains and exclude_domains, exclude_domains takes precedence. Applies to results only; subject grouping does not support domain filtering.

Maximum array length: 1200
Maximum string length: 60
Example:
time_basis
enum<string>
default:auto

Determines which time field is used for time filtering. published uses time_published; crawled uses time_last_crawled. Results missing this field are excluded when filtering by time.

Available options:
auto,
published,
crawled
time_range
enum<string>

Relative time window counting back from the current time based on time_basis. Mutually exclusive with start_time/end_time: if both are provided, start_time/end_time take precedence.

Available options:
day,
week,
month,
year,
d,
w,
m,
y
start_time
string<date-time>

Start time for filtering results. ISO 8601 format.

Example:

"2026-08-22T00:00:00Z"

end_time
string<date-time>

End time for filtering results. ISO 8601 format.

Example:

"2026-08-24T00:00:00Z"

language
enum<string>[]

A list of languages to restrict results to, as ISO 639-1 codes. Applies to both results and subjects.

Available options:
ar,
de,
en,
es,
fr,
hi,
id,
it,
ja,
ko,
nl,
pl,
pt,
ru,
th,
tr,
vi,
zh
Example:
highlight
object

Controls highlight extraction from result pages.

full_content
object

Controls whether to return the full raw content of each result page.

subjects
object

Controls subject grouping, which clusters related articles into events.

Response

Successful news search response

code
integer

Business status code. 0 indicates success.

msg
string

A message describing the result.

request_id
string

The unique identifier for this request.

data
object

The main response payload.

meta
object

Additional metadata for the search request.