The identity and technical contract details declared by the specification.
ClusteringSearchResponseDto
The response model when clustering is enabled, grouping similar articles into clusters. Applies to the Search and Latest headlines requests. Response field beh…
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.
GeoNamesLocationAdminEntity
object
3 properties
BaseArticleEntity
object
The data model representing the commont properties of the article object in the search results. Required fields are always non-null. Optional fields may be nul…
26 properties
9 required
ArticleSearchAdvancedResponseDto
The response model for the Search advanced, Latest headlines advanced, and Search by requests. Response field behavior: - Required fields are guaranteed to be…
PageSize_2
integer
The number of articles to return per page.
LocationEntity
object
2 properties
2 required
NamedEntityList
array
A list of named entities identified in the article.
ClusteredSearchResponseDto
The response model when clustering is enabled, grouping similar articles into clusters. Applies to the Search and Latest headlines requests. Response field beh…
NlpDataEntity_2
object
Natural Language Processing data for the article.
17 properties
ClusteringSearchAdvancedResponseDto
The response model when clustering is enabled, grouping similar articles into clusters. Applies to the Search advanced and Latest headlines advanced requests.…
GeoNamesOperator
string
The operator to combine multiple geonames objects. If AND, all geonames objects must match. If OR, at least one geonames object must match.
ArticleEntity
object
The data model representing a single article in the search results.
37 properties
8 required
DetectionMethods
array
The location detection methods to filter results by: - dedicatedsource: Identifies locations based on sources exclusively covering a specific location. - local…
SearchResponseDto
object
5 properties
5 required
LatestHeadlinesAdvancedRequestDto
GeoNamesFilter
array
Filters articles by geographic locations using structured GeoNames data. All location criteria within an object must be met (internal AND). Multiple objects ar…
IncludeTranslationFields_2
boolean
If true, includes English translation fields in the response (titletranslateden, contenttranslateden, and NLP translation fields).
ClusterAdvancedEntity
object
4 properties
4 required
Page
integer
The page number to scroll through the results. This parameter is used to paginate: scroll through results because one API response cannot return more than 1000…
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…
ClusteringEnabled
boolean
If true, groups similar articles into clusters and returns clustered results. If false, returns individual articles without clustering. To learn more, see [Clu…
ArticlesDto
array
A list of articles matching the search criteria.
UserInputDto
object
The user input parameters for the request.
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…
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…
WordCountMin
integer
The minimum number of words an article must contain. To be used for avoiding articles with small content.
ClusterEntity_2
object
The data model representing a single cluster of articles.
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…
Page_2
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…
WordCountMax_2
integer
The maximum number of words an article can contain. To be used for avoiding articles with large content.
ClusteringEnabled_2
boolean
Determines whether to group similar articles into clusters. If true, the API returns clustered results. To learn more, see [Clustering news articles](https://w…
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…
BaseSearchResponseDto
object
The base response model containing common fields for search operations.
5 properties
5 required
AdditionalDomainInfoEntity
object
Additional information about the domain of the article.
3 properties
ClusteringThreshold
number
Sets the similarity threshold for grouping articles into clusters. A lower value creates more inclusive clusters, while a higher value requires greater similar…
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…
ClusteringVariable
string
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 + con…
ClusteredArticlesDto
object
2 properties
2 required
ArticleAdvancedResultEntity
NlpDataEntity
object
Natural Language Processing data for the article.
12 properties
ClusterEntity
object
Represents a cluster of similar articles in the search results. Articles within each cluster are sorted according to the sortby parameter: - sortby: "date" (de…
4 properties
4 required
GeoNamesEntity
object
A single geographic location filter using GeoNames structured data. All provided fields within this object are combined with AND logic.
16 properties
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…
SentimentScores
object
Sentiment scores for the article's title and content.
2 properties
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…
Theme_2
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…
ClusterArticleResultEntity
Represents an article within a cluster, extending the ArticleResultEntity with cluster-specific properties.
Error
object
3 properties
3 required
GeoNamesResponseEntity
object
Represents a geographic location identified in an article using GeoNames structured data, including detection confidence and localization scores.
14 properties
2 required
BaseRequestDto
object
Common parameters shared across standard endpoints.
23 properties
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…
OrgEntityName
string
Filters articles that mention specific organization names, as identified by NLP analysis. - To specify multiple organizations, use AND, OR, NOT operators, and…
IncludeTranslationFields
boolean
If true, includes English translation fields in the response (titletranslateden, contenttranslateden, and NLP translation fields). If false, excludes translati…
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…
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…
MiscEntityName
string
Filters articles that mention other named entities not falling under person, organization, or location categories. Includes events, nationalities, products, wo…
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…
IsOpinion
boolean
If true, returns only opinion pieces. If false, excludes opinion-based articles and returns news only.
RangeModel
object
Numeric range filter with minimum and/or maximum values (inclusive).
2 properties
LatestHeadlinesRequestDto
BaseAdvancedRequestDto
object
23 properties
WordCountMax
integer
The maximum number of words an article can contain. To be used for avoiding articles with large content.
ClusterArticleAdvancedResultEntity
Theme
Filters articles based on their general topic, as determined by NLP analysis. To select multiple themes, use a comma-separated string or an array of strings. T…
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.
IsHeadline
boolean
If true, only returns articles that were posted on the home page of a given news domain.
PageSize
integer
The number of articles to return per page. Range: 1 to 1000.
ArticleSearchResponseDto
The response model for the Search, Latest headlines, and Search by requests, including search results and metadata. Response field behavior: - Required fields…
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…
Coordinates
object
Geographic coordinates for a location.
2 properties
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:…
AllLinksDataItem
object
Detailed information about a link found in an article.
3 properties
3 required
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…
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…
NotSources
The news sources to exclude from the search. To exclude multiple sources, use a comma-separated string or an array of strings.
SearchResponseDto_2
The response model for the search requests applies to the Search, Latest Headlines, Search by link, and Authors endpoints. Response field behavior: - Required…
When
string
The time period for which you want to get the latest headlines. Format examples: - 7d: Last seven days - 30d: Last 30 days - 1h: Last hour - 24h: Last 24 hours
SentimentScores_2
object
Sentiment scores for the article's title and content.
2 properties
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Newscatcher publishes across the network.