v1

latestOpenAPI 3.1.0Proprietary2026-07-1391579.5 KB
Count

News article count

Returns the number of news articles matching the filters. With interval=all (default) a single total is returned; with interval=hour or interval=day a count-per-hour/day breakdown is returned. from_date and to_date are required, and at least one of the following parameters as well: q, qInTitle, qInMeta, country, category, language, domain, domainurl, prioritydomain, image, video, full_content. Available on plans with count access.

Consumes 50 API credits per call.

get/1/count

Query parameters

apikeystring

Your API key. Alternatively send it in the X-ACCESS-KEY HTTP header. One of the two MUST be present.

qstring

Search articles by keywords or phrases (matches title, description, content, keywords, and URL). Supports AND / OR operators and quoted phrases. Maximum length depends on your plan (default 100 characters). Use only one of q, qInTitle, qInMeta.

qInTitlestring

Search articles by keywords in the title only. Maximum length depends on your plan (default 100 characters). Use only one of q, qInTitle, qInMeta.

qInMetastring

Search articles by keywords in the title, description, keywords, and URL. Maximum length depends on your plan (default 100 characters). Use only one of q, qInTitle, qInMeta.

countrystring[]

Filter by country. Comma-separated ISO 3166-1 alpha-2 country codes, up to your plan's filter limit (default 5). Cannot be combined with excludecountry.

excludecountrystring[]

Exclude countries. Comma-separated ISO country codes, up to your plan's filter limit (default 5). Cannot be combined with country.

categorystring[]

Filter by category. Comma-separated category names, up to your plan's filter limit (default 5). Cannot be combined with excludecategory.

excludecategorystring[]

Exclude categories. Comma-separated category names, up to your plan's filter limit (default 5). Cannot be combined with category.

languagestring[]

Filter by language. Comma-separated ISO 639-1 language codes, up to your plan's filter limit (default 5). Cannot be combined with excludelanguage.

excludelanguagestring[]

Exclude languages. Comma-separated language codes, up to your plan's filter limit (default 5). Cannot be combined with language.

domainstring[]

Filter by news source. Comma-separated source ids (the id value returned by /1/sources), up to your plan's filter limit (default 5). Cannot be combined with domainurl or excludedomain.

domainurlstring[]

Filter by news source domain, e.g. bbc.com. Comma-separated, up to your plan's filter limit (default 5). Cannot be combined with domain or excludedomain.

excludedomainstring[]

Exclude news source domains, e.g. bbc.com. Comma-separated, up to your plan's filter limit (default 5). Cannot be combined with domain or domainurl.

prioritydomain'top' | 'medium' | 'low'

Restrict results to a tier of news sources ranked by quality and popularity: top, medium, or low.

from_datestring required

Count articles published on or after this date. Format YYYY-MM-DD or YYYY-MM-DD HH:MM:SS (UTC). Cannot be a future date. How far back you can go depends on your plan.

to_datestring required

Count articles published on or before this date. Format YYYY-MM-DD or YYYY-MM-DD HH:MM:SS (UTC). Cannot be a future date.

image'0' | '1'

Set to 1 to return only articles that include an image, or 0 to leave the image_url field out of the response.

video'0' | '1'

Set to 1 to return only articles that include a video, or 0 to leave the video_url field out of the response.

full_content'0' | '1'

Set to 1 to return only articles that include full content, or 0 to leave the content field out of the response. Available on plans with full-content access.

removeduplicate'0' | '1'

Set to 1 to exclude duplicate articles. Available for dates from 2024-07-24 onward.

sentiment'positive' | 'neutral' | 'negative'

Filter articles by sentiment. Available on Professional and Corporate plans, for dates from 2024-01-12 onward.

sentiment_scorenumber

Minimum sentiment confidence (1-100) for the chosen sentiment. Requires the sentiment parameter.

tagstring[]

Filter by AI-classified topic tags (e.g. politics,technology). Comma-separated, up to your plan's filter limit (default 5). Available on Professional and Corporate plans, for dates from 2024-01-12 onward.

regionstring[]

Filter by AI-extracted geographic region. Join sub-regions with - to require them together (e.g. paris-france). Comma-separated, up to your plan's filter limit (default 5). Available on Corporate plans, for dates from 2024-01-29 onward.

organizationstring[]

Filter by AI-extracted organization names. Comma-separated, up to your plan's filter limit (default 5). Available on Corporate plans, for dates from 2024-05-24 onward.

creatorstring[]

Filter by article author / byline. Comma-separated, up to your plan's filter limit (default 5).

datatypestring[]

Filter by content type, e.g. news, blog, podcast. Comma-separated, up to your plan's filter limit (default 5). Available for dates from 2025-11-28 onward.

interval'all' | 'hour' | 'day'

How to count: all (default) returns a single total; hour or day returns a count-per-hour or count-per-day breakdown.

sizeinteger

Number of histogram entries per page when interval=hour or day: 1 to 50 on paid plans, 1 to 10 on the free plan.

pagestring

Pagination for the histogram. Pass the nextPage value from the previous response.

sort'pubdatedesc' | 'pubdateasc'

Ordering of the histogram: pubdatedesc (default, newest first) or pubdateasc.

Response

Success. The shape depends on the interval parameter.

OR