Search articles

POST

api

object

string

from_

Option 1 · string

to_

Option 1 · string

search_in

string

sort_by

enum<string>

associated_towns

array

search_in_ai_associated_town

boolean

lang

string

sources

string

not_sources

string

parent_url

string

is_paid_content

boolean

page

integer

page_size

integer

word_count_min

integer

word_count_max

integer

clustering

boolean

theme

string

PER_entity_name

string

LOC_entity_name

string

MISC_entity_name

string

ORG_entity_name

string

title_sentiment_min

number

title_sentiment_max

number

content_sentiment_min

number

content_sentiment_max

number

Authorizations

x-api-token

string

headerrequired

API Key to authenticate requests.

To access the API, include your API key in the x-api-token header. To obtain your API key, complete the form or contact us directly.

Body

application/json

associated_towns

object[]

required

An array of town entities related to the articles. Each town entity contains information about a specific town and the association methods to be used for searching.

To learn more, see Town association methods.

string

default: *

The keyword(s) to search for in articles. Query syntax supports logical operators (AND, OR, NOT) and wildcards:

For an exact match, use double quotes. For example, "technology news".
Use * to search for any keyword.
Use + to include and - to exclude specific words or phrases. For example, +Apple, -Google.
Use AND, OR, and NOT to refine search results. For example, technology AND (Apple OR Microsoft) NOT Google.

For more details, see Advanced querying.

from_

default: 7 days ago

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 examples:

YYYY-mm-ddTHH:MM:SS: 2024-09-24T00:00:00
YYYY-MM-dd: 2024-09-24
YYYY/mm/dd HH:MM:SS: 2024/09/24 00:00:00
YYYY/mm/dd: 2024/09/24
English phrases: 1 day ago, today

Note: By default, applied to the publication date of the article. To use the article's parse date instead, set the by_parse_date parameter to true.

to_

default: now

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 examples:

YYYY-mm-ddTHH:MM:SS: 2024-09-25T00:00:00
YYYY-MM-dd: 2024-09-25
YYYY/mm/dd HH:MM:SS: 2024/09/25 00:00:00
YYYY/mm/dd: 2024/09/25
English phrases: 1 day ago, today, now

Note: By default, applied to the publication date of the article. To use the article's parse date instead, set the by_parse_date parameter to true.

search_in

string

default: title,content

The article fields to search in. To search in multiple fields, use a comma-separated string.

Example: "title, summary"

Available options: title, summary, content.

sort_by

enum<string>

default: relevancy

The sorting order of the results. Possible values are:

relevancy: The most relevant results first.
date: The most recently published results first.
rank: The results from the highest-ranked sources first.

Available options:

relevancy,

date,

rank

search_in_ai_associated_town

boolean

default: false

Determines whether to include AI-extracted town names in the search. If true, the API searches for articles mentioning AI-extracted towns and towns specified in the associated_towns parameter.

Note: The search_in_ai_associated_town parameter is only available for the v3_local_news_ai_extraction_nlp plan. Data for AI-associated towns is only available from September 24, 2024, onwards.

lang

The language(s) of the search. The only accepted format is the two-letter ISO 639-1 code. To select multiple languages, use a comma-separated string or an array of strings.

Examples:

"en,es"
["en", "es"]

To learn more, see Enumerated parameters > Language.

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 multiple sources, use a comma-separated string or an array of strings.

Examples:

"nytimes.com, theguardian.com"
["nytimes.com", "theguardian.com"]

not_sources

The news sources to exclude from the search. To exclude multiple sources, use a comma-separated string or an array of strings.

Examples:

"cnn.com, wsj.com"
["cnn.com", "wsj.com"]

parent_url

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.

Examples:

"wsj.com/politics,wsj.com/tech"
["wsj.com/politics", "wsj.com/tech"]

is_paid_content

boolean

If false, returns only articles that have publicly available complete content. Some publishers partially block content, so this setting ensures that only full articles are retrieved.

page

integer

default: 1

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 articles.

Required range: x > 1

page_size

integer

default: 100

The number of articles to return per page. Range: 1 to 1000.

Required range: 1 < x < 1000

word_count_min

integer

The minimum number of words an article must contain. To be used for avoiding articles with small content.

Required range: x > 0

word_count_max

integer

The maximum number of words an article can contain. To be used for avoiding articles with large content.

Required range: x > 0

clustering

boolean

default: false

Determines whether to group similar articles into clusters. If true, the API returns clustered results.

