Search

Search articles

Full-text search across the NewsCatcher News API index. Supports filtering by keyword, language, country, source, publication date, and dozens of other parameters; results can optionally be grouped into clusters of similar articles.

post/api/search

Request

  • Base URL
    https://v3-api.newscatcherapi.com (the document declares no server; this is the origin it was published from)
  • Auth
    none declared. Required headers: x-api-token

Headers

x-api-tokenstring required

Your NewsCatcher API key, used to authenticate this request.

Request body

qstring required

Search query using Lucene-like syntax: supports boolean operators (AND, OR, NOT, and &&, ||, ! as aliases), exact phrase matching with double quotes, grouping with parentheses, and wildcards. Cannot be empty.

search_instring

Which fields to search the query against. Up to 2 values from: title, content, title_content, summary (summary requires an NLP plan). NLP/translation plans additionally allow searching translated fields: title_translated, content_translated, summary_translated, title_content_translated.

predefined_sourcesunknown
sourcesunknown
source_groupsunknown
not_sourcesunknown
langunknown
not_langunknown
countriesunknown
not_countriesunknown
not_author_nameunknown
published_date_precisionstring

Filter by how precisely the published date is known: 'full' (exact date and time), 'date' (day known, time unknown), or 'timezone unknown' (date and time known, but not the timezone).

sort_bystring

Sort order for results: 'relevancy' (default, best text match first), 'date' (newest first), '-date' (oldest first), or 'rank' (most authoritative source first).

parent_urlunknown
all_linksunknown
all_domain_linksunknown
all_links_textunknown
clustering_variablestring

Which article field to base clustering similarity on: 'content', 'title', or 'summary'.

has_nlpboolean

When true, only returns articles that have NLP enrichment data. Requires an NLP plan.

themestring

Filter by article theme. One of: Business, Politics, Entertainment, Sports, Finance, Crime, Tech, General, Health, Economics, Science, Automotive, Weather, Travel, Lifestyle, Financial Crime. Comma-separated values are OR'd together; values joined with ' AND ' within one comma-separated group must all match the same article (e.g. 'Tech AND Finance,Sports' matches Tech-and-Finance articles, or Sports articles).

not_themestring

Exclude articles with any of the given themes. Same allowed values as theme, but does not support ' AND ' grouping - always excludes on any match.

ORG_entity_namestring

Filter articles that mention the given organization name(s) in NLP-extracted named entities. Requires an NLP plan.

PER_entity_namestring

Filter articles that mention the given person name(s) in NLP-extracted named entities. Requires an NLP plan.

LOC_entity_namestring

Filter articles that mention the given location name(s) in NLP-extracted named entities. Requires an NLP plan.

MISC_entity_namestring

Filter articles that mention the given miscellaneous entity name(s) in NLP-extracted named entities. Requires an NLP plan.

title_sentiment_minnumber

Minimum sentiment score for the article title, from -1 (most negative) to 1 (most positive), as determined by NLP analysis. Requires an NLP plan.

title_sentiment_maxnumber

Maximum sentiment score for the article title, from -1 (most negative) to 1 (most positive), as determined by NLP analysis. Requires an NLP plan.

content_sentiment_minnumber

Minimum sentiment score for the article content, from -1 (most negative) to 1 (most positive), as determined by NLP analysis. Requires an NLP plan.

content_sentiment_maxnumber

Maximum sentiment score for the article content, from -1 (most negative) to 1 (most positive), as determined by NLP analysis. Requires an NLP plan.

iptc_tagsunknown
not_iptc_tagsunknown
source_nameunknown
iab_tagsunknown
not_iab_tagsunknown
news_domain_typeunknown
news_typeunknown

Response

Successful Response

OR

Changes

No recorded changes to this operation across all 1 revision of this API.