[Get] Search By Author Request
GET {{baseUrl}}/api/authors
This endpoint allows you to search for articles. You can search for articles by keyword, language, country, source, and more.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
author_name | string | (Required) Keyword/keywords you're searching for author. This is the most important part of your query. | |
sources | string | One or more news sources to narrow down your search. |
The format should be a domain url from your URL. Subdomains, like finance.yahoo.com are also accepted. Comma-separated string or a list/array.
For example, nytimes.com,theguardian.com,finance.yahoo.com |
| not_sources | string | | One or more sources to be excluded from the search.
Comma-separated string or a list/array.
For example, cnn.com,wsj.com |
| predefined_sources | string | | Use our TOP predifined sources per country.
Later we are going to improve it and add more functionality, like top categories etc.
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 |
| lang | string | | Specifies the languages of the search. For example, en.
The only accepted format is ISO 639-1 — 2 letter code.
Refer to the language format section (https://docs.newscatcherapi.com/api-docs/endpoints-1/debugging#language-format) for more details. |
| not_lang | string | | Inverse to the lang parameter |
| countries | string | | Countries where the news publisher is located.
Important: This parameter is not responsible for the countries mentioned in the news article.
One or multiple countries can be used in the search.
The only acceptable format is ISO 3166-1 alpha-2 (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)
For example, US,CA,MX or just US |
| not_countries | string | | Inverse to the countries parameter |
| from_ | string | | From which point in time to start the search. Defaults to the past week.
Availabe formats :
YYYY/mm/dd
YYYY/mm/dd HH:MM:SS
English phrases like 1 day ago |
| to_ | string | | Until which point in time to search for. The default timezone is UTC.
Availabe formats :
YYYY/mm/dd
YYYY/mm/dd HH:MM:SS
English phrases like1 day ago |
| published_date_precision | string | | There are 3 types of date precision we define:
full — day and time of an article is correctly identified with the appropriate timezone
timezone unknown — day and time of an article is correctly identified without timezone
date — only the day is identified without an exact time |
| by_parse_date | string | | When set to True, transforms your from_ and to_ parameters to filter by parse_date instead of published_date
Be aware that a new variable parse_date will be added to the output list with each article. |
| sort_by | string | | relevancy (default value) — the most relevant results first
date — the most recently published results first
rank — the results from the highest-ranked sources first |
| ranked_only | string | | Default: True
Limit the search only for the sources which are in the top 1 million online websites. Unranked sources are assigned a rank that equals 999999 |
| 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 upper boundary of the rank of a news website to filter by. |
| is_headline | string | | When set to True, only articles that were posted on the home page of a given news domain will be shown. |
| is_paid_content | string | | When set to False, only articles that publish full public available content will be shown.
Some news publishers partially block content of their articles, so we get only several sentences from them. This filter will help you get full content.
[Still in development phase] |
| parent_url | string | | One or more categorical URL to filter your search. It should be the normal form of the URL,
For example, https://www.washingtonpost.com/politics,https://www.washingtonpost.com/technology,https://www.washingtonpost.com/business |
| all_links | string | | Search for desired URL mentioned in the article.
Please, refer to the All Links And Domains Format (https://docs.newscatcherapi.com/api-docs/endpoints-1/search-news/search-by-url) pagefor more examples and explanations. |
| all_domain_links | string | | Search for domain URL mentioned in the article.
Please, refer to the All Links And Domains Format (https://docs.newscatcherapi.com/api-docs/endpoints-1/search-news/search-by-url) pagefor more examples and explanations. |
| word_count_min | string | | Set a minimum number of words that an article must contain.
To be used for avoiding avoid articles with small content. |
| word_count_max | string | | Set a maximum number of words that an article must contain.
To be used for avoiding avoid articles with big content. |
| page_size | string | | [1:1000] How many articles to return per page. |
| page | string | | The number of the page. Use it to scroll through the results.
This parameter is used to paginate: scroll through results because one API response cannot return more than 1000 articles.
|
| include_nlp_data | string | | When set to True, adds to each article a NLP layer.
Not available for all plans. Please contact us to enable it. |
| has_nlp | string | | When set to True, filter data only to those articles that have an NLP layer.
[Available only if NLP enabled for your plan] |
| theme | string | | Accepted values: Business, Economics, Entertainment, Finance, Health, Politics, Science, Sports, Tech, Crime, Lifestyle, Automotive , Travel, Weather, General
Comma-separated string or a list/array.
Multiple themes can be selected.
For example: Business Business, Finance
Topic labelling is based on the actual content of an article.
[Available only if NLP enabled for your plan] |
| title_sentiment_min | string | | Narrow down your search to only positive or negative news based on the article's title sentiment.
The value can vary from -1 to 1.
[Available only if NLP enabled for your plan] |
| title_sentiment_max | string | | Narrow down your search to only positive or negative news based on the article's title sentiment.
The value can vary from -1 to 1.
[Available only if NLP enabled for your plan] |
| content_sentiment_min | string | | Narrow down your search to only positive or negative news based on the article's content sentiment.
The value can vary from -1 to 1.
[Available only if NLP enabled for your plan] |
| content_sentiment_max | string | | Narrow down your search to only positive or negative news based on the article's content sentiment.
The value can vary from -1 to 1.
[Available only if NLP enabled for your plan] |
| ner_name | string | | |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
x-api-token | string | (Required) | |
Accept | string |
RESPONSES
status: OK
{"total_hits":"\u003cinteger\u003e","page":"\u003cinteger\u003e","total_pages":"\u003cinteger\u003e","page_size":"\u003cinteger\u003e","articles":[],"user_input":{},"status":"ok"}