Parameters by endpoint

Lucene query

INFO

The News API supports the Lucene query syntax for searching articles. You can use the q parameter to specify the Lucene query. The Lucene query syntax allows you to search articles based on the keywords, phrases, and operators you specify in the query. For example, you can search for articles that contain the keyword Bitcoin in the title or content.

Endpoints

/v1/news/everything

/v1/news/top-headlines

/v1/news/story

/v1/news/category

/v1/news/topic

/v1/news/industry

/v1/news/entity

Parameters

Parameter	Description	Type	Required	Example
`q`	The Lucene query to search for articles.	string	No	`Bitcoin`

Lucene query syntax

You can use the following Lucene query syntax to search for articles:

Syntax	Description
`keyword`	The keyword to search for.
`AND`	The logical AND operator.
`OR`	The logical OR operator.
`NOT`	The logical NOT operator.
`+`	The required operator.
`-`	The prohibited operator.
`()`	The grouping operator.
`""`	The phrase operator.
`*`	The wildcard operator.
`?`	The single-character wildcard operator.
`~`	The fuzzy operator.
`^`	The boost operator.
`field:value`	The field operator.
`field:(value)`	The field grouping operator.
`field:[value TO value]`	The range operator.

Workflow examples

Request to search for articles containing the keyword "Bitcoin":

shell

curl -X GET "https://api.apitube.io/v1/news/everything?q=Bitcoin&api_key=YOUR_API_KEY"

Request to search for articles containing the keyword "Bitcoin" and "Ethereum":

shell

curl -X GET "https://api.apitube.io/v1/news/everything?q=Bitcoin AND Ethereum&api_key=YOUR_API_KEY"

Request to search for articles containing the keyword "Bitcoin" or "Ethereum":

shell

curl -X GET "https://api.apitube.io/v1/news/everything?q=Bitcoin OR Ethereum&api_key=YOUR_API_KEY"

Datetime

With the News API, you can specify the date range of the articles you want to retrieve. You can use the published_at.start and published_at.end parameters to specify the date range. The date range is inclusive, meaning that the articles published on the from date and the to date are included in the result.

All datetime math functions using AQL format.

Endpoints

/v1/news/everything

/v1/news/top-headlines

/v1/news/story

/v1/news/category

/v1/news/topic

/v1/news/industry

/v1/news/entity

Parameters

Parameter	Description	Type	Required	Example
`published_at.start`	The start date of the date range.	string	No	`2022-01-01`
`published_at.end`	The end date of the date range.	string	No	`2022-01-31`
`published_at`	The date of the articles you want to retrieve.	string	No	`2022-01-01`

Date Math Keywords

You can use the following date math keywords to specify the date range:

Keyword	Description
`NOW`	The current date and time.
`YEAR`	The current year.
`MONTH`	The current month.
`DAY`	The current day.
`HOUR`	The current hour.
`MINUTE`	The current minute.
`SECOND`	The current second.

Date Formats

You can use the following date formats to specify the date range:

Example	Description
`2006-01-02T15:04:05Z`	The date and time in the `YYYY-MM-DDTHH:MM:SSZ` format.
`2006-01-02`	The date in the `YYYY-MM-DD` format.
`02-01-2006`	The date in the `DD-MM-YYYY` format.
`2006-01-02T15:04:05-07:00`	The date and time in the `YYYY-MM-DDTHH:MM:SSZ` format.
`2006-01-02T15:04:05.000Z`	The date and time in the `YYYY-MM-DDTHH:MM:SS.MMMZ` format.
`Mon, 02 Jan 2006 15:04:05 MST`	The date and time in the `D, DD MMM YYYY HH:MM:SS Z` format.
`2006-01-02T15:04:05-07:00`	The date and time in the `YYYY-MM-DDTHH:MM:SSZ` format.
`2006-01-02T15:04:05Z07:00`	The date and time in the `YYYY-MM-DDTHH:MM:SSZ07:00` format. RFC3339 without the `T` separator.
`Mon, 02 Jan 2006 15:04:05 -0700`	The date and time in the `D, DD MMM YYYY HH:MM:SS Z` format. For example, `Mon, 02 Jan 2006 15:04:05 -0700`.

Date Math

You can use the date math syntax to specify the date range. The date math syntax allows you to specify the date range relative to the current date and time. For example, you can specify the date range as NOW-1D to retrieve the articles published in the last 24 hours.

