The identity and technical contract details declared by the specification.
OrgEntityName
string
Filters articles that mention specific organization names, as identified by NLP analysis. - To specify multiple organizations, use AND, OR, NOT operators, and…
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.
ArticleAdvancedResultEntity
BaseRequestDto
object
Common parameters shared across standard endpoints.
23 properties
SearchResponseDto
object
5 properties
5 required
LatestHeadlinesRequestDto
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…
MiscEntityName
string
Filters articles that mention other named entities not falling under person, organization, or location categories. Includes events, nationalities, products, wo…
Coordinates
object
Geographic coordinates for a location.
2 properties
ClusteringSearchResponseDto
The response model when clustering is enabled, grouping similar articles into clusters. Applies to the Search and Latest headlines requests. Response field beh…
ClusterAdvancedEntity
object
4 properties
4 required
Error
object
3 properties
3 required
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.
BaseAdvancedRequestDto
object
23 properties
IncludeTranslationFields
boolean
If true, includes English translation fields in the response (titletranslateden, contenttranslateden, and NLP translation fields). If false, excludes translati…
GeoNamesEntity
object
A single geographic location filter using GeoNames structured data. All provided fields within this object are combined with AND logic.
16 properties
NamedEntityList
array
A list of named entities identified in the article.
SentimentScores
object
Sentiment scores for the article's title and content.
2 properties
RangeModel
object
Numeric range filter with minimum and/or maximum values (inclusive).
2 properties
ArticleSearchResponseDto
The response model for the Search, Latest headlines, and Search by requests, including search results and metadata. Response field behavior: - Required fields…
GeoNamesResponseEntity
object
Represents a geographic location identified in an article using GeoNames structured data, including detection confidence and localization scores.
14 properties
2 required
GeoNamesLocationAdminEntity
object
3 properties
ClusterArticleAdvancedResultEntity
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…
LatestHeadlinesAdvancedRequestDto
PageSize
integer
The number of articles to return per page. Range: 1 to 1000.
ClusteringSearchAdvancedResponseDto
The response model when clustering is enabled, grouping similar articles into clusters. Applies to the Search advanced and Latest headlines advanced requests.…
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…
LocationEntity
object
2 properties
2 required
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…
ClusterArticleResultEntity
Represents an article within a cluster, extending the ArticleResultEntity with cluster-specific properties.
DetectionMethods
array
The location detection methods to filter results by: - dedicatedsource: Identifies locations based on sources exclusively covering a specific location. - local…
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…
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
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…
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…
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…
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
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…
WordCountMax
integer
The maximum number of words an article can contain. To be used for avoiding articles with large content.
NotSources
The news sources to exclude from the search. To exclude multiple sources, use a comma-separated string or an array of strings.
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.
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…
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
ArticleSearchAdvancedResponseDto
The response model for the Search advanced, Latest headlines advanced, and Search by requests. Response field behavior: - Required fields are guaranteed to be…
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…
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…
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…
NlpDataEntity
object
Natural Language Processing data for the article.
12 properties
BaseSearchResponseDto
object
The base response model containing common fields for search operations.
5 properties
5 required
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…
IncludeTranslationFields_2
boolean
If true, includes English translation fields in the response (titletranslateden, contenttranslateden, and NLP translation fields).
SentimentScores_2
object
Sentiment scores for the article's title and content.
2 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…
ArticlesDto
array
A list of articles matching the search criteria.
WordCountMax_2
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_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…
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_2
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:…
AllLinksDataItem
object
Detailed information about a link found in an article.
3 properties
3 required
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…
PageSize_2
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…
Lang_2
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…
ClusterEntity_2
object
The data model representing a single cluster of articles.
3 properties
3 required
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…
AdditionalDomainInfoEntity
object
Additional information about the domain of the article.
3 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…
ClusteredArticlesDto
object
2 properties
2 required
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.
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:…
NotSources_2
The news sources to exclude from the search. To exclude multiple sources, use a comma-separated string or an array of strings.
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…
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…
NlpDataEntity_2
object
Natural Language Processing data for the article.
17 properties
NotIabTags
Inverse of the iabtags parameter. Excludes articles based on Interactive Advertising Bureau (IAB) content categories. These tags provide a standardized taxonom…
NotIptcTags
Inverse of the iptctags parameter. Excludes articles based on International Press Telecommunications Council (IPTC) media topic tags. To specify multiple IPTC…
ParentUrl_2
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.
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…
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…
ArticleEntity
object
The data model representing a single article in the search results.
37 properties
8 required
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…
IabTags
Filters articles based on Interactive Advertising Bureau (IAB) content categories.These tags provide a standardized taxonomy for digital advertising content ca…
Sources_2
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…
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…
IsOpinion
boolean
If true, returns only opinion pieces. If false, excludes opinion-based articles and returns news only.
CustomTags
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 followin…
ClusteredSearchResponseDto
The response model when clustering is enabled, grouping similar articles into clusters. Applies to the Search and Latest headlines requests. Response field beh…
IptcTags
Filters articles based on International Press Telecommunications Council (IPTC) media topic tags. To specify multiple IPTC tags, use a comma-separated string o…
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.