Skip to main content
POST
Search the news

Authorizations

X-API-Key
string
header
required

Headers

Idempotency-Key
string

Any unique string up to 255 visible characters. Send the same key when you retry a request: for 12 hours a repeat returns the first answer again, with an Idempotent-Replayed: true header, without doing the work or charging a second time. A repeat that arrives while the first is still running gets 409 IDEMPOTENCY_IN_PROGRESS; the same key with a different body gets 409 IDEMPOTENCY_KEY_REUSED.

Maximum string length: 255
Example:

"3f2b8c1e-retry-safe-key"

Body

application/json
query
string
required

What to find news about.

Maximum string length: 500
Example:

"startup raises series A"

limit
integer
default:10

How many articles to return, newest first.

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

10

timeRange
enum<string>
default:week

Only articles published within this window before now.

Available options:
hour,
day,
week,
month
Example:

"week"

maxAge
integer

Accept a recent answer to the same search no older than this many milliseconds. Leave it out to accept answers up to 5 minutes old for hour, 15 for day and 30 for week or month. 0 always searches fresh.

Required range: x >= 0
Example:

0

country
string

ISO 3166 alpha-2 country code to lean results toward that edition.

Example:

"us"

includeDomains
string[]

Only return articles from these sites.

Maximum array length: 15
Example:
excludeDomains
string[]

Drop articles from these sites.

Maximum array length: 15
Example:
scrapeResults
boolean

When true, each article also comes back with its page read and returned as clean data, at 1 additional credit per article read.

Example:

false

scrapeOptions
object

Response

Matching articles, newest first.

data
object
required