Date Math Syntax

You can use the following date math syntax to specify the date range:

Syntax	Description
`NOW`	The current date and time.
`NOW-1H`	The current date and time minus one hour.
`NOW-1D`	The current date and time minus one day.
`NOW-1M`	The current date and time minus one month.
`NOW-1Y`	The current date and time minus one year.
`NOW+1H`	The current date and time plus one hour.
`YEAR`	The current year.
`MONTH`	The current month.
`DAY`	The current day.
`HOUR`	The current hour.
`MINUTE`	The current minute.
`SECOND`	The current second.

Examples

Parameter	Description
`NOW-2MONTHS`	The current date and time minus two months.
`NOW-1MONTH`	The current date and time minus one month.
`NOW-1WEEK`	The current date and time minus one week.
`NOW-1DAY/HOUR`	The current date and time minus one day and one hour.
`NOW-1DAY`	The current date and time minus one day.
`NOW-1DAY/DAY`	Yesterday.

Workflow examples

Request to get news articles within a specific date range:

shell

curl -X GET "https://api.apitube.io/v1/news/everything?published_at.start=2022-01-01&published_at.end=2022-01-31&api_key=YOUR_API_KEY"

Request to get news using a relative time range:

shell

curl -X GET "https://api.apitube.io/v1/news/everything?published_at.start=NOW-1D&published_at.end=NOW&api_key=YOUR_API_KEY"

Languages

APITube has 60+ more languages available for the News API. You can specify the language of the articles you want to retrieve.

List of supported languages

Endpoints

/v1/news/everything

/v1/news/top-headlines

/v1/news/story

/v1/news/category

/v1/news/topic

/v1/news/industry

/v1/news/entity

Parameters

Parameter	Description	Type	Required	Example
`language`	The language of the articles you want to retrieve.	string	No	`en`
`ignore.language`	The language of the articles you want to exclude.	string	No	`fr`
`language.id`	The language ID of the articles you want to retrieve.	string	No	`314`
`ignore.language.id`	The language ID of the articles you want to exclude.	string	No	`315`
`language.code`	The language code of the articles you want to retrieve.	string	No	`en`
`ignore.language.code`	The language code of the articles you want to exclude.	string	No	`fr`
`language.name`	The language name of the articles you want to retrieve.	string	No	`English`
`ignore.language.name`	The language name of the articles you want to exclude.	string	No	`French`

Workflow examples

Request to get news articles excluding those from France and in the French language:

shell

curl -X GET "https://api.apitube.io/v1/news/everything?ignore.country.code=fr&ignore.language.code=fr&api_key=YOUR_API_KEY"

Request to get news articles in the English and French languages:

shell

curl -X GET "https://api.apitube.io/v1/news/everything?language.code=en,fr&api_key=YOUR_API_KEY"

Countries

APITube has 177 more countries available for the News API. You can specify the country of the articles you want to retrieve.

List of supported countries

Endpoints

/v1/news/everything

/v1/news/top-headlines

/v1/news/story

/v1/news/category

/v1/news/topic

/v1/news/industry

/v1/news/entity

Parameters

Parameter	Description	Type	Required	Example
`source.country.id`	The country ID of the articles you want to retrieve.	string	No	`314`
`ignore.country.id`	The country ID of the articles you want to exclude.	string	No	`315`
`source.country.code`	The country code of the articles you want to retrieve.	string	No	`us`
`ignore.country.code`	The country code of the articles you want to exclude.	string	No	`fr`
`source.country.name`	The country name of the articles you want to retrieve.	string	No	`Denmark`
`ignore.country.name`	The country name of the articles you want to exclude.	string	No	`France`

Workflow examples

Request to get news articles from the United States:

shell

curl -X GET "https://api.apitube.io/v1/news/everything?source.country.code=us&api_key=YOUR_API_KEY"

Request to get news articles from the United States and Canada:

shell

curl -X GET "https://api.apitube.io/v1/news/everything?source.country.code=us,ca&api_key=YOUR_API_KEY"

Request to get news articles excluding those from France and in the French language:

shell

curl -X GET "https://api.apitube.io/v1/news/everything?ignore.country.code=fr&ignore.language.code=fr&api_key=YOUR_API_KEY"

