Skip to main content
POST
Search articles

Authorizations

x-api-token
string
header
required

API Key to authenticate requests.

To access the API, include your API key in the x-api-token header. To obtain your API key, complete the form or contact us directly.

Body

application/json

Request body for searching articles based on specified criteria such as keyword, language, country, source, and more.

q
string
required

The keyword(s) to search for in articles. Query syntax supports logical operators (AND, OR, NOT) and wildcards:

  • For exact phrases, use escaped quotes: \"technology news\"
  • Use * for wildcards: technolog* (cannot start with *)
  • Use + to include and - to exclude: +Apple, -Google
  • Boolean operators: technology AND (Apple OR Microsoft) NOT Google
  • Forbidden characters: [ ] / \\ : ^ and URL-encoded equivalents

Note: The API automatically inserts AND operators between standalone terms, so strings like "machine learning" become "machine AND learning". To avoid syntax errors (especially in queries with OR operators), use literal escape "\"machine learning\"".

For detailed syntax rules, see Advanced querying.

Example:

"\"supply chain\" AND Amazon NOT China"

search_in
string
default:title_content

The article fields to search in. Use a comma-separated string for multiple options, with a maximum of 2 in a single request.

Available options:

  • Standard fields: title, content, summary, title_content
  • Translation fields: title_translated, content_translated, summary_translated, title_content_translated
Example:

"title_content, title_content_translated"

include_translation_fields
boolean
default:false

If true, includes English translation fields in the response (title_translated_en, content_translated_en, and NLP translation fields).

Example:

true

predefined_sources

Predefined top news sources per country.

Format: start with the word top, followed by the number of desired sources, and then the two-letter country code ISO 3166-1 alpha-2.

Multiple countries with the number of top sources can be specified as a comma-separated string or an array of strings.

Example:

"top 50 US, top 20 GB"

source_groups

Restricts the search to one or more source groups, given by slug. A source group is a ready-made list of publisher domains that the NewsCatcher team curates for a common use case, for example top_100_financial_news or financial_regulators_central_banks. Use it instead of listing the domains yourself in sources. To specify multiple groups, use a comma-separated string or an array of strings. You can pass up to 20 groups.

To see the available groups, call List source groups.

Note: The domains of all groups are merged with sources and predefined_sources, so you can add your own domains on top of a group. As with sources, the countries and not_countries filters are ignored when source_groups is set. An unknown slug returns a 422 error.

Example:

"top_100_financial_news,wires_news_agencies_global"

source_name

Specifies terms to search within the source names. To specify multiple terms, use a comma-separated string or an array of strings.

Note: The search does not require an exact match and returns all sources that include the specified terms anywhere in their names. You can use any word, phrase, or outlet name, such as "sport", or "new york times". For example, using "sport" as a term returns sources like "Motorsport", "Dot Esport", and "Tuttosport".

Example:

"sport, tech"

sources

One or more news sources to narrow down the search. The format must be a domain URL. Subdomains, such as finance.yahoo.com, are also acceptable. To specify multiple sources, use a comma-separated string or an array of strings.

Example:

"nytimes.com, theguardian.com"

not_sources

The news sources to exclude from the search. To exclude multiple sources, use a comma-separated string or an array of strings.

Example:

"cnn.com, wsj.com"

lang

The language(s) of the search. The only accepted format is the two-letter ISO 639-1 code. To select multiple languages, use a comma-separated string or an array of strings.

To learn more, see Enumerated parameters > Language.

Example:

"en,es"

not_lang

The language(s) to exclude from the search. The accepted format is the two-letter ISO 639-1 code. To exclude multiple languages, use a comma-separated string or an array of strings.

To learn more, see Enumerated parameters > Language.

Example:

"fr,de"

countries

The countries where the news publisher is located. The accepted format is the two-letter ISO 3166-1 alpha-2 code. To select multiple countries, use a comma-separated string or an array of strings.

