Find news articles that match one or more search conditions.

The search conditions can be specifying by setting one or multiple search parameters, such as keyword, conceptUri, sourceUri, categoryUri, dateStart, etc. If you need to specify a complex query with nested conditions that use a combination of Boolean AND, OR and NOT operators, then best approach is to specify the query parameter.

To remove some of the results matching the positive conditions, you can specify some negative conditions using ignoreKeyword, ignoreSourceUri, and other ignore* parameters.

The results of the search can be the list of matching articles (default) or one of the various aggregates (summaries) of the matching articles. These aggregates can include information like when the articles were published, which are the top sources publishing resulting articles, the sentiment distribution, category distribution, etc.

Each search can return up to 100 articles per call. If the query matches more than 100 articles, you can retrieve them by using articlesPage parameter and setting it to value 2, 3, 4, etc to retrieve additional pages of results. Each call will count as one search action (regardless of the number of returned articles).

Endpointhttps://eventregistry.org/api/v1/article/getArticles
HeadersContent-Type: application/json

Find articles (news articles and PR content) that mention the phrase 'Tesla Inc' and return 100 latest articles with full article body. Return only articles from sources from USA, Canada and UK. Exclude the paywalled sources. Limit the search to the last month only (using forceMaxDataTimeWindow parameter).

Repeat the query multiple times and increase the articlesPage parameter, to retrieve more results.

Request body

Parameters 
apiKey  string (required)

Your API key

resultType  string

Define what kind of results of the search you would like to get.

Available values:  articles, uriWgtList, langAggr, timeAggr, sourceAggr, sourceExAggr, authorAggr, keywordAggr, locAggr, conceptAggr, conceptGraph, categoryAggr, dateMentionAggr, sentimentAggr, recentActivityArticles
Default value:  articles
articlesPage  integer

Determines the page of the results to return (starting from 1). Relevant when resultType = articles.

Default value:  1
articlesCount  integer

Define how many articles (up to 100) will be returned. Relevant when resultType = articles.

Default value:  100
articlesSortBy  string

Choose the criteria for sorting the news articles. rel (relevance to the query), date (publishing date), sourceImportance (manually curated score of source importance - high value, high importance), sourceImportanceRank (reverse of sourceImportance), sourceAlexaGlobalRank (global rank of the news source), sourceAlexaCountryRank (country rank of the news source). Relevant when resultType = articles.

Available values:  date, rel, sourceImportance, sourceAlexaGlobalRank, sourceAlexaCountryRank
Default value:  date
articlesSortByAsc  boolean

Should the results be ordered in ascending order or descending order (default). Relevant when resultType = articles.

Default value:  false
articleBodyLen  integer

Set the size of the article body that'll be returned in the response. Use -1 for full article body.

Default value:  -1
dataType  string | string[]

What data types should we search? news content (default, news), press releases (pr) or blogs (blog).

Available values:  news, pr, blog
Default value:  news
forceMaxDataTimeWindow  integer

If you want to make sure that you are making queries just on the last month of data (to ensure smallest use of tokens) and you don't want to specify the dateStart and dateEnd parameters, then you can specify the forceMaxDataTimeWindow parameter and set it to 31 or 7 (the only two valid values). It determines the maximum age of the returned content. Don't specify the parameter if you want to search also the data that is older than 7 or 31 days.

Available values:  7, 31
Filters 

Click to see different parameters that you can specify in order to filter the articles

query  object

Query object with one or more search conditions. The query object should match the Advanced Query Language format. If you specify the query parameter, then other query parameters like keyword, conceptUri, sourceUri, etc. should not be specified.

keyword  string | string[]

Find articles that mention the specified keyword or a phrase. You can specify at most 60 keywords in a single search. If you specify multiple keyword parameters, then only articles that mention all of them will be returned, unless you specify keywordOper parameter and set it to or. Use the keywordSearchMode parameter to control how the keyword is matched; see the keyword search modes section.

Example value:  Barack Obama
conceptUri  string | string[]

Find articles that mention the concept with a concept uri. You can specify at most 50 concepts in a single search. If multiple conceptUri parameters are provided, then only articles that are about all specified concepts will be returned, unless you specify conceptOper parameter and set it to or. Check autosuggest methods to get concept URI value for a specified concept label.

Example value:  http://en.wikipedia.org/wiki/World_Health_Organization
categoryUri  string | string[]

Find articles that are assigned to a particular category. You can specify at most 20 categories in a single search. If multiple categoryUri parameters are provided, then articles that are about any of the specified categories will be returned, unless you specify categoryOper parameter and set it to and. Check autosuggest methods to get value for a specified category name.

Example value:  dmoz/Business/Accounting
sourceUri  string | string[]

Find articles that have been published by a news source. If you specify multiple sourceUri parameters, then articles from any of the specified sources will be returned. Check autosuggest methods to get value for a source name.

Example value:  bbc.co.uk
sourceLocationUri  string | string[]