Sentiment

Get articles with a specific sentiment score.

Endpoints

/v1/news/everything

/v1/news/top-headlines

/v1/news/story

/v1/news/category

/v1/news/topic

/v1/news/industry

/v1/news/entity

By sentiment score

You can use the sentiment.overall.score parameter to specify the overall sentiment score of the articles you want to retrieve.

Parameters

Parameter	Description	Type	Required	Example
`sentiment.overall.score`	The overall sentiment score of the articles.	float	No	`0.2`
`sentiment.overall.score.min`	The overall sentiment score of the articles.	float	No	`0.5`
`sentiment.overall.score.max`	The overall sentiment score of the articles.	float	No	`1.0`
`sentiment.overall.polarity`	The overall sentiment polarity of the articles.	string	No	`positive`

By sentiment polarity

Parameters

Parameter	Description	Type	Required
`positive`	Retrieve articles with positive sentiment.	string	No
`negative`	Retrieve articles with negative sentiment.	string	No
`neutral`	Retrieve articles with neutral sentiment.	string	No

Workflow examples

Request for Positive Sentiment News:

This request retrieves news articles that have been classified with a positive sentiment.

shell

curl -X GET "https://api.apitube.io/v1/news/everything?sentiment.overall.polarity=positive&api_key=YOUR_API_KEY"

Request for Positive Sentiment News from a Specific Country:

This request fetches news articles with positive sentiment specifically from Japan

shell

curl -X GET "https://api.apitube.io/v1/news/everything?sentiment.overall.polarity=positive&source.country.code=jp&api_key=YOUR_API_KEY"

Request for Positive Sentiment News in the Last 24 Hours:

This request retrieves news articles with positive sentiment published in the last 24 hours.

shell

curl -X GET "https://api.apitube.io/v1/news/everything?sentiment.overall.polarity=positive&published_at.start=NOW-1D&published_at.end=NOW&api_key=YOUR

Request for Articles with Positive Sentiment and a Specific Title:

This request retrieves news articles with positive sentiment that have "technology" in their titles.

shell

curl -X GET "https://api.apitube.io/v1/news/everything?sentiment.overall.polarity=positive&title=technology

Title

Get articles with a specific title.

Endpoints

/v1/news/everything

/v1/news/top-headlines

/v1/news/story

/v1/news/category

/v1/news/topic

/v1/news/industry

/v1/news/entity

Parameters

Parameter	Description	Type	Required	Example
`title`	The title of articles	string	No	`Bitcoin`
`ignore.title`	The title of articles to ignore.	string	No	`Ethereum`
`title_starts_with`	The title of articles that start with a specific string	string	No	`Bitcoin`
`title_ends_with`	The title of articles that end with a specific string.	string	No	`Bitcoin`
`title_pattern`	The title of articles that match a specific pattern. Example: `^[A-Za-z]+$`	string	No	`Bitcoin`

Workflow examples

Request for Positive Sentiment News:

This request retrieves news articles with "technology" in their titles.

shell

curl -X GET "https://api.apitube.io/v1/news/everything?title=technology&api_key=YOUR_API_KEY"

Request for Articles with Multiple Title Keywords:

This request retrieves news articles with either "AI" or "innovation" in their titles.

shell

curl -X GET "https://api.apitube.io/v1/news/everything?title=AI,innovation&api_key=YOUR_API_KEY"

Request for Articles with Titles Excluding Certain Words:

This request retrieves news articles that do not have "celebrity" in their titles.

shell

curl -X GET "https://api.apitube.io/v1/news/everything?ignore.title=celebrity&api_key=YOUR_API_KEY"

Parameter	Description	Type	Required	Example
`category.id`	The category ID of the articles.	string	No	`314`
`ignore.category.id`	The category ID of the articles to ignore.	string	No	`315`
`category.taxonomy`	The category taxonomy of the articles.	string	No	`iptc`
`ignore.category.taxonomy`	The category taxonomy of the articles to ignore.	string	No	`iab`

Taxonomy	Description
`iptc`	IPTC
`iab`	IAB
`apitube`	APITube

Topic

Get articles with a specific topic.

List of supported topics

Endpoints

/v1/news/everything

/v1/news/top-headlines

/v1/news/story

/v1/news/category

/v1/news/topic

/v1/news/industry

/v1/news/entity