To learn more, see Enumerated parameters > Country.

Example:

"US,CA"

not_countries

The publisher location countries to exclude from the search. The accepted format is the two-letter ISO 3166-1 alpha-2 code. To exclude multiple countries, use a comma-separated string or an array of strings.

To learn more, see Enumerated parameters > Country.

Example:

"UK,FR"

not_author_name

The list of author names to exclude from your search. To exclude articles by specific authors, use a comma-separated string or an array of strings.

Example:

"John Doe, Jane Doe"

from_
default:7 days ago

The starting point in time to search from. Accepts date-time strings in ISO 8601 format and plain text strings. The default time zone is UTC.

Formats with examples:

  • YYYY-mm-ddTHH:MM:SS: 2024-07-01T00:00:00
  • YYYY-MM-dd: 2024-07-01
  • YYYY/mm/dd HH:MM:SS: 2024/07/01 00:00:00
  • YYYY/mm/dd: 2024/07/01
  • English phrases: 7 day ago, today
  • Duration shorthand: 7d, 30d, 24h, 48h

Note: By default, applied to the publication date of the article. To use the article's parse date instead, set the by_parse_date parameter to true.

Example:

"2021/01/01"

to_
default:now

The ending point in time to search up to. Accepts date-time strings in ISO 8601 format and plain text strings. The default time zone is UTC.

Formats with examples:

  • YYYY-mm-ddTHH:MM:SS: 2024-07-01T00:00:00
  • YYYY-MM-dd: 2024-07-01
  • YYYY/mm/dd HH:MM:SS: 2024/07/01 00:00:00
  • YYYY/mm/dd: 2024/07/01
  • English phrases: 1 day ago, now
  • Duration shorthand: 7d, 30d, 24h, 48h

Note: By default, applied to the publication date of the article. To use the article's parse date instead, set the by_parse_date parameter to true.

Example:

"now"

published_date_precision
string

The precision of the published date. There are three types:

  • full: The day and time of an article is correctly identified with the appropriate timezone.
  • timezone unknown: The day and time of an article is correctly identified without timezone.
  • date: Only the day is identified without an exact time.
Example:

"full"

by_parse_date
boolean
default:false

If true, the from_ and to_ parameters use article parse dates instead of published dates. Additionally, the parse_date variable is added to the output for each article object.

In the Aggregation count endpoint, the articles are also counted per interval by their parse date.

Example:

true

sort_by
enum<string>
default:relevancy

The sorting order of the results. Possible values are:

  • relevancy: The most relevant results first.
  • date: The most recently published results first.
  • rank: The results from the highest-ranked sources first.
Available options:
relevancy,
date,
rank
Example:

"date"

ranked_only
boolean
default:true

If true, limits the search to sources ranked in the top 1 million online websites. If false, includes unranked sources which are assigned a rank of 999999.

Example:

true

from_rank
integer<int32>
default:1

The lowest boundary of the rank of a news website to filter by. A lower rank indicates a more popular source.

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

100

to_rank
integer<int32>
default:999999

The highest boundary of the rank of a news website to filter by. A lower rank indicates a more popular source.

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

100

is_headline
boolean

If true, only returns articles that were posted on the home page of a given news domain.

Example:

true

is_opinion
boolean

If true, returns only opinion pieces. If false, excludes opinion-based articles and returns news only.

Example:

true

is_paid_content
boolean

Filters articles by content completeness.

If false, returns only articles for which full-text content is publicly available. If true, returns all indexed articles, including those where only partial content is publicly available (e.g., headlines, summaries, or preview paragraphs from paywalled sources).

Note: NewsCatcher indexes content that is publicly accessible and available for crawling in accordance with publisher access controls (e.g., robots.txt and similar mechanisms). For paywalled sources, only content that publishers make publicly available (such as headlines, summaries, or preview text) is indexed. NewsCatcher does not bypass paywalls, authentication systems, or other technical access restrictions.

Example:

false

parent_url

The categorical URL(s) to filter your search. To filter your search by multiple categorical URLs, use a comma-separated string or an array of strings.

Example:

"wsj.com/politics,wsj.com/tech"

all_links

The complete URL(s) mentioned in the article. For multiple URLs, use a comma-separated string or an array of strings.

For more details, see Search by URL.

Example:

"https://aiindex.stanford.edu/report/, https://www.stateof.ai/"

all_domain_links

The domain(s) mentioned in the article. For multiple domains, use a comma-separated string or an array of strings.

For more details, see Search by URL.

Example:

"who.int, nih.gov"

all_links_text

The text content of links mentioned in the article. Searches for links where the anchor text contains the specified terms. For multiple terms, use a comma-separated string or an array of strings.

Note: When this parameter is used, the response includes the all_links_data field with detailed link information.

For more details, see Search by URL.

Example:

"Nvidia, Tesla"

additional_domain_info
boolean

If true, includes additional domain information in the response for each article:

  • is_news_domain: Boolean indicating if the source is a news domain.
  • news_domain_type: Type of news domain (e.g., "Original Content").
  • news_type: Category of news (e.g., "News and Blogs").
Example:

true

is_news_domain
boolean

If true, filters results to include only news domains.

Example:

true

news_domain_type

Filters results based on the news domain type. Multiple types can be specified using a comma-separated string or an array of strings. Possible values are:

  • Original Content: Sources that produce their own content.
  • Aggregator: Sources that collect content from various other sources.
  • Press Releases: Sources primarily publishing press releases.
  • Republisher: Sources that republish content from other sources.
  • Other: Sources that don't fit into main categories.
Example:

"Original Content"

news_type

Filters results based on the news type. Multiple types can be specified using a comma-separated string or an array of strings.

For a complete list of available news types, see Enumerated parameters > News type.

Example:

"General News Outlets,Tech News and Updates"

word_count_min
integer

The minimum number of words an article must contain. To be used for avoiding articles with small content.

Required range: x >= 0
Example:

300

word_count_max
integer

The maximum number of words an article can contain. To be used for avoiding articles with large content.

Required range: x >= 0
Example:

1000

page
integer
default:1

The page number to scroll through the results. Use for pagination, as a single API response can return up to 1,000 articles.

For details, see Retrieve large datasets

Required range: x >= 1
Example:

2

page_size
integer
default:100

The number of articles to return per page.

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

50

clustering_enabled
boolean
default:false

Determines whether to group similar articles into clusters. If true, the API returns clustered results.

To learn more, see Clustering news articles.

Example:

true

clustering_variable
enum<string>
default:content
deprecated

Deprecated from January 1, 2026 onward. For articles published on or after 2026-01-01, this parameter is ignored. Clustering always uses a combined title + content embedding generated by the Qwen3-Embedding-0.6B model, regardless of the value supplied.

For articles published before 2026-01-01, this parameter remains functional and specifies which part of the article to use for clustering:

  • content: Uses the full article content (default).
  • title: Uses only the article title.
  • summary: Uses the article summary.

To learn more, see Clustering news articles.

Available options:
content,
title,
summary
Example:

"content"

clustering_threshold
number<float>
default:0.7

Sets the similarity threshold for grouping articles into clusters. A lower value creates more inclusive clusters, while a higher value requires greater similarity between articles.

For example:

  • 0.6: Results in larger, more diverse clusters.
  • 0.7: Balances cluster size and article similarity (default).
  • 0.8: Creates smaller, tightly related clusters.

To learn more, see Clustering news articles.

Required range: x <= 1
Example:

0.7

include_nlp_data
boolean
default:false

If true, includes an NLP object for each article in the response. This object provides results of NLP analysis, including article theme, summary, sentiment, tags, and named entity recognition if available.

Note: NLP data is only available for articles indexed from July 2023 onward. For articles indexed before July 2023, the nlp field is returned as an empty object {}.