Find articles that were published by news sources located at the given geographic location (city or country). If you specify multiple sourceLocationUri parameters, then articles from sources from any of the specified sources will be returned. Check autosuggest methods to get value for a location name.

Example value:  http://en.wikipedia.org/wiki/Germany
sourceGroupUri  string | string[]

Find articles that were published by news sources that are assigned to some predefined group of news sources.

Example value:  general/ERtop10
authorUri  string | string[]

Find articles that were written by a particular author. Check autosuggest methods to get value for author uri based on the author name (and potentially source url).

Example value:  mark_mazzetti@nytimes.com
locationUri  string | string[]

Find articles that describe something that occured at a particular location (based on the location mentioned in the dateline). Check autosuggest methods to get value for a location name. NOTE: If a location will not be specified in the dateline (immediate start of the article), the article will not be returned. Consider also using conceptUri to find articles that mention a particular location.

Example value:  http://en.wikipedia.org/wiki/United_States
lang  string | string[]

Find articles in the specified language(s). If parameter is not set, articles in all languages will be included. You can specify at most 5 languages in a single search. Specify languages using their ISO3 language codes. The full list of languages and their ISO3 codes can be found on this page.

Example value:  eng
dateStart  string

The starting date on or after the articles of interest were published. The date should be in the YYYY-MM-DD format.

Example value:  2018-01-03
dateEnd  string

The last date on which the articles of interest were published. The date should be in the YYYY-MM-DD format.

Example value:  2018-01-10
dateMentionStart  string

Find articles that explicitly mention a date that is equal or greater than dateMentionStart. The date should be in the YYYY-MM-DD format.

Example value:  2018-01-10
dateMentionEnd  string

Find articles that explicitly mention a date that is lower or equal to dateMentionEnd. The date should be in the YYYY-MM-DD format.

Example value:  2018-01-10
keywordLoc  string

What data should be used when searching using the keywords provided by keywords parameter.

Available values:  body, title, title,body
Default value:  body
keywordOper  string

If more keywords are provided with the keyword parameter, what should be the Boolean operator used. If and (default) then all of the specified keywords have to be present in the article; if or then an article will be returned if it mentions any of the provided keywords.

Available values:  and, or
Default value:  and
keywordSearchMode  string

Determines how the keywords provided with the keyword parameter are matched against the content. Use phrase (default) to match the keyword as an exact phrase, exact to use the Boolean query language (with AND, OR, NOT, NEAR and NEXT operators), or simple for a relevance-based search that does not require all terms to be present. See the keyword search modes section for details and examples.

Available values:  phrase, exact, simple
Default value:  phrase
conceptOper  string

If more concepts are provided with the conceptUri parameter, what should be the Boolean operator used. If and (default) then all of the specified concepts have to be present in the article; if or then an article will be returned if it mentions any of the provided concepts.

Available values:  and, or
Default value:  and
categoryOper  string

If more categories are provided with the categoryUri parameter, what should be the Boolean operator used. If and then all of the specified categories have to be present in the article; if or then an article will be returned if it mentions any of the provided categories.

Available values:  and, or
Default value:  or
ignoreKeyword  string | string[]

Ignore articles that mention the specified keyword or phrase. You can specify at most 60 keywords in a single search. If you specify multiple ignoreKeyword parameters, then articles that mention any of these keywords will be ignored.

Example value:  Donald Trump
ignoreConceptUri  string | string[]

Ignore articles that mention the concept with concept uri. You can specify at most 50 concepts in a single search. If you specify multiple ignoreConceptUri parameters then articles that mention any of them will be ignored. Check autosuggest methods to get value for a specified concept label.

Example value:  http://en.wikipedia.org/wiki/World_Health_Organization
ignoreCategoryUri  string | string[]

Ignore articles that are assigned into a particular category. You can specify at most 20 categories in a single search. If you specify multiple ignoreCategoryUri parameters then articles that mention any of them will be ignored. Check autosuggest methods to get value for a specified category name.

Example value:  dmoz/Business/Accounting
ignoreSourceUri  string | string[]

Ignore articles that have been published by a news source. If you specify multiple ignoreSourceUri parameters, then articles from any of the specified sources will be ignored. Check autosuggest methods to get value for a source name.

Example value:  bbc.co.uk
ignoreSourceLocationUri  string | string[]

Ignore articles that were published by news sources located at the given geographic location (city or country). If you specify multiple ignoreSourceLocationUri parameters, then articles from sources from any of the specified sources will be ignored. Check autosuggest methods to get value for a location name.

Example value:  http://en.wikipedia.org/wiki/Olsberg,_Germany
ignoreSourceGroupUri  string | string[]

Ignore articles that were published by news sources that are assigned to some predefined group of news sources.

Example value:  general/ERtop10
ignoreLocationUri  string | string[]

Ignore articles that describe something that occured at a particular location (based on the location mentioned in the dateline). Check autosuggest methods to get value for a location name.

Example value:  http://en.wikipedia.org/wiki/United_States
ignoreAuthorUri  string | string[]

Ignore articles that were written by a particular author. Check autosuggest methods to get value for author uri based on the author name (and potentially source url).