Parameters

Parameter	Description	Type	Required	Example
`topic.id`	The topic ID of the articles.	string	No	`1`
`ignore.topic.id`	The topic ID of the articles to ignore.	string	No	`2`
`topic.taxonomy`	The topic taxonomy of the articles.	string	No	`apitube`
`ignore.topic.taxonomy`	The topic taxonomy of the articles to ignore.	string	No	`apitube`

Workflow examples

Request to get news articles from a specific topic (e.g., "crypto_news"):

This request retrieves news articles that fall under the "crypto news" topic.

shell

curl -X GET "https://api.apitube.io/v1/news/everything?topic.id=crypto_news&api_key=YOUR_API_KEY"

Entities

Get articles with a specific entity.

Endpoints

/v1/news/everything

/v1/news/top-headlines

/v1/news/story

/v1/news/category

/v1/news/topic

/v1/news/industry

/v1/news/entity

Parameters

Parameter	Description	Type	Required	Example
`entity.name`	The entity name of the articles.	string	No	`Bitcoin`
`ignore.entity.name`	The entity name of the articles to ignore.	string	No	`Ethereum`
`entity.type`	The entity type of the articles.	string	No	`cryptocurrency`
`ignore.entity.type`	The entity type of the articles to ignore.	string	No	`cryptocurrency`

Workflow examples

Request for Articles Mentioning Multiple People:

This request retrieves news articles that mention either "Barack Obama" or "Joe Biden."

shell

curl -X GET "https://api.apitube.io/v1/news/everything?entities=person:Barack Obama,person:Joe Biden&api_key=YOUR_API_KEY"

Request for Articles Mentioning a Specific Person:

This request retrieves news articles mentioning "Tim Cook" in relation to "Apple" as its CEO.

shell

curl -X GET "https://api.apitube.io/v1/news/everything?entities=person:Tim Cook,organization:Apple&api_key=YOUR_API_KEY"

Industries

Get articles with a specific industry.

List of supported industries

Endpoints

/v1/news/everything

/v1/news/top-headlines

/v1/news/story

/v1/news/category

/v1/news/topic

/v1/news/industry

/v1/news/entity

Parameters

Parameter	Description	Type	Required	Example
`industry.id`	The industry ID of the articles.	string	No	`246771`
`ignore.industry.id`	The industry ID of the articles to ignore.	string	No	`246772`

Persons

Get articles with a specific person.

Endpoints

/v1/news/everything

/v1/news/top-headlines

/v1/news/story

/v1/news/category

/v1/news/topic

/v1/news/industry

/v1/news/entity

Parameters

Parameter	Description	Type	Required	Example
`person.name`	The person name of the articles.	string	No	`Satoshi`
`ignore.person.name`	The person name of the articles to ignore.	string	No	`Vitalik`

Workflow examples

Request to get news articles about a specific person (e.g., "Satoshi"):

shell

curl -X GET "https://api.apitube.io/v1/news/everything?person.name=Satoshi&api_key=YOUR_API_KEY"

Request to get news articles about multiple people (e.g., "Satoshi" and "Vitalik"):

shell

curl -X GET "https://api.apitube.io/v1/news/everything?person.name=Satoshi,Vitalik&api_key=YOUR_API_KEY"

Locations

Get articles from a specific location.

Endpoints

/v1/news/everything

/v1/news/top-headlines

/v1/news/story

/v1/news/category

/v1/news/topic

/v1/news/industry

/v1/news/entity

Parameters

Parameter	Description	Type	Required	Example
`location.name`	The location name of the articles.	string	No	`Tokyo`
`ignore.location.name`	The location name of the articles to ignore.	string	No	`New York`

Workflow examples

Request to get news articles from a specific location (e.g., "Tokyo"):

shell

curl -X GET "https://api.apitube.io/v1/news/everything?location.name=Tokyo&api_key=YOUR_API_KEY"

Request to get news articles from multiple locations (e.g., "Tokyo" and "New York"):

shell

curl -X GET "https://api.apitube.io/v1/news/everything?location.name=Tokyo,New York&api_key=YOUR_API_KEY"

Request to get news articles from a specific location and in a specific language (e.g., "Tokyo" and "Japanese") and ignore articles from "New York":

shell