To learn more, see Clustering news articles.

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.

Examples:

"Finance, Tech"
["Finance", "Tech"]

To learn more, see NLP features.

Available options: Business, Economics, Entertainment, Finance, Health, Politics, Science, Sports, Tech, Crime, Financial Crime, Lifestyle, Automotive, Travel, Weather, General.

PER_entity_name

Filters articles that mention specific person names, as identified by NLP analysis. To specify multiple names, use a comma-separated string or an array of strings.

Examples:

"Elon Musk, Jeff Bezos"
["Elon Musk", "Jeff Bezos"]

To learn more, see Search by entity.

LOC_entity_name

Filters articles that mention specific location names, as identified by NLP analysis. To specify multiple locations, use a comma-separated string or an array of strings.

Examples:

"California, New York"
["California", "New York"]

To learn more, see Search by entity.

MISC_entity_name

Filters articles that mention other named entities not falling under person, organization, or location categories. Includes events, nationalities, products, works of art, and more. To specify multiple entities, use a comma-separated string or an array of strings.

Examples:

"Bitcoin, Blockchain"
["Bitcoin", "Blockchain"]

To learn more, see Search by entity.

ORG_entity_name

Filters articles that mention specific organization names, as identified by NLP analysis. To specify multiple organizations, use a comma-separated string or an array of strings.

Examples:

"Apple, Microsoft"
["Apple", "Microsoft"]

To learn more, see Search by entity.

title_sentiment_min

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 values indicate positive sentiment.
Values close to 0 indicate neutral sentiment.

To learn more, see NLP features.

Required range: -1 < x < 1

title_sentiment_max

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 values indicate positive sentiment.
Values close to 0 indicate neutral sentiment.

To learn more, see NLP features.

Required range: -1 < x < 1

content_sentiment_min

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 values indicate positive sentiment.
Values close to 0 indicate neutral sentiment.

To learn more, see NLP features.

Required range: -1 < x < 1

content_sentiment_max

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 values indicate positive sentiment.
Values close to 0 indicate neutral sentiment.

To learn more, see NLP features.

Required range: -1 < x < 1

Response

200 - application/json

The response model for the Search, Latest headlines, and Search by requests, including search results and metadata.

Response field behavior:

Required fields are guaranteed to be present and non-null.
Optional fields may be null/undefined if the data couldn't be extracted during processing.
To access article properties in the articles response array, use array index notation. For example, articles[n].title, where n is the zero-based index of the article object (0, 1, 2, etc.).

status

string

default: okrequired

The status of the response.

total_hits

integer

required

The total number of articles matching the search criteria.

page

integer

required

The current page number of the results.

total_pages

integer

required

The total number of pages available for the given search criteria.

page_size

integer

required

The number of articles per page.

articles

object[]

A list of articles matching the search criteria.

articles.id

string

required

The unique identifier for the article.

articles.associated_town

object[]

A list of towns associated with the article.

articles.ai_associated_town

object[] | null

A list of towns associated with the article, as identified by AI analysis. Can be null.

articles.score

number

The relevance score of the article.

articles.title

string

required

The title of the article.

articles.author

string

The primary author of the article.

articles.link

string

required

The URL link to the article.

articles.description

string

A brief description of the article.

articles.media

string

The URL of the media associated with the article, typically an image.

articles.content

string

required

A snippet or summary of the article's content.

articles.authors

string[]

A list of authors of the article.

articles.published_date

string

required

The date and time the article was published.

articles.published_date_precision

string

required

The precision of the published date.

articles.updated_date

string

The date and time the article was last updated.

articles.updated_date_precision

string

The precision of the updated date.

articles.is_opinion

boolean

required

Indicates if the article is an opinion piece.

articles.twitter_account

string | null

The Twitter account associated with the article. Can be null.

articles.domain_url

string

required

The domain URL of the article's source.

articles.parent_url

string

The parent URL of the article, typically representing the homepage of the source.

articles.word_count

integer

The word count of the article.

articles.rank

integer

required

The rank of the article's source.

articles.country

string

The country code where the article was published.

articles.rights

string

The rights information for the article, typically the domain name.

articles.language

string

The language code in which the article is written.

articles.nlp

object

Natural Language Processing data for the article.

articles.paid_content

boolean

Indicates if the article is paid content.

user_input

object

The user input parameters for the search.

Was this page helpful?

Subscription plans Retrieve latest headlines

Overview

Endpoints

Authorizations

Body

Response