[Get] Search For Sources Request
GET {{baseUrl}}/api/sources
This endpoint allows you to get the list of sources that are available in the database. You can filter the sources by language and country. The maximum number of sources displayed is set according to your plan. You can find the list of plans and their features here: https://newscatcherapi.com/news-api#news-api-pricing
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
lang | string | Language(s) that the news outlet publishes in | |
countries | string | Country of the news publication | |
predefined_sources | string | Get the lists behind out TOP predefined sources per country. |
The format should be strictly like this:
- starting with word top
- put the number of desired sources top source
- 2 letter country code ISO 3166-1 alpha-2
For example: top 100 US top 33 AT top 5 GB
It is also possible to put multiple countries with custom number of top sources, should be comma separated.
For example:
top 100 US, GB
top 33 AT, 55 IT |
| include_additional_info
| string | | When set to True, you get the following additional datapoints about each news source:
- nb_articles_for_7d : number of articles published by the source in the last week.
- country: it's country of the origin
- rank: SEO rank |
|
from_rank
| string | | [0:999999] The lowest boundary of the rank of a news website to filter by.
Important: lower rank means that a source is more popular |
| to_rank
| string | | [0:999999] The highest boundary of the rank of a news website to filter by. |
| source_name
| string | | search using the name of the news publication.
This parameter does not exact matching, so searching for 'sport' will return all sources with sport in their name like: 'Motorsport', 'Dot Esport', 'Tuttosport', etc |
| source_url
| string | | search using the domain of the news publication
You can not use the source_url parameter in combination with any other parameter |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
x-api-token | string | (Required) | |
Accept | string |
RESPONSES
status: OK
{"message":"\u003cstring\u003e","sources":[{"domain_url":"\u003cstring\u003e","name_source":"\u003cstring\u003e","logo":"\u003cstring\u003e","additional_info":{"nb_articles_for_7d":"\u003cinteger\u003e","country":"\u003cstring\u003e","rank":"\u003cinteger\u003e"}},{"domain_url":"\u003cstring\u003e","name_source":"\u003cstring\u003e","logo":"\u003cstring\u003e","additional_info":{"nb_articles_for_7d":"\u003cinteger\u003e","country":"\u003cstring\u003e","rank":"\u003cinteger\u003e"}}],"user_input":{"lang":["\u003cstring\u003e","\u003cstring\u003e"],"countries":["\u003cstring\u003e","\u003cstring\u003e"],"predefined_sources":["\u003cstring\u003e","\u003cstring\u003e"],"include_additional_info":"\u003cboolean\u003e","from_rank":"\u003cinteger\u003e","to_rank":"\u003cinteger\u003e","source_url":["\u003cstring\u003e","\u003cstring\u003e"],"source_name":"\u003cstring\u003e"}}