curl -X GET "https://api.apitube.io/v1/news/everything?location.name=Tokyo&language=ja&ignore.location.name=New York&api_key=YOUR_API_KEY"

Authors

Get articles with a specific author.

Endpoints

/v1/news/everything

/v1/news/top-headlines

/v1/news/story

/v1/news/category

/v1/news/topic

/v1/news/industry

/v1/news/entity

Parameters

Parameter	Description	Type	Required
`author.id`	The author ID of the articles.	string	No
`ignore.author.id`	The author ID of the articles to ignore.	string	No
`author.name`	The author name of the articles.	string	No
`ignore.author.name`	The author name of the articles to ignore.	string	No

Workflow examples

Request to get news articles by a specific author (e.g., "John Doe"):

shell

curl -X GET "https://api.apitube.io/v1/news/everything?author.name=John Doe&api_key=YOUR_API_KEY"

Request to get news articles by multiple authors (e.g., "John Doe" and "Jane Doe"):

shell

curl -X GET "https://api.apitube.io/v1/news/everything?author.name=John Doe,Jane Doe&api_key=YOUR_API_KEY"

Request to get news articles by a specific author and in a specific language (e.g., "John Doe" and "English"):

shell

curl -X GET "https://api.apitube.io/v1/news/everything?author.name=John Doe&language=en&api_key=YOUR_API_KEY"

Media

Get articles with a specific media type and size.

Endpoints

/v1/news/everything

/v1/news/top-headlines

/v1/news/story

/v1/news/category

/v1/news/topic

/v1/news/industry

/v1/news/entity

Parameters

Parameter	Description	Type	Required	Example
`media.images.count`	The number of images in the articles.	integer	No	`2`
`media.videos.count`	The number of videos in the articles.	integer	No	`1`
`media.images.width.min`	The minimum width of the images.	integer	No	`200`
`media.images.width.max`	The maximum width of the images.	integer	No	`800`
`media.images.height.min`	The minimum height of the images.	integer	No	`200`
`media.images.height.max`	The maximum height of the images.	integer	No	`800`

Workflow examples

Request to get news articles with a specific number of images and videos:

shell

curl -X GET "https://api.apitube.io/v1/news/everything?media.images.count=2&media.videos.count=1&api_key=YOUR_API_KEY"

Request to get news articles with images of a specific size:

shell

curl -X GET "https://api.apitube.io/v1/news/everything?media.images.width.min=200&media.images.width.max=800&media.images.height.min=200&media.images.height.max=800&api_key=YOUR_API_KEY"

Source

Get articles with a specific source or sources.

Endpoints

/v1/news/everything

/v1/news/top-headlines

/v1/news/story

/v1/news/category

/v1/news/topic

/v1/news/industry

/v1/news/entity

Parameters

Parameter	Description	Type	Required	Example
`source.id`	The source ID of the articles.	int	No	`314`
`ignore.source.id`	The source ID of the articles to ignore.	int	No	`315`
`source.domain`	The source domain of the articles.	string	No	`cnn.com`
`ignore.source.domain`	Ignore the source domain of the articles.	string	No	`techcrunch.com`
`source.type`	The source type of the articles.	string	No	`news`
`ignore.source.type`	Ignore the source type of the articles.	string	No	`blog`
`source.rank.opr.min`	The minimum Open Page Rank source rank.	string	No	`0.5`
`source.rank.opr.max`	The maximum Open Page Rank source rank.	string	No	`0.9`

Workflow examples

Request to get news articles from a specific source (e.g., "cnn.com"):

shell

curl -X GET "https://api.apitube.io/v1/news/everything?source.domain=cnn.com&api_key=YOUR_API_KEY"

Request to get news articles from multiple sources (e.g., "cnn.com" and "bbc.com"):

shell

curl -X GET "https://api.apitube.io/v1/news/everything?source.domain=cnn.com,bbc.com&api_key=YOUR_API_KEY"

Request to get news articles from a specific source and in a specific language (e.g., "cnn.com" and "English"):

shell

curl -X GET "https://api.apitube.io/v1/news/everything?source.domain=cnn.com&language=en&api_key=YOUR_API_KEY"

Request to get news articles from a specific source type (e.g., "news"):

shell

curl -X GET "https://api.apitube.io/v1/news/everything?source.type=news&api_key=YOUR_API_KEY"

Request to get news articles with rank between 0.5 and 0.9:

