POST
/
api
/
sources

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

countries

The countries where the news publisher is located. The accepted format is the two-letter ISO 3166-1 alpha-2 code. To select multiple countries, use a comma-separated string or an array of strings.

Examples:

  • "US,CA"
  • ["US", "CA"]

To learn more, see Enumerated parameters > Country.

predefined_sources

Predefined top sources per country.

Format: start with the word top, followed by the number of desired sources, and then the two-letter country code ISO 3166-1 alpha-2.

Examples:

  • "top 100 US"
  • "top 33 AT"
  • "top 5 GB"

Multiple countries can be specified with custom numbers as a comma-separated string or an array of strings.

Examples:

  • "top 50 US, top 20 GB"
  • ["top 50 US", "top 20 GB"]
source_name

Specifies terms to search within the source names. To specify multiple terms, use a comma-separated string or an array of strings.

Examples:

  • "sport, tech"
  • ["sport", "tech"]

Note: The search does not require an exact match and returns all sources that include the specified terms anywhere in their names. You can use any word, phrase, or outlet name, such as "sport", or "new york times". For example, using "sport" as a term returns sources like "Motorsport", "Dot Esport", and "Tuttosport".

source_url

The domains of the news publication to search for. To specify multiple news sources, use a comma-separated string or an array of strings.

Examples:

  • "bbc.com, nytimes.com"
  • ["bbc.com", "nytimes.com"]

Caution: When specifying the source_url parameter, you can only use include_additional_info as an extra parameter.

include_additional_info
boolean

If true, returns the following additional datapoints about each news source:

  • nb_articles_for_7d: The number of articles published by the source in the last week.
  • country: Source country of origin.
  • rank: SEO rank.
  • is_news_domain: Boolean indicating if the source is a news domain.
  • news_domain_type: Type of news domain (e.g., "Original Content").
  • news_type: Category of news (e.g., "General News Outlets").
is_news_domain
boolean

If true, filters results to include only news domains.

news_domain_type
enum<string>

Filters results based on the news domain type. Possible values are:

  • Original Content: Sources that produce their own content.
  • Aggregator: Sources that collect content from various other sources.
  • Press Releases: Sources primarily publishing press releases.
  • Republisher: Sources that republish content from other sources.
  • Other: Sources that don't fit into main categories.
Available options:
Original Content,
Aggregator,
Press Releases,
Republisher,
Other
news_type

Filters results based on the news type. Multiple types can be specified using a comma-separated string or an array of strings.

Examples:

  • "General News Outlets,Tech News and Updates"
  • ["General News Outlets", "Tech News and Updates"]

For a complete list of available news types, see Enumerated parameters > News type.

from_rank
integer
default: 1

The lowest boundary of the rank of a news website to filter by. Range: 1 to 999999, where a lower rank indicates a more popular source. If you set this to 100, the API includes sources ranked 100 or higher.

Required range: 1 < x < 999999
to_rank
integer
default: 999999

The highest boundary of the rank of a news website to filter by. Range: 1 to 999999, where a lower rank indicates a more popular source. If you set this to 100, the API includes sources ranked 100 or lower.

Required range: 1 < x < 999999

Response

200 - application/json

The response model for a successful retrieval of news sources matching the specified criteria.

message
string
required

A message indicating the result of the request.

sources
array
required

A list of news sources that match the specified criteria.

user_input
object
required

The user input parameters for the request.