Skip to main content

Search response

string
The query as received, with control characters replaced and the ends trimmed.
string
The effort that ran: low, medium or high.
string
The order of the results: relevancy (best match first), published_at or crawled_at (newest first).
integer
How long the search took on our side, in milliseconds.
object
The time window that was searched.
integer
Number of results returned, at most limit.
object[]
The articles, in the order of sort_by. See below.
string[]
The terms of the NOT clauses of q. Absent when q has no NOT.

Article

string
Article id.
string
Headline as published.
string
English translation of the headline. Non-English articles only.
string
One-line summary in the article’s language. Absent when the article has none.
string
One-line summary in English. Non-English articles only.
string
Start of the publisher’s description, up to your plan’s snippet length (200 characters on the free plan).
string
Link to the article.
object
The publisher: domain (without www.) and name.
string
ISO 639-1 code. Chinese is cn (simplified) or tw (traditional).
string
Country of the publisher, ISO 3166-1 alpha-2.
string
When the article was published (UTC, ISO 8601).
string
When NewsCatcher crawled it (UTC, ISO 8601).
string
The type of content the article was classified as, for example news_report.
object
The story it belongs to: id and newsrooms.
number
Ranking score. Only the order of the results means something, not the value.

Enterprise fields

Enterprise plans can add heavy fields to every result with include. Other plans get 403 with enterprise_field. Your plan’s fields are in extra_fields of GET /subscription. For everything else Enterprise plans add, see Enterprise plans.