To learn more, see NLP Enrichments.

Example:

true

has_nlp
boolean
default:false

If true, filters results to include only articles that have NLP data.

Note: NLP data is only available for articles indexed from July 2023 onward. Applying this filter to a date range that predates July 2023 returns zero results.

To learn more, see NLP Enrichments.

Example:

true

theme
string

Filters articles based on their general topic, as determined by NLP analysis. To select multiple themes, use a comma-separated string.

To learn more, see NLP Enrichments.

Available options: Business, Economics, Entertainment, Finance, Health, Politics, Science, Sports, Tech, Crime, Financial Crime, Lifestyle, Automotive, Travel, Weather, General.

Example:

"Finance,Tech"

not_theme
string

Inverse of the theme parameter. Excludes articles based on their general topic, as determined by NLP analysis. To exclude multiple themes, use a comma-separated string.

To learn more, see NLP Enrichments.

Example:

"Crime,Sports"

content_type

Filters articles by content type: the kind of page an article is, as determined by NLP analysis. To select multiple content types, use a comma-separated string or an array of strings. Values are case-insensitive, and an article is returned if it matches any of them.

Available options: news_report, analysis, interview, opinion, press_release, listicle, service, commerce, review, autogen, seo_spam, obituary, ugc, non_article. Shortcuts: news selects news_report, analysis, and interview; all applies no filter.

Note: Articles without a content type label are excluded whenever content_type is set. An unknown value returns a 422 error.

To learn more, see Content types.

Example:

"news"

ORG_entity_name
string

Filters articles that mention specific organization names, as identified by NLP analysis.

  • To specify multiple organizations, use AND, OR, NOT operators, and \" escape literals for exact matches.
  • To search in translations, combine with the translation options of the search_in parameter (e.g., title_content_translated).

To learn more, see Search by entity.

Example:

"\"Apple Inc\" OR Microsoft"

PER_entity_name
string

Filters articles that mention specific person names, as identified by NLP analysis.

  • To specify multiple names, use AND, OR, NOT operators, and \" escape literals for exact matches.
  • To search in translations, combine with the translation options of the search_in parameter (e.g., title_content_translated).

To learn more, see Search by entity.

Example:

"\"Elon Musk\" OR \"Jeff Bezos\""

LOC_entity_name
string

Filters articles that mention specific location names, as identified by NLP analysis.

  • To specify multiple locations, use AND, OR, NOT operators, and \" escape literals for exact matches.
  • To search in translations, combine with the translation options of the search_in parameter (e.g., title_content_translated).

To learn more, see Search by entity.

Example:

"\"San Francisco\" OR \"New York City\""

MISC_entity_name
string

Filters articles that mention other named entities not falling under person, organization, or location categories. Includes events, nationalities, products, works of art, and more.

  • To specify multiple entities, use AND, OR, NOT operators, and \" escape literals for exact matches.
  • To search in translations, combine with the translation options of the search_in parameter (e.g., title_content_translated).

To learn more, see Search by entity.

Example:

"AWS OR \"Microsoft Azure\""

title_sentiment_min
number<float>

Filters articles based on the minimum sentiment score of their titles.

Range is -1.0 to 1.0, where:

  • Negative values indicate negative sentiment.
  • Positive values indicate positive sentiment.
  • Values close to 0 indicate neutral sentiment.

To learn more, see NLP Enrichments.

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

-0.5

title_sentiment_max
number<float>

Filters articles based on the maximum sentiment score of their titles.

Range is -1.0 to 1.0, where:

  • Negative values indicate negative sentiment.
  • Positive values indicate positive sentiment.
  • Values close to 0 indicate neutral sentiment.

To learn more, see NLP Enrichments.

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

0.5

content_sentiment_min
number<float>

Filters articles based on the minimum sentiment score of their content.

Range is -1.0 to 1.0, where:

  • Negative values indicate negative sentiment.
  • Positive values indicate positive sentiment.
  • Values close to 0 indicate neutral sentiment.