shell

curl -X GET "https://api.apitube.io/v1/news/everything?source.rank.opr.min=0.5&source.rank.opr.max=0.9&api_key=YOUR_API_KEY"

Get single article

Get a single article by its ID.

Endpoints

/v1/news/article

Parameters

Parameter	Description	Type	Required	Example
`id`	The ID of the article you want to retrieve	string	Yes	`314`

Workflow examples

Request to get a single article by its ID:

shell

curl -X GET "https://api.apitube.io/v1/news/article?id=314&api_key=YOUR_API_KEY"

Other filters

Other powerful filters are available to help you find the articles you need.

Endpoints

/v1/news/everything

/v1/news/top-headlines

/v1/news/story

/v1/news/category

/v1/news/topic

/v1/news/industry

/v1/news/entity

Parameters

Parameter	Description	Type	Required	Example
`is_duplicate`	Filter articles that are duplicates.	string	No	`true`

Sorting

With the News API, you can sort the articles by the following parameters:

sort_by
sort_order

Endpoints

/v1/news/everything

/v1/news/top-headlines

/v1/news/story

/v1/news/category

/v1/news/topic

/v1/news/industry

/v1/news/entity

Parameters for sorting articles (sort_by)

Parameter	Description	Type	Required
`published_at`	Sort by the published date.	string	No
`sentiment.overall.score`	Sort by the overall sentiment magnitude.	string	No
`source.rank.opr`	Sort by the Open Page Rank source rank.	string	No
`media.images.count`	Sort by the number of images.	string	No
`media.videos.count`	Sort by the number of videos.	string	No

Parameters for sorting order (sort_order)

Parameter	Description	Type	Required
`asc`	Sort in ascending order.	string	No
`desc`	Sort in descending order.	string	No

Workflow examples

Request to get news articles sorted by the published date in ascending order:

shell

curl -X GET "https://api.apitube.io/v1/news/everything?sort_by=published_at&sort_order=asc&api_key=YOUR_API_KEY"

Request to get news articles sorted by the overall sentiment magnitude in descending order:

shell

curl -X GET "https://api.apitube.io/v1/news/everything?sort_by=sentiment.overall.score&sort_order=desc&api_key=YOUR_API_KEY"

Pagination

With the News API, you can paginate the articles you want to retrieve.

Endpoints

/v1/news/everything

/v1/news/top-headlines

/v1/news/story

/v1/news/category

/v1/news/topic

/v1/news/industry

/v1/news/entity

Pagination with limit and offset

You can use the per_page and page parameters to specify the number of articles you want to retrieve and the starting point of the articles.

Parameters

Parameter	Description	Type	Required
`per_page`	The number of articles you want to retrieve.	integer	No
`page`	The starting point of the articles.	integer	No

Pagination with cursor

You can use the next_page_cursor parameter to specify the starting point of the articles.

Parameters

Parameter	Description	Type	Required
`next_page_cursor`	The starting point of the articles.	string	No

Workflow examples

Request to get news articles with pagination:

shell

curl -X GET "https://api.apitube.io/v1/news/everything?per_page=10&page=1&api_key=YOUR_API_KEY"

Request to get news articles with cursor pagination:

shell

curl -X GET "https://api.apitube.io/v1/news/everything?next_page_cursor=eyJ2IjoiMCIsImEiOiJ0aGlyZCJ9&api_key=YOUR_API_KEY"

Export articles

With the News API, you can export the articles in formats such as JSON, XML, XLSX, CSV and TSV.

Endpoints

/v1/news/everything

/v1/news/top-headlines

/v1/news/story

/v1/news/article

/v1/news/category

/v1/news/topic

/v1/news/industry

/v1/news/entity

Parameters

Parameter	Description	Type	Required	Example
`export`	The format in which you want to export.	string	No	`json`

Formats

Format	Description
`json`	JSON
`xml`	XML
`xlsx`	XLSX
`csv`	CSV
`tsv`	TSV

Parameters by endpoint ​

Lucene query ​

Endpoints ​

Parameters ​

Lucene query syntax ​

Workflow examples ​

Request to search for articles containing the keyword "Bitcoin": ​

Request to search for articles containing the keyword "Bitcoin" and "Ethereum": ​

Request to search for articles containing the keyword "Bitcoin" or "Ethereum": ​

