Skip to main content
POST
Search news
1 credit per 10 results See the guide for examples and usage.

Authorizations

Authorization
string
header
required

Send Authorization: Bearer <API_KEY>. Keys have full access unless restricted to scopes.

Body

application/json
searchBy
object
required

What to search for.

filterBy
object

Optional result filters. Use at most one of sourceDomain, sourceCountry, articleLanguage, or articleType. A date range may accompany that category; date.from must not exceed date.to.

sortBy
object

Result ordering. Defaults to newest.

limit
integer
default:10

Maximum results to return. Defaults to 10.

Required range: 1 <= x <= 100
cursor
string | null

Opaque next_cursor from the previous response, or null for the first page.

Maximum string length: 300
tags
string[]

Labels for filtering usage in the dashboard.

Maximum array length: 20
Required string length: 1 - 50
Example:

Response

Company news results

data
object[]
required

Articles matching the search, in the requested order.

has_more
boolean
required

True when more results are available beyond this page.

next_cursor
string | null
required

Pass as cursor in the next request to fetch the following page. Null when there are no more results.

meta
object
required

Summary information about this response.

request_id
string<uuid>
required

Unique ID of this request, also in X-Request-Id. Include it when contacting support.

Example:

"3f1c2a6e-8b4d-4c1e-9f0a-2d7b5e6c8a91"

key_metadata
object

Credits this request used and your remaining balance.