Example value:  mark_mazzetti@nytimes.com
ignoreLang  string | string[]

Ignore articles in the specified language(s). You can specify at most 5 languages in a single search. Specify languages using their ISO3 language codes. The full list of languages and their ISO3 codes can be found on this page.

Example value:  deu
ignoreKeywordLoc  string

What data should be used when searching using the keywords provided by ignoreKeywords parameter.

Available values:  body, title, title,body
Default value:  body
startSourceRankPercentile  integer

Starting ranking percentile of the sources to consider in the results (default: 0). Value should be in range 0-90 and divisible by 10.

Default value:  0
endSourceRankPercentile  integer

Ending ranking percentile of the sources to consider in the results (default: 100). Value should be in range 10-100 and divisible by 10.

Default value:  100
minSentiment  integer

The minimum value of the sentiment, the article should have. Valid value is any floating number between -1 (very negative) to 1 (very positive). 0 represents neutral sentiment. Note that setting the value will automatically reduce results to just English articles, since the sentiment can only be computed for English language.

maxSentiment  integer

The maximum value of the sentiment, the article should have. Valid value is any floating number between -1 (very negative) to 1 (very positive). 0 represents neutral sentiment. Note that setting the value will automatically reduce results to just English articles, since the sentiment can only be computed for English language.

isDuplicateFilter  string

Some articles can be duplicates of other articles. What should be done with them.

Available values:  skipDuplicates, keepOnlyDuplicates, keepAll
Default value:  keepAll
eventFilter  string

Some articles describe a known event and some don't. This filter allows you to filter the resulting articles based on this criteria.

Available values:  skipArticlesWithoutEvent, keepOnlyArticlesWithoutEvent, keepAll
Default value:  keepAll
Returned Details 

The API call can return more or less meta-data information about the articles, concepts, categories, sources and locations. Click to see the available properties that can be specified to determine the amount of returned information.

includeArticleTitle  boolean

Set this parameter to true to include the article title in the response.

Default value:  true
includeArticleBasicInfo  boolean

Set this parameter to true to include the core article information in the response.

Default value:  true
includeArticleBody  boolean

Set this parameter to true to include the article body in the response.

Default value:  true
includeArticleEventUri  boolean

Set this parameter to true to include the uri of the event (to which the article belongs) in the response.

Default value:  true
includeArticleSocialScore  boolean

Set this parameter to true to include the information about how many times the article was shared on different social media.

Default value:  false
includeArticleSentiment  boolean

Set this parameter to true to include the article sentiment in the response (value will be non-null only for English articles).

Default value:  true
includeArticleConcepts  boolean

Set this parameter to true to include the article concepts in the response.

Default value:  false
includeArticleCategories  boolean

Set this parameter to true to include the article categories in the response.

Default value:  false
includeArticleLocation  boolean

Set this parameter to true to include the article location in the response.

Default value:  false
includeArticleImage  boolean

Set this parameter to true to include the article image in the response.

Default value:  true
includeArticleAuthors  boolean

Set this parameter to true to include the article authors in the response.

Default value:  true
includeArticleVideos  boolean

Set this parameter to true to include the article videos in the response.

Default value:  false
includeArticleLinks  boolean

Set this parameter to true to include the article links in the response.

Default value:  false
includeArticleExtractedDates  boolean

Set this parameter to true to include article extracted dates in the response.

Default value:  false
includeArticleDuplicateList  boolean

Set this parameter to true to include the list of duplicate articles in the response.

Default value:  false
includeArticleOriginalArticle  boolean

Set this parameter to true to include the original article in the response.

Default value:  false
includeSourceTitle  boolean

Set this parameter to true to include the source title in the response.

Default value:  true
includeSourceDescription  boolean

Set this parameter to true to include the source description in the response.

Default value:  false
includeSourceLocation  boolean

Set this parameter to true to include the source location in the response.

Default value:  false
includeSourceRanking  boolean

Set this parameter to true to include the source ranking in the response.

Default value:  false
includeConceptLabel  boolean

Set this parameter to true to include the concept label in the response.

Default value:  true
includeConceptImage  boolean

Set this parameter to true to include the concept image in the response.

Default value:  false
includeConceptSynonyms  boolean

Set this parameter to true to include the concept synonyms in the response.

Default value:  false
conceptLang  string

Define the language of the concept label.

Default value:  eng
includeCategoryParentUri  boolean

Set this parameter to true to include category parent uri in the response.

Default value:  false
includeLocationGeoLocation  boolean

Set to true to include the geo location (latitude, longitude) for items that are locations.

Default value:  false
includeLocationPopulation  boolean

Set to true to include the population size of the location.

Default value:  false
includeLocationGeoNamesId  boolean

Set to true to include the GeoNames id of the location.

Default value:  false
includeLocationCountryArea  boolean

Set to true to include the are of the location in squared km.

Default value:  false
includeLocationCountryContinent  boolean

Set to true to get the continent of the country for location objects.

Default value:  false