Datetime ​

Endpoints ​

Parameters ​

Date Math Keywords ​

Date Formats ​

Date Math ​

Date Math Syntax ​

Examples ​

Workflow examples ​

Request to get news articles within a specific date range: ​

Request to get news using a relative time range: ​

Languages ​

Endpoints ​

Parameters ​

Workflow examples ​

Request to get news articles excluding those from France and in the French language: ​

Request to get news articles in the English and French languages: ​

Countries ​

Endpoints ​

Parameters ​

Workflow examples ​

Request to get news articles from the United States: ​

Request to get news articles from the United States and Canada: ​

Request to get news articles excluding those from France and in the French language: ​

Sentiment ​

Endpoints ​

By sentiment score ​

Parameters ​

By sentiment polarity ​

Parameters ​

Workflow examples ​

Request for Positive Sentiment News: ​

Request for Positive Sentiment News from a Specific Country: ​

Request for Positive Sentiment News in the Last 24 Hours: ​

Request for Articles with Positive Sentiment and a Specific Title: ​

Title ​

Endpoints ​

Parameters ​

Workflow examples ​

Request for Positive Sentiment News: ​

Request for Articles with Multiple Title Keywords: ​

Request for Articles with Titles Excluding Certain Words: ​

Category ​

Endpoints ​

Parameters ​

List of supported categories taxonomy ​

Workflow examples ​

Request to get news articles from a specific category (e.g., "Business"): ​

Request for Articles in Multiple Categories: ​

Request for Articles in a Category and Filtered by Language: ​

Topic ​

Endpoints ​

Parameters ​

Workflow examples ​

Request to get news articles from a specific topic (e.g., "crypto_news"): ​

Entities ​

Endpoints ​

Parameters ​

Workflow examples ​

Request for Articles Mentioning Multiple People: ​

Request for Articles Mentioning a Specific Person: ​

Industries ​

Endpoints ​

Parameters ​

Persons ​

Endpoints ​

Parameters ​

Workflow examples ​

Request to get news articles about a specific person (e.g., "Satoshi"): ​

Request to get news articles about multiple people (e.g., "Satoshi" and "Vitalik"): ​

Locations ​

Parameters by endpoint

Lucene query

Endpoints

Parameters

Lucene query syntax

Workflow examples

Request to search for articles containing the keyword "Bitcoin":

Request to search for articles containing the keyword "Bitcoin" and "Ethereum":

Request to search for articles containing the keyword "Bitcoin" or "Ethereum":

Datetime

Endpoints

Parameters

Date Math Keywords

Date Formats

Date Math

Date Math Syntax

Examples

Workflow examples

Request to get news articles within a specific date range:

Request to get news using a relative time range:

Languages

Endpoints

Parameters

Workflow examples

Request to get news articles excluding those from France and in the French language:

Request to get news articles in the English and French languages:

Countries

Endpoints

Parameters

Workflow examples

Request to get news articles from the United States:

Request to get news articles from the United States and Canada:

Request to get news articles excluding those from France and in the French language:

Sentiment

Endpoints

By sentiment score

Parameters

By sentiment polarity

Parameters

Workflow examples

Request for Positive Sentiment News:

Request for Positive Sentiment News from a Specific Country:

Request for Positive Sentiment News in the Last 24 Hours:

Request for Articles with Positive Sentiment and a Specific Title:

Title

Endpoints

Parameters

Workflow examples

Request for Positive Sentiment News:

Request for Articles with Multiple Title Keywords:

Request for Articles with Titles Excluding Certain Words:

Category

Endpoints

Parameters

List of supported categories taxonomy

Workflow examples

Request to get news articles from a specific category (e.g., "Business"):

Request for Articles in Multiple Categories:

Request for Articles in a Category and Filtered by Language:

Topic

Endpoints

Parameters

Workflow examples

Request to get news articles from a specific topic (e.g., "crypto_news"):

Entities

Endpoints

Parameters

Workflow examples

Request for Articles Mentioning Multiple People:

Request for Articles Mentioning a Specific Person:

Industries

Endpoints

Parameters

Persons

Endpoints

Parameters

Workflow examples

Request to get news articles about a specific person (e.g., "Satoshi"):

Request to get news articles about multiple people (e.g., "Satoshi" and "Vitalik"):

Locations