Newscatcher AggregationCount API is one of 16 APIs that Newscatcher publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include AggregationCount. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes
2 operations
across 1 path,
and defines 52 schemas.
It is described by OpenAPI 3.2.0, at version 3.24.0.
Requests are made against a single base URL, https://v3-api.newscatcherapi.com.
The identity and technical contract details declared by the specification.
WordCountMin
integer
The minimum number of words an article must contain. To be used for avoiding articles with small content.
BaseSearchResponseDto
object
The base response model containing common fields for search operations.
5 properties
5 required
FromRank
integer
The lowest boundary of the rank of a news website to filter by. A lower rank indicates a more popular source.
RobotsCompliant
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…
From
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 exam…
ContentSentimentMax
number
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…
WordCountMax
integer
The maximum number of words an article can contain. To be used for avoiding articles with large content.
UserInputDto
object
The user input parameters for the request.
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…
OrgEntityName
string
Filters articles that mention specific organization names, as identified by NLP analysis. - To specify multiple organizations, use AND, OR, NOT operators, and…
AllLinksText
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-sepa…
Countries
The countries where the news publisher is located. The accepted format is the two-letter [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO3166-1alpha-2) c…
AllDomainLinks
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](https:…
Error
object
3 properties
3 required
IsPaidContent
boolean
Filters articles by content completeness. If false, returns only articles for which full-text content is publicly available. If true, returns all indexed artic…
PageSize
integer
The number of articles to return per page.
NotLang
The language(s) to exclude from the search. The accepted format is the two-letter [ISO 639-1](https://en.wikipedia.org/wiki/ISO639-1) code. To exclude multiple…
FailedAggregationCountResponseDto
The response model for a failed Aggregation count request.
Lang
The language(s) of the search. The only accepted format is the two-letter [ISO 639-1](https://en.wikipedia.org/wiki/ISO639-1) code. To select multiple language…
SearchIn
string
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 fiel…
HasNlp
boolean
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 thi…
ByParseDate
boolean
If true, the from and to parameters use article parse dates instead of published dates. Additionally, the parsedate variable is added to the output for each ar…
To
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 examp…
TitleSentimentMax
number
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 v…
AllLinks
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](htt…
IsHeadline
boolean
If true, only returns articles that were posted on the home page of a given news domain.
ToRank
integer
The highest boundary of the rank of a news website to filter by. A lower rank indicates a more popular source.
NotAuthorName
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.
SortBy
string
The sorting order of the results. Possible values are: - relevancy: The most relevant results first. - date: The most recently published results first. - rank:…
PerEntityName
string
Filters articles that mention specific person names, as identified by NLP analysis. - To specify multiple names, use AND, OR, NOT operators, and \" escape lite…
ContentSentimentMin
number
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…
PublishedDatePrecision
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. - tim…
Q
string
The keyword(s) to search for in articles. Query syntax supports logical operators (AND, OR, NOT) and wildcards: - For exact phrases, use escaped quotes: \"tech…
NotSources
The news sources to exclude from the search. To exclude multiple sources, use a comma-separated string or an array of strings.
Page
integer
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 d…
LocEntityName
string
Filters articles that mention specific location names, as identified by NLP analysis. - To specify multiple locations, use AND, OR, NOT operators, and \" escap…
IncludeNlpData
boolean
If true, includes an NLP object for each article in the response. This object provides results of NLP analysis, including article theme, summary, sentiment, ta…
AggregationCountResponseDto
The response model for a successful Aggregation count request. Response field behavior: - Required fields are guaranteed to be present and non-null. - Optional…
MiscEntityName
string
Filters articles that mention other named entities not falling under person, organization, or location categories. Includes events, nationalities, products, wo…
NotIptcTags
Inverse of the iptctags parameter. Excludes articles based on International Press Telecommunications Council (IPTC) media topic tags. To specify multiple IPTC…
ParentUrl
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.
TimeFrameCount
object
Represents the article count for a specific time frame.
2 properties
2 required
NotCountries
The publisher location countries to exclude from the search. The accepted format is the two-letter [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO3166-1…
PredefinedSources
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…
NotTheme
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-separate…
AggregationBy
string
The aggregation interval for the results.
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 mul…
AggregationItem
object
A single item in the aggregations array containing a collection of time-based article counts.
1 property
1 required
IsOpinion
boolean
If true, returns only opinion pieces. If false, excludes opinion-based articles and returns news only.
IptcTags
Filters articles based on International Press Telecommunications Council (IPTC) media topic tags. To specify multiple IPTC tags, use a comma-separated string o…
TitleSentimentMin
number
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 v…
RankedOnly
boolean
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.
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Newscatcher publishes across the network.