To learn more, see NLP Enrichments.

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

-0.5

content_sentiment_max
number<float>

Filters articles based on the maximum sentiment score of their content.

Range is -1.0 to 1.0, where:

  • Negative values indicate negative sentiment.
  • Positive values indicate positive sentiment.
  • Values close to 0 indicate neutral sentiment.

To learn more, see NLP Enrichments.

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

0.5

iptc_tags

Filters articles based on International Press Telecommunications Council (IPTC) media topic tags. To specify multiple IPTC tags, use a comma-separated string or an array of strings.

Note: The iptc_tags parameter is only available in the v3_nlp_iptc_tags subscription plan.

To learn more, see IPTC Media Topic NewsCodes.

Example:

"20000199,20000209"

not_iptc_tags

Inverse of the iptc_tags parameter. Excludes articles based on International Press Telecommunications Council (IPTC) media topic tags. To specify multiple IPTC tags to exclude, use a comma-separated string or an array of strings.

Note: The not_iptc_tags parameter is only available in the v3_nlp_iptc_tags subscription plan.

To learn more, see IPTC Media Topic NewsCodes.

Example:

"20000205, 20000209"

iab_tags

Filters articles based on Interactive Advertising Bureau (IAB) content categories.These tags provide a standardized taxonomy for digital advertising content categorization. To specify multiple IAB categories, use a comma-separated string or an array of strings.

Note: The iab_tags parameter is only available in the v3_nlp_iptc_tags subscription plan.

To learn more, see the IAB Content taxonomy.

Example:

"Business,Events"

not_iab_tags

Inverse of the iab_tags parameter. Excludes articles based on Interactive Advertising Bureau (IAB) content categories. These tags provide a standardized taxonomy for digital advertising content categorization. To specify multiple IAB categories to exclude, use a comma-separated string or an array of strings.

Note: The not_iab_tags parameter is only available in the v3_nlp_iptc_tags subscription plan.

To learn more, see the IAB Content taxonomy.

Example:

"Agriculture,Metals"

custom_tags

Filters articles based on provided taxonomy that is tailored to your specific needs and is accessible only with your API key. To specify tags, use the following pattern:

  • custom_tags.taxonomy=Tag1,Tag2, where taxonomy is the taxonomy name and Tag1,Tag2 are comma-separated tag names. For POST requests, you can also specify tags as an array of strings.

To learn more, see the Custom tags.

Example:

"Tag1,Tag2"

exclude_duplicates
boolean

If true, excludes duplicate and highly similar articles from the search results. If false, returns all relevant articles, including duplicates.

To learn more, see Articles deduplication.

Example:

true

robots_compliant
boolean

If true, returns only articles that comply with the publisher's robots.txt rules. If false, returns only articles that do not comply with robots.txt rules. If omitted, returns all articles regardless of compliance status.

Example:

true

Response

A successful response containing articles that match the search criteria. When clustering_enabled is true, returns a Clustered Articles Response. Otherwise, returns a Search Response.

The response model for the search requests applies to the Search, Latest Headlines, Search by link, and Authors endpoints. Response field behavior:

  • Required fields are guaranteed to be present and non-null.
  • Optional fields may be null or undefined if the data point is not presented or couldn't be extracted during processing.
  • To access article properties in the articles response array, use array index notation. For example, articles[n].title, where n is the zero-based index of the article object (0, 1, 2, etc.).
  • The nlp property within the article object articles[n].nlp is only available with NLP-enabled subscription plans.
status
string
required

The status of the response.

total_hits
integer
required

The total number of articles matching the search criteria.

page
integer
required

The current page number of the results.

total_pages
integer
required

The total number of pages available for the given search criteria.

page_size
integer
required

The number of articles per page.

articles
Article Object · object[]

A list of articles matching the search criteria.

user_input
object

The user input parameters for the request.