| Name | newscatcherapi-python-sdk JSON |
| Version |
6.0.13
JSON |
| download |
| home_page | None |
| Summary | Client for NewsCatcher-V3 Production API |
| upload_time | 2024-10-08 12:13:47 |
| maintainer | None |
| docs_url | None |
| author | Maksym Sugonyaka |
| requires_python | <4.0,>=3.7 |
| license | MIT |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# newscatcherapi-python-sdk<a id="newscatcherapi-python-sdk"></a>
<img src='https://uploads-ssl.webflow.com/6429857b17973b636c2195c5/646c6f1eb774ff2f2997bec5_newscatcher_.svg' width='286' height='35' /> <br> <br>Visit our website <a href='https://newscatcherapi.com'>https://newscatcherapi.com</a>
[](https://pypi.org/project/newscatcherapi-python-sdk/6.0.13)
[](https://github.com/konfig-dev/newscatcher-sdks/tree/main/v3/python#readme)
## Table of Contents<a id="table-of-contents"></a>
<!-- toc -->
- [Requirements](#requirements)
- [Installation](#installation)
- [Getting Started](#getting-started)
- [Async](#async)
- [Raw HTTP Response](#raw-http-response)
- [Reference](#reference)
* [`newscatcher.authors.get`](#newscatcherauthorsget)
* [`newscatcher.authors.post`](#newscatcherauthorspost)
* [`newscatcher.latest_headlines.get`](#newscatcherlatest_headlinesget)
* [`newscatcher.latest_headlines.post`](#newscatcherlatest_headlinespost)
* [`newscatcher.search.get`](#newscatchersearchget)
* [`newscatcher.search.post`](#newscatchersearchpost)
* [`newscatcher.search_link.get`](#newscatchersearch_linkget)
* [`newscatcher.search_link.post`](#newscatchersearch_linkpost)
* [`newscatcher.search_similar.get`](#newscatchersearch_similarget)
* [`newscatcher.search_similar.post`](#newscatchersearch_similarpost)
* [`newscatcher.sources.get`](#newscatchersourcesget)
* [`newscatcher.sources.post`](#newscatchersourcespost)
* [`newscatcher.subscription.get`](#newscatchersubscriptionget)
* [`newscatcher.subscription.post`](#newscatchersubscriptionpost)
<!-- tocstop -->
## Requirements<a id="requirements"></a>
Python >=3.7
## Installation<a id="installation"></a>
```sh
pip install newscatcherapi-python-sdk==6.0.13
```
## Getting Started<a id="getting-started"></a>
```python
from pprint import pprint
from newscatcherapi_client import Newscatcher, ApiException
newscatcher = Newscatcher(
api_key="YOUR_API_KEY",
)
try:
# [Get] Search By Author Request
get_response = newscatcher.authors.get(
author_name="author_name_example",
not_author_name="string_example",
sources=None,
predefined_sources=None,
not_sources=None,
lang=None,
not_lang=None,
countries=None,
not_countries=None,
from_="string_example",
to_="string_example",
published_date_precision="string_example",
by_parse_date=False,
sort_by="relevancy",
ranked_only="string_example",
from_rank=1,
to_rank=1,
is_headline=True,
is_opinion=True,
is_paid_content=True,
parent_url=None,
all_links=None,
all_domain_links=None,
word_count_min=0,
word_count_max=0,
page=1,
page_size=100,
include_nlp_data=True,
has_nlp=True,
theme="string_example",
not_theme="string_example",
title_sentiment_min=3.14,
title_sentiment_max=3.14,
content_sentiment_min=3.14,
content_sentiment_max=3.14,
iptc_tags=None,
not_iptc_tags=None,
iab_tags=None,
not_iab_tags=None,
)
print(get_response)
except ApiException as e:
print("Exception when calling AuthorsApi.get: %s\n" % e)
pprint(e.body)
if e.status == 422:
pprint(e.body["detail"])
pprint(e.headers)
pprint(e.status)
pprint(e.reason)
pprint(e.round_trip_time)
```
## Async<a id="async"></a>
`async` support is available by prepending `a` to any method.
```python
import asyncio
from pprint import pprint
from newscatcherapi_client import Newscatcher, ApiException
newscatcher = Newscatcher(
api_key="YOUR_API_KEY",
)
async def main():
try:
# [Get] Search By Author Request
get_response = await newscatcher.authors.aget(
author_name="author_name_example",
not_author_name="string_example",
sources=None,
predefined_sources=None,
not_sources=None,
lang=None,
not_lang=None,
countries=None,
not_countries=None,
from_="string_example",
to_="string_example",
published_date_precision="string_example",
by_parse_date=False,
sort_by="relevancy",
ranked_only="string_example",
from_rank=1,
to_rank=1,
is_headline=True,
is_opinion=True,
is_paid_content=True,
parent_url=None,
all_links=None,
all_domain_links=None,
word_count_min=0,
word_count_max=0,
page=1,
page_size=100,
include_nlp_data=True,
has_nlp=True,
theme="string_example",
not_theme="string_example",
title_sentiment_min=3.14,
title_sentiment_max=3.14,
content_sentiment_min=3.14,
content_sentiment_max=3.14,
iptc_tags=None,
not_iptc_tags=None,
iab_tags=None,
not_iab_tags=None,
)
print(get_response)
except ApiException as e:
print("Exception when calling AuthorsApi.get: %s\n" % e)
pprint(e.body)
if e.status == 422:
pprint(e.body["detail"])
pprint(e.headers)
pprint(e.status)
pprint(e.reason)
pprint(e.round_trip_time)
asyncio.run(main())
```
## Raw HTTP Response<a id="raw-http-response"></a>
To access raw HTTP response values, use the `.raw` namespace.
```python
from pprint import pprint
from newscatcherapi_client import Newscatcher, ApiException
newscatcher = Newscatcher(
api_key="YOUR_API_KEY",
)
try:
# [Get] Search By Author Request
get_response = newscatcher.authors.raw.get(
author_name="author_name_example",
not_author_name="string_example",
sources=None,
predefined_sources=None,
not_sources=None,
lang=None,
not_lang=None,
countries=None,
not_countries=None,
from_="string_example",
to_="string_example",
published_date_precision="string_example",
by_parse_date=False,
sort_by="relevancy",
ranked_only="string_example",
from_rank=1,
to_rank=1,
is_headline=True,
is_opinion=True,
is_paid_content=True,
parent_url=None,
all_links=None,
all_domain_links=None,
word_count_min=0,
word_count_max=0,
page=1,
page_size=100,
include_nlp_data=True,
has_nlp=True,
theme="string_example",
not_theme="string_example",
title_sentiment_min=3.14,
title_sentiment_max=3.14,
content_sentiment_min=3.14,
content_sentiment_max=3.14,
iptc_tags=None,
not_iptc_tags=None,
iab_tags=None,
not_iab_tags=None,
)
pprint(get_response.body)
pprint(get_response.headers)
pprint(get_response.status)
pprint(get_response.round_trip_time)
except ApiException as e:
print("Exception when calling AuthorsApi.get: %s\n" % e)
pprint(e.body)
if e.status == 422:
pprint(e.body["detail"])
pprint(e.headers)
pprint(e.status)
pprint(e.reason)
pprint(e.round_trip_time)
```
## Reference<a id="reference"></a>
### `newscatcher.authors.get`<a id="newscatcherauthorsget"></a>
This endpoint allows you to search for articles by author. You need to specify the author name. You can also filter by language, country, source, and more.
#### 🛠️ Usage<a id="🛠️-usage"></a>
```python
get_response = newscatcher.authors.get(
author_name="author_name_example",
not_author_name="string_example",
sources=None,
predefined_sources=None,
not_sources=None,
lang=None,
not_lang=None,
countries=None,
not_countries=None,
from_="string_example",
to_="string_example",
published_date_precision="string_example",
by_parse_date=False,
sort_by="relevancy",
ranked_only="string_example",
from_rank=1,
to_rank=1,
is_headline=True,
is_opinion=True,
is_paid_content=True,
parent_url=None,
all_links=None,
all_domain_links=None,
word_count_min=0,
word_count_max=0,
page=1,
page_size=100,
include_nlp_data=True,
has_nlp=True,
theme="string_example",
not_theme="string_example",
title_sentiment_min=3.14,
title_sentiment_max=3.14,
content_sentiment_min=3.14,
content_sentiment_max=3.14,
iptc_tags=None,
not_iptc_tags=None,
iab_tags=None,
not_iab_tags=None,
)
```
#### ⚙️ Parameters<a id="⚙️-parameters"></a>
##### author_name: `str`<a id="author_name-str"></a>
##### not_author_name: `str`<a id="not_author_name-str"></a>
##### sources: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id="sources-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy"></a>
##### predefined_sources: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id="predefined_sources-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy"></a>
##### not_sources: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id="not_sources-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy"></a>
##### lang: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id="lang-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy"></a>
##### not_lang: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id="not_lang-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy"></a>
##### countries: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id="countries-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy"></a>
##### not_countries: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id="not_countries-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy"></a>
##### from_: Union[`str`, `datetime`]<a id="from_-unionstr-datetime"></a>
##### to_: Union[`str`, `datetime`]<a id="to_-unionstr-datetime"></a>
##### published_date_precision: `str`<a id="published_date_precision-str"></a>
##### by_parse_date: `bool`<a id="by_parse_date-bool"></a>
##### sort_by: `str`<a id="sort_by-str"></a>
##### ranked_only: Union[`str`, `bool`]<a id="ranked_only-unionstr-bool"></a>
##### from_rank: `int`<a id="from_rank-int"></a>
##### to_rank: `int`<a id="to_rank-int"></a>
##### is_headline: `bool`<a id="is_headline-bool"></a>
##### is_opinion: `bool`<a id="is_opinion-bool"></a>
##### is_paid_content: `bool`<a id="is_paid_content-bool"></a>
##### parent_url: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id="parent_url-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy"></a>
##### all_links: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id="all_links-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy"></a>
##### all_domain_links: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id="all_domain_links-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy"></a>
##### word_count_min: `int`<a id="word_count_min-int"></a>
##### word_count_max: `int`<a id="word_count_max-int"></a>
##### page: `int`<a id="page-int"></a>
##### page_size: `int`<a id="page_size-int"></a>
##### include_nlp_data: `bool`<a id="include_nlp_data-bool"></a>
##### has_nlp: `bool`<a id="has_nlp-bool"></a>
##### theme: `str`<a id="theme-str"></a>
##### not_theme: `str`<a id="not_theme-str"></a>
##### title_sentiment_min: `Union[int, float]`<a id="title_sentiment_min-unionint-float"></a>
##### title_sentiment_max: `Union[int, float]`<a id="title_sentiment_max-unionint-float"></a>
##### content_sentiment_min: `Union[int, float]`<a id="content_sentiment_min-unionint-float"></a>
##### content_sentiment_max: `Union[int, float]`<a id="content_sentiment_max-unionint-float"></a>
##### iptc_tags: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id="iptc_tags-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy"></a>
##### not_iptc_tags: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id="not_iptc_tags-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy"></a>
##### iab_tags: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id="iab_tags-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy"></a>
##### not_iab_tags: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id="not_iab_tags-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy"></a>
#### 🔄 Return<a id="🔄-return"></a>
[`AuthorsGetResponse`](./newscatcherapi_client/pydantic/authors_get_response.py)
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
`/api/authors` `get`
[🔙 **Back to Table of Contents**](#table-of-contents)
---
### `newscatcher.authors.post`<a id="newscatcherauthorspost"></a>
This endpoint allows you to search for articles by author. You need to specify the author name. You can also filter by language, country, source, and more.
#### 🛠️ Usage<a id="🛠️-usage"></a>
```python
post_response = newscatcher.authors.post(
author_name="string_example",
not_author_name="string_example",
sources=None,
predefined_sources=None,
not_sources=None,
lang=None,
not_lang=None,
countries=None,
not_countries=None,
from_="string_example",
to_="string_example",
published_date_precision="string_example",
by_parse_date=False,
sort_by="relevancy",
ranked_only="string_example",
from_rank=1,
to_rank=1,
is_headline=True,
is_opinion=True,
is_paid_content=True,
parent_url=None,
all_links=None,
all_domain_links=None,
word_count_min=0,
word_count_max=0,
page=1,
page_size=100,
include_nlp_data=True,
has_nlp=True,
theme="string_example",
not_theme="string_example",
title_sentiment_min=3.14,
title_sentiment_max=3.14,
content_sentiment_min=3.14,
content_sentiment_max=3.14,
iptc_tags=None,
not_iptc_tags=None,
iab_tags=None,
not_iab_tags=None,
)
```
#### ⚙️ Parameters<a id="⚙️-parameters"></a>
##### author_name: `str`<a id="author_name-str"></a>
##### not_author_name: `str`<a id="not_author_name-str"></a>
##### sources: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id="sources-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy"></a>
##### predefined_sources: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id="predefined_sources-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy"></a>
##### not_sources: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id="not_sources-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy"></a>
##### lang: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id="lang-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy"></a>
##### not_lang: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id="not_lang-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy"></a>
##### countries: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id="countries-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy"></a>
##### not_countries: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id="not_countries-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy"></a>
##### from_: Union[`str`, `datetime`]<a id="from_-unionstr-datetime"></a>
##### to_: Union[`str`, `datetime`]<a id="to_-unionstr-datetime"></a>
##### published_date_precision: `str`<a id="published_date_precision-str"></a>
##### by_parse_date: `bool`<a id="by_parse_date-bool"></a>
##### sort_by: `str`<a id="sort_by-str"></a>
##### ranked_only: Union[`str`, `bool`]<a id="ranked_only-unionstr-bool"></a>
##### from_rank: `int`<a id="from_rank-int"></a>
##### to_rank: `int`<a id="to_rank-int"></a>
##### is_headline: `bool`<a id="is_headline-bool"></a>
##### is_opinion: `bool`<a id="is_opinion-bool"></a>
##### is_paid_content: `bool`<a id="is_paid_content-bool"></a>
##### parent_url: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id="parent_url-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy"></a>
##### all_links: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id="all_links-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy"></a>
##### all_domain_links: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id="all_domain_links-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy"></a>
##### word_count_min: `int`<a id="word_count_min-int"></a>
##### word_count_max: `int`<a id="word_count_max-int"></a>
##### page: `int`<a id="page-int"></a>
##### page_size: `int`<a id="page_size-int"></a>
##### include_nlp_data: `bool`<a id="include_nlp_data-bool"></a>
##### has_nlp: `bool`<a id="has_nlp-bool"></a>
##### theme: `str`<a id="theme-str"></a>
##### not_theme: `str`<a id="not_theme-str"></a>
##### title_sentiment_min: `Union[int, float]`<a id="title_sentiment_min-unionint-float"></a>
##### title_sentiment_max: `Union[int, float]`<a id="title_sentiment_max-unionint-float"></a>
##### content_sentiment_min: `Union[int, float]`<a id="content_sentiment_min-unionint-float"></a>
##### content_sentiment_max: `Union[int, float]`<a id="content_sentiment_max-unionint-float"></a>
##### iptc_tags: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id="iptc_tags-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy"></a>
##### not_iptc_tags: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id="not_iptc_tags-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy"></a>
##### iab_tags: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id="iab_tags-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy"></a>
##### not_iab_tags: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id="not_iab_tags-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy"></a>
#### ⚙️ Request Body<a id="⚙️-request-body"></a>
[`AuthorSearchRequest`](./newscatcherapi_client/type/author_search_request.py)
#### 🔄 Return<a id="🔄-return"></a>
[`AuthorsPostResponse`](./newscatcherapi_client/pydantic/authors_post_response.py)
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
`/api/authors` `post`
[🔙 **Back to Table of Contents**](#table-of-contents)
---
### `newscatcher.latest_headlines.get`<a id="newscatcherlatest_headlinesget"></a>
This endpoint allows you to get latest headlines. You need to specify since when you want to get the latest headlines. You can also filter by language, country, source, and more.
#### 🛠️ Usage<a id="🛠️-usage"></a>
```python
get_response = newscatcher.latest_headlines.get(
when="7d",
by_parse_date=False,
sort_by="relevancy",
lang=None,
not_lang=None,
countries=None,
not_countries=None,
sources=None,
predefined_sources=None,
not_sources=None,
not_author_name=None,
ranked_only="string_example",
is_headline=True,
is_opinion=True,
is_paid_content=True,
parent_url=None,
all_links=None,
all_domain_links=None,
word_count_min=0,
word_count_max=0,
page=1,
page_size=100,
clustering_variable="string_example",
clustering_enabled=True,
clustering_threshold=3.14,
include_nlp_data=True,
has_nlp=True,
theme="string_example",
not_theme="string_example",
org_entity_name="string_example",
per_entity_name="string_example",
loc_entity_name="string_example",
misc_entity_name="string_example",
title_sentiment_min=3.14,
title_sentiment_max=3.14,
content_sentiment_min=3.14,
content_sentiment_max=3.14,
iptc_tags=None,
not_iptc_tags=None,
iab_tags=None,
not_iab_tags=None,
)
```
#### ⚙️ Parameters<a id="⚙️-parameters"></a>
##### when: `str`<a id="when-str"></a>
##### by_parse_date: `bool`<a id="by_parse_date-bool"></a>
##### sort_by: `str`<a id="sort_by-str"></a>
##### lang: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id="lang-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy"></a>
##### not_lang: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id="not_lang-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy"></a>
##### countries: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id="countries-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy"></a>
##### not_countries: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id="not_countries-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy"></a>
##### sources: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id="sources-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy"></a>
##### predefined_sources: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id="predefined_sources-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy"></a>
##### not_sources: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id="not_sources-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy"></a>
##### not_author_name: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id="not_author_name-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy"></a>
##### ranked_only: Union[`str`, `bool`]<a id="ranked_only-unionstr-bool"></a>
##### is_headline: `bool`<a id="is_headline-bool"></a>
##### is_opinion: `bool`<a id="is_opinion-bool"></a>
##### is_paid_content: `bool`<a id="is_paid_content-bool"></a>
##### parent_url: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id="parent_url-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy"></a>
##### all_links: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id="all_links-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy"></a>
##### all_domain_links: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id="all_domain_links-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy"></a>
##### word_count_min: `int`<a id="word_count_min-int"></a>
##### word_count_max: `int`<a id="word_count_max-int"></a>
##### page: `int`<a id="page-int"></a>
##### page_size: `int`<a id="page_size-int"></a>
##### clustering_variable: `str`<a id="clustering_variable-str"></a>
##### clustering_enabled: `bool`<a id="clustering_enabled-bool"></a>
##### clustering_threshold: `Union[int, float]`<a id="clustering_threshold-unionint-float"></a>
##### include_nlp_data: `bool`<a id="include_nlp_data-bool"></a>
##### has_nlp: `bool`<a id="has_nlp-bool"></a>
##### theme: `str`<a id="theme-str"></a>
##### not_theme: `str`<a id="not_theme-str"></a>
##### org_entity_name: `str`<a id="org_entity_name-str"></a>
##### per_entity_name: `str`<a id="per_entity_name-str"></a>
##### loc_entity_name: `str`<a id="loc_entity_name-str"></a>
##### misc_entity_name: `str`<a id="misc_entity_name-str"></a>
##### title_sentiment_min: `Union[int, float]`<a id="title_sentiment_min-unionint-float"></a>
##### title_sentiment_max: `Union[int, float]`<a id="title_sentiment_max-unionint-float"></a>
##### content_sentiment_min: `Union[int, float]`<a id="content_sentiment_min-unionint-float"></a>
##### content_sentiment_max: `Union[int, float]`<a id="content_sentiment_max-unionint-float"></a>
##### iptc_tags: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id="iptc_tags-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy"></a>
##### not_iptc_tags: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id="not_iptc_tags-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy"></a>
##### iab_tags: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id="iab_tags-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy"></a>
##### not_iab_tags: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id="not_iab_tags-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy"></a>
#### 🔄 Return<a id="🔄-return"></a>
[`LatestHeadlinesGetResponse`](./newscatcherapi_client/pydantic/latest_headlines_get_response.py)
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
`/api/latest_headlines` `get`
[🔙 **Back to Table of Contents**](#table-of-contents)
---
### `newscatcher.latest_headlines.post`<a id="newscatcherlatest_headlinespost"></a>
This endpoint allows you to get latest headlines. You need to specify since when you want to get the latest headlines. You can also filter by language, country, source, and more.
#### 🛠️ Usage<a id="🛠️-usage"></a>
```python
post_response = newscatcher.latest_headlines.post(
when="7d",
by_parse_date=False,
sort_by="relevancy",
lang=None,
not_lang=None,
countries=None,
not_countries=None,
sources=None,
predefined_sources=None,
not_sources=None,
not_author_name=None,
ranked_only="string_example",
is_headline=True,
is_opinion=True,
is_paid_content=True,
parent_url=None,
all_links=None,
all_domain_links=None,
word_count_min=0,
word_count_max=0,
page=1,
page_size=100,
clustering_variable="string_example",
clustering_enabled=True,
clustering_threshold=3.14,
include_nlp_data=True,
has_nlp=True,
theme="string_example",
not_theme="string_example",
org_entity_name="string_example",
per_entity_name="string_example",
loc_entity_name="string_example",
misc_entity_name="string_example",
title_sentiment_min=3.14,
title_sentiment_max=3.14,
content_sentiment_min=3.14,
content_sentiment_max=3.14,
iptc_tags=None,
not_iptc_tags=None,
iab_tags=None,
not_iab_tags=None,
)
```
#### ⚙️ Parameters<a id="⚙️-parameters"></a>
##### when: `str`<a id="when-str"></a>
##### by_parse_date: `bool`<a id="by_parse_date-bool"></a>
##### sort_by: `str`<a id="sort_by-str"></a>
##### lang: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id="lang-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy"></a>
##### not_lang: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id="not_lang-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy"></a>
##### countries: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id="countries-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy"></a>
##### not_countries: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id="not_countries-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy"></a>
##### sources: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id="sources-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy"></a>
##### predefined_sources: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id="predefined_sources-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy"></a>
##### not_sources: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id="not_sources-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy"></a>
##### not_author_name: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id="not_author_name-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy"></a>
##### ranked_only: Union[`str`, `bool`]<a id="ranked_only-unionstr-bool"></a>
##### is_headline: `bool`<a id="is_headline-bool"></a>
##### is_opinion: `bool`<a id="is_opinion-bool"></a>
##### is_paid_content: `bool`<a id="is_paid_content-bool"></a>
##### parent_url: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id="parent_url-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy"></a>
##### all_links: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id="all_links-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy"></a>
##### all_domain_links: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id="all_domain_links-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy"></a>
##### word_count_min: `int`<a id="word_count_min-int"></a>
##### word_count_max: `int`<a id="word_count_max-int"></a>
##### page: `int`<a id="page-int"></a>
##### page_size: `int`<a id="page_size-int"></a>
##### clustering_variable: `str`<a id="clustering_variable-str"></a>
##### clustering_enabled: `bool`<a id="clustering_enabled-bool"></a>
##### clustering_threshold: `Union[int, float]`<a id="clustering_threshold-unionint-float"></a>
##### include_nlp_data: `bool`<a id="include_nlp_data-bool"></a>
##### has_nlp: `bool`<a id="has_nlp-bool"></a>
##### theme: `str`<a id="theme-str"></a>
##### not_theme: `str`<a id="not_theme-str"></a>
##### org_entity_name: `str`<a id="org_entity_name-str"></a>
##### per_entity_name: `str`<a id="per_entity_name-str"></a>
##### loc_entity_name: `str`<a id="loc_entity_name-str"></a>
##### misc_entity_name: `str`<a id="misc_entity_name-str"></a>
##### title_sentiment_min: `Union[int, float]`<a id="title_sentiment_min-unionint-float"></a>
##### title_sentiment_max: `Union[int, float]`<a id="title_sentiment_max-unionint-float"></a>
##### content_sentiment_min: `Union[int, float]`<a id="content_sentiment_min-unionint-float"></a>
##### content_sentiment_max: `Union[int, float]`<a id="content_sentiment_max-unionint-float"></a>
##### iptc_tags: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id="iptc_tags-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy"></a>
##### not_iptc_tags: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id="not_iptc_tags-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy"></a>
##### iab_tags: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id="iab_tags-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy"></a>
##### not_iab_tags: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id="not_iab_tags-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy"></a>
#### ⚙️ Request Body<a id="⚙️-request-body"></a>
[`LatestHeadlinesRequest`](./newscatcherapi_client/type/latest_headlines_request.py)
#### 🔄 Return<a id="🔄-return"></a>
[`LatestHeadlinesPostResponse`](./newscatcherapi_client/pydantic/latest_headlines_post_response.py)
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
`/api/latest_headlines` `post`
[🔙 **Back to Table of Contents**](#table-of-contents)
---
### `newscatcher.search.get`<a id="newscatchersearchget"></a>
This endpoint allows you to search for articles. You can search for articles by keyword, language, country, source, and more.
#### 🛠️ Usage<a id="🛠️-usage"></a>
```python
get_response = newscatcher.search.get(
q="q_example",
search_in="title_content",
predefined_sources=None,
sources=None,
not_sources=None,
lang=None,
not_lang=None,
countries=None,
not_countries=None,
not_author_name=None,
from_="string_example",
to_="string_example",
published_date_precision="string_example",
by_parse_date=False,
sort_by="relevancy",
ranked_only="string_example",
from_rank=1,
to_rank=1,
is_headline=True,
is_opinion=True,
is_paid_content=True,
parent_url=None,
all_links=None,
all_domain_links=None,
word_count_min=0,
word_count_max=0,
page=1,
page_size=100,
clustering_variable="string_example",
clustering_enabled=True,
clustering_threshold=3.14,
include_nlp_data=True,
has_nlp=True,
theme="string_example",
not_theme="string_example",
org_entity_name="string_example",
per_entity_name="string_example",
loc_entity_name="string_example",
misc_entity_name="string_example",
title_sentiment_min=3.14,
title_sentiment_max=3.14,
content_sentiment_min=3.14,
content_sentiment_max=3.14,
iptc_tags=None,
not_iptc_tags=None,
source_name=None,
iab_tags=None,
not_iab_tags=None,
exclude_duplicates=True,
additional_domain_info=True,
is_news_domain=True,
news_domain_type=None,
news_type=None,
)
```
#### ⚙️ Parameters<a id="⚙️-parameters"></a>
##### q: `str`<a id="q-str"></a>
##### search_in: `str`<a id="search_in-str"></a>
##### predefined_sources: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id="predefined_sources-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy"></a>
##### sources: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id="sources-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy"></a>
##### not_sources: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id="not_sources-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy"></a>
##### lang: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id="lang-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy"></a>
##### not_lang: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id="not_lang-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy"></a>
##### countries: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id="countries-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy"></a>
##### not_countries: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id="not_countries-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy"></a>
##### not_author_name: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id="not_author_name-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy"></a>
##### from_: Union[`str`, `datetime`]<a id="from_-unionstr-datetime"></a>
##### to_: Union[`str`, `datetime`]<a id="to_-unionstr-datetime"></a>
##### published_date_precision: `str`<a id="published_date_precision-str"></a>
##### by_parse_date: `bool`<a id="by_parse_date-bool"></a>
##### sort_by: `str`<a id="sort_by-str"></a>
##### ranked_only: Union[`str`, `bool`]<a id="ranked_only-unionstr-bool"></a>
##### from_rank: `int`<a id="from_rank-int"></a>
##### to_rank: `int`<a id="to_rank-int"></a>
##### is_headline: `bool`<a id="is_headline-bool"></a>
##### is_opinion: `bool`<a id="is_opinion-bool"></a>
##### is_paid_content: `bool`<a id="is_paid_content-bool"></a>
##### parent_url: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id="parent_url-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy"></a>
##### all_links: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id="all_links-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy"></a>
##### all_domain_links: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id="all_domain_links-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy"></a>
##### word_count_min: `int`<a id="word_count_min-int"></a>
##### word_count_max: `int`<a id="word_count_max-int"></a>
##### page: `int`<a id="page-int"></a>
##### page_size: `int`<a id="page_size-int"></a>
##### clustering_variable: `str`<a id="clustering_variable-str"></a>
##### clustering_enabled: `bool`<a id="clustering_enabled-bool"></a>
##### clustering_threshold: `Union[int, float]`<a id="clustering_threshold-unionint-float"></a>
##### include_nlp_data: `bool`<a id="include_nlp_data-bool"></a>
##### has_nlp: `bool`<a id="has_nlp-bool"></a>
##### theme: `str`<a id="theme-str"></a>
##### not_theme: `str`<a id="not_theme-str"></a>
##### org_entity_name: `str`<a id="org_entity_name-str"></a>
##### per_entity_name: `str`<a id="per_entity_name-str"></a>
##### loc_entity_name: `str`<a id="loc_entity_name-str"></a>
##### misc_entity_name: `str`<a id="misc_entity_name-str"></a>
##### title_sentiment_min: `Union[int, float]`<a id="title_sentiment_min-unionint-float"></a>
##### title_sentiment_max: `Union[int, float]`<a id="title_sentiment_max-unionint-float"></a>
##### content_sentiment_min: `Union[int, float]`<a id="content_sentiment_min-unionint-float"></a>
##### content_sentiment_max: `Union[int, float]`<a id="content_sentiment_max-unionint-float"></a>
##### iptc_tags: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id="iptc_tags-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy"></a>
##### not_iptc_tags: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id="not_iptc_tags-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy"></a>
##### source_name: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id="source_name-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy"></a>
##### iab_tags: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id="iab_tags-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy"></a>
##### not_iab_tags: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id="not_iab_tags-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy"></a>
##### exclude_duplicates: `bool`<a id="exclude_duplicates-bool"></a>
##### additional_domain_info: `bool`<a id="additional_domain_info-bool"></a>
##### is_news_domain: `bool`<a id="is_news_domain-bool"></a>
##### news_domain_type: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id="news_domain_type-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy"></a>
##### news_type: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id="news_type-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy"></a>
#### 🔄 Return<a id="🔄-return"></a>
[`SearchGetResponse`](./newscatcherapi_client/pydantic/search_get_response.py)
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
`/api/search` `get`
[🔙 **Back to Table of Contents**](#table-of-contents)
---
### `newscatcher.search.post`<a id="newscatchersearchpost"></a>
This endpoint allows you to search for articles. You can search for articles by keyword, language, country, source, and more.
#### 🛠️ Usage<a id="🛠️-usage"></a>
```python
post_response = newscatcher.search.post(
q="string_example",
search_in="title_content",
predefined_sources=None,
sources=None,
not_sources=None,
lang=None,
not_lang=None,
countries=None,
not_countries=None,
not_author_name=None,
from_="string_example",
to_="string_example",
published_date_precision="string_example",
by_parse_date=False,
sort_by="relevancy",
ranked_only="string_example",
from_rank=1,
to_rank=1,
is_headline=True,
is_opinion=True,
is_paid_content=True,
parent_url=None,
all_links=None,
all_domain_links=None,
word_count_min=0,
word_count_max=0,
page=1,
page_size=100,
clustering_variable="string_example",
clustering_enabled=True,
clustering_threshold=3.14,
include_nlp_data=True,
has_nlp=True,
theme="string_example",
not_theme="string_example",
org_entity_name="string_example",
per_entity_name="string_example",
loc_entity_name="string_example",
misc_entity_name="string_example",
title_sentiment_min=3.14,
title_sentiment_max=3.14,
content_sentiment_min=3.14,
content_sentiment_max=3.14,
iptc_tags=None,
not_iptc_tags=None,
source_name=None,
iab_tags=None,
not_iab_tags=None,
exclude_duplicates=True,
additional_domain_info=True,
is_news_domain=True,
news_domain_type=None,
news_type=None,
)
```
#### ⚙️ Parameters<a id="⚙️-parameters"></a>
##### q: `str`<a id="q-str"></a>
##### search_in: `str`<a id="search_in-str"></a>
##### predefined_sources: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id="predefined_sources-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy"></a>
##### sources: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id="sources-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy"></a>
##### not_sources: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id="not_sources-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy"></a>
##### lang: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id="lang-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy"></a>
##### not_lang: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id="not_lang-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy"></a>
##### countries: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id="countries-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy"></a>
##### not_countries: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id="not_countries-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy"></a>
##### not_author_name: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id="not_author_name-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy"></a>
##### from_: Union[`str`, `datetime`]<a id="from_-unionstr-datetime"></a>
##### to_: Union[`str`, `datetime`]<a id="to_-unionstr-datetime"></a>
##### published_date_precision: `str`<a id="published_date_precision-str"></a>
##### by_parse_date: `bool`<a id="by_parse_date-bool"></a>
##### sort_by: `str`<a id="sort_by-str"></a>
##### ranked_only: Union[`str`, `bool`]<a id="ranked_only-unionstr-bool"></a>
##### from_rank: `int`<a id="from_rank-int"></a>
##### to_rank: `int`<a id="to_rank-int"></a>
##### is_headline: `bool`<a id="is_headline-bool"></a>
##### is_opinion: `bool`<a id="is_opinion-bool"></a>
##### is_paid_content: `bool`<a id="is_paid_content-bool"></a>
##### parent_url: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id="parent_url-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy"></a>
##### all_links: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id="all_links-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy"></a>
##### all_domain_links: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id="all_domain_links-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy"></a>
##### word_count_min: `int`<a id="word_count_min-int"></a>
##### word_count_max: `int`<a id="word_count_max-int"></a>
##### page: `int`<a id="page-int"></a>
##### page_size: `int`<a id="page_size-int"></a>
##### clustering_variable: `str`<a id="clustering_variable-str"></a>
##### clustering_enabled: `bool`<a id="clustering_enabled-bool"></a>
##### clustering_threshold: `Union[int, float]`<a id="clustering_threshold-unionint-float"></a>
##### include_nlp_data: `bool`<a id="include_nlp_data-bool"></a>
##### has_nlp: `bool`<a id="has_nlp-bool"></a>
##### theme: `str`<a id="theme-str"></a>
##### not_theme: `str`<a id="not_theme-str"></a>
##### org_entity_name: `str`<a id="org_entity_name-str"></a>
##### per_entity_name: `str`<a id="per_entity_name-str"></a>
##### loc_entity_name: `str`<a id="loc_entity_name-str"></a>
##### misc_entity_name: `str`<a id="misc_entity_name-str"></a>
##### title_sentiment_min: `Union[int, float]`<a id="title_sentiment_min-unionint-float"></a>
##### title_sentiment_max: `Union[int, float]`<a id="title_sentiment_max-unionint-float"></a>
##### content_sentiment_min: `Union[int, float]`<a id="content_sentiment_min-unionint-float"></a>
##### content_sentiment_max: `Union[int, float]`<a id="content_sentiment_max-unionint-float"></a>
##### iptc_tags: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id="iptc_tags-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy"></a>
##### not_iptc_tags: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id="not_iptc_tags-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy"></a>
##### source_name: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id="source_name-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy"></a>
##### iab_tags: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id="iab_tags-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy"></a>
##### not_iab_tags: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id="not_iab_tags-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy"></a>
##### exclude_duplicates: `bool`<a id="exclude_duplicates-bool"></a>
##### additional_domain_info: `bool`<a id="additional_domain_info-bool"></a>
##### is_news_domain: `bool`<a id="is_news_domain-bool"></a>
##### news_domain_type: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id="news_domain_type-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy"></a>
##### news_type: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id="news_type-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy"></a>
#### ⚙️ Request Body<a id="⚙️-request-body"></a>
[`SearchRequest`](./newscatcherapi_client/type/search_request.py)
#### 🔄 Return<a id="🔄-return"></a>
[`SearchPostResponse`](./newscatcherapi_client/pydantic/search_post_response.py)
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
`/api/search` `post`
[🔙 **Back to Table of Contents**](#table-of-contents)
---
### `newscatcher.search_link.get`<a id="newscatchersearch_linkget"></a>
This endpoint allows you to search for articles. You can search for articles by id(s) or link(s).
#### 🛠️ Usage<a id="🛠️-usage"></a>
```python
get_response = newscatcher.search_link.get(
ids=None,
links=None,
from_="string_example",
to_="string_example",
page=1,
page_size=100,
)
```
#### ⚙️ Parameters<a id="⚙️-parameters"></a>
##### ids: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id="ids-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy"></a>
##### links: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id="links-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy"></a>
##### from_: Union[`str`, `datetime`]<a id="from_-unionstr-datetime"></a>
##### to_: Union[`str`, `datetime`]<a id="to_-unionstr-datetime"></a>
##### page: `int`<a id="page-int"></a>
##### page_size: `int`<a id="page_size-int"></a>
#### 🔄 Return<a id="🔄-return"></a>
[`DtoResponsesSearchResponseSearchResponse`](./newscatcherapi_client/pydantic/dto_responses_search_response_search_response.py)
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
`/api/search_by_link` `get`
[🔙 **Back to Table of Contents**](#table-of-contents)
---
### `newscatcher.search_link.post`<a id="newscatchersearch_linkpost"></a>
This endpoint allows you to search for articles. You can search for articles by id(s) or link(s).
#### 🛠️ Usage<a id="🛠️-usage"></a>
```python
post_response = newscatcher.search_link.post(
ids=None,
links=None,
from_="string_example",
to_="string_example",
page=1,
page_size=100,
)
```
#### ⚙️ Parameters<a id="⚙️-parameters"></a>
##### ids: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id="ids-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy"></a>
##### links: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id="links-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy"></a>
##### from_: Union[`str`, `datetime`]<a id="from_-unionstr-datetime"></a>
##### to_: Union[`str`, `datetime`]<a id="to_-unionstr-datetime"></a>
##### page: `int`<a id="page-int"></a>
##### page_size: `int`<a id="page_size-int"></a>
#### ⚙️ Request Body<a id="⚙️-request-body"></a>
[`SearchURLRequest`](./newscatcherapi_client/type/search_url_request.py)
#### 🔄 Return<a id="🔄-return"></a>
[`DtoResponsesSearchResponseSearchResponse`](./newscatcherapi_client/pydantic/dto_responses_search_response_search_response.py)
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
`/api/search_by_link` `post`
[🔙 **Back to Table of Contents**](#table-of-contents)
---
### `newscatcher.search_similar.get`<a id="newscatchersearch_similarget"></a>
This endpoint returns a list of articles that are similar to the query provided. You also have the option to get similar articles for the results of a search.
#### 🛠️ Usage<a id="🛠️-usage"></a>
```python
get_response = newscatcher.search_similar.get(
q="q_example",
search_in="title_content",
include_similar_documents=False,
similar_documents_number=5,
similar_documents_fields="title,content",
predefined_sources=None,
sources=None,
not_sources=None,
lang=None,
not_lang=None,
countries=None,
not_countries=None,
from_="string_example",
to_="string_example",
by_parse_date=False,
published_date_precision="string_example",
sort_by="relevancy",
ranked_only="string_example",
from_rank=1,
to_rank=1,
is_headline=True,
is_opinion=True,
is_paid_content=True,
parent_url=None,
all_links=None,
all_domain_links=None,
word_count_min=0,
word_count_max=0,
page=1,
page_size=100,
include_nlp_data=True,
has_nlp=True,
theme="string_example",
not_theme="string_example",
title_sentiment_min=3.14,
title_sentiment_max=3.14,
content_sentiment_min=3.14,
content_sentiment_max=3.14,
iptc_tags=None,
not_iptc_tags=None,
)
```
#### ⚙️ Parameters<a id="⚙️-parameters"></a>
##### q: `str`<a id="q-str"></a>
##### search_in: `str`<a id="search_in-str"></a>
##### include_similar_documents: `bool`<a id="include_similar_documents-bool"></a>
##### similar_documents_number: `int`<a id="similar_documents_number-int"></a>
##### similar_documents_fields: `str`<a id="similar_documents_fields-str"></a>
##### predefined_sources: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id="predefined_sources-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy"></a>
##### sources: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id="sources-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy"></a>
##### not_sources: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id="not_sources-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy"></a>
##### lang: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id="lang-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy"></a>
##### not_lang: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id="not_lang-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy"></a>
##### countries: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id="countries-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy"></a>
##### not_countries: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id="not_countries-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy"></a>
##### from_: Union[`str`, `datetime`]<a id="from_-unionstr-datetime"></a>
##### to_: Union[`str`, `datetime`]<a id="to_-unionstr-datetime"></a>
##### by_parse_date: `bool`<a id="by_parse_date-bool"></a>
##### published_date_precision: `str`<a id="published_date_precision-str"></a>
##### sort_by: `str`<a id="sort_by-str"></a>
##### ranked_only: Union[`str`, `bool`]<a id="ranked_only-unionstr-bool"></a>
##### from_rank: `int`<a id="from_rank-int"></a>
##### to_rank: `int`<a id="to_rank-int"></a>
##### is_headline: `bool`<a id="is_headline-bool"></a>
##### is_opinion: `bool`<a id="is_opinion-bool"></a>
##### is_paid_content: `bool`<a id="is_paid_content-bool"></a>
##### parent_url: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id="parent_url-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy"></a>
##### all_links: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id="all_links-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy"></a>
##### all_domain_links: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id="all_domain_links-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy"></a>
##### word_count_min: `int`<a id="word_count_min-int"></a>
##### word_count_max: `int`<a id="word_count_max-int"></a>
##### page: `int`<a id="page-int"></a>
##### page_size: `int`<a id="page_size-int"></a>
##### include_nlp_data: `bool`<a id="include_nlp_data-bool"></a>
##### has_nlp: `bool`<a id="has_nlp-bool"></a>
##### theme: `str`<a id="theme-str"></a>
##### not_theme: `str`<a id="not_theme-str"></a>
##### title_sentiment_min: `Union[int, float]`<a id="title_sentiment_min-unionint-float"></a>
##### title_sentiment_max: `Union[int, float]`<a id="title_sentiment_max-unionint-float"></a>
##### content_sentiment_min: `Union[int, float]`<a id="content_sentiment_min-unionint-float"></a>
##### content_sentiment_max: `Union[int, float]`<a id="content_sentiment_max-unionint-float"></a>
##### iptc_tags: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id="iptc_tags-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy"></a>
##### not_iptc_tags: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id="not_iptc_tags-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy"></a>
#### 🔄 Return<a id="🔄-return"></a>
[`SearchSimilarGetResponse`](./newscatcherapi_client/pydantic/search_similar_get_response.py)
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
`/api/search_similar` `get`
[🔙 **Back to Table of Contents**](#table-of-contents)
---
### `newscatcher.search_similar.post`<a id="newscatchersearch_similarpost"></a>
This endpoint returns a list of articles that are similar to the query provided. You also have the option to get similar articles for the results of a search.
#### 🛠️ Usage<a id="🛠️-usage"></a>
```python
post_response = newscatcher.search_similar.post(
q="string_example",
search_in="title_content",
include_similar_documents=False,
similar_documents_number=5,
similar_documents_fields="title,content",
predefined_sources=None,
sources=None,
not_sources=None,
lang=None,
not_lang=None,
countries=None,
not_countries=None,
from_="string_example",
to_="string_example",
by_parse_date=False,
published_date_precision="string_example",
sort_by="relevancy",
ranked_only="string_example",
from_rank=1,
to_rank=1,
is_headline=True,
is_opinion=True,
is_paid_content=True,
parent_url=None,
all_links=None,
all_domain_links=None,
word_count_min=0,
word_count_max=0,
page=1,
page_size=100,
include_nlp_data=True,
has_nlp=True,
theme="string_example",
not_theme="string_example",
title_sentiment_min=3.14,
title_sentiment_max=3.14,
content_sentiment_min=3.14,
content_sentiment_max=3.14,
iptc_tags=None,
not_iptc_tags=None,
)
```
#### ⚙️ Parameters<a id="⚙️-parameters"></a>
##### q: `str`<a id="q-str"></a>
##### search_in: `str`<a id="search_in-str"></a>
##### include_similar_documents: `bool`<a id="include_similar_documents-bool"></a>
##### similar_documents_number: `int`<a id="similar_documents_number-int"></a>
##### similar_documents_fields: `str`<a id="similar_documents_fields-str"></a>
##### predefined_sources: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id="predefined_sources-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy"></a>
##### sources: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id="sources-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy"></a>
##### not_sources: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id="not_sources-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy"></a>
##### lang: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id="lang-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy"></a>
##### not_lang: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id="not_lang-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy"></a>
##### countries: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id="countries-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy"></a>
##### not_countries: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id="not_countries-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy"></a>
##### from_: Union[`str`, `datetime`]<a id="from_-unionstr-datetime"></a>
##### to_: Union[`str`, `datetime`]<a id="to_-unionstr-datetime"></a>
##### by_parse_date: `bool`<a id="by_parse_date-bool"></a>
##### published_date_precision: `str`<a id="published_date_precision-str"></a>
##### sort_by: `str`<a id="sort_by-str"></a>
##### ranked_only: Union[`str`, `bool`]<a id="ranked_only-unionstr-bool"></a>
##### from_rank: `int`<a id="from_rank-int"></a>
##### to_rank: `int`<a id="to_rank-int"></a>
##### is_headline: `bool`<a id="is_headline-bool"></a>
##### is_opinion: `bool`<a id="is_opinion-bool"></a>
##### is_paid_content: `bool`<a id="is_paid_content-bool"></a>
##### parent_url: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id="parent_url-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy"></a>
##### all_links: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id="all_links-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy"></a>
##### all_domain_links: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id="all_domain_links-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy"></a>
##### word_count_min: `int`<a id="word_count_min-int"></a>
##### word_count_max: `int`<a id="word_count_max-int"></a>
##### page: `int`<a id="page-int"></a>
##### page_size: `int`<a id="page_size-int"></a>
##### include_nlp_data: `bool`<a id="include_nlp_data-bool"></a>
##### has_nlp: `bool`<a id="has_nlp-bool"></a>
##### theme: `str`<a id="theme-str"></a>
##### not_theme: `str`<a id="not_theme-str"></a>
##### title_sentiment_min: `Union[int, float]`<a id="title_sentiment_min-unionint-float"></a>
##### title_sentiment_max: `Union[int, float]`<a id="title_sentiment_max-unionint-float"></a>
##### content_sentiment_min: `Union[int, float]`<a id="content_sentiment_min-unionint-float"></a>
##### content_sentiment_max: `Union[int, float]`<a id="content_sentiment_max-unionint-float"></a>
##### iptc_tags: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id="iptc_tags-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy"></a>
##### not_iptc_tags: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id="not_iptc_tags-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy"></a>
#### ⚙️ Request Body<a id="⚙️-request-body"></a>
[`MoreLikeThisRequest`](./newscatcherapi_client/type/more_like_this_request.py)
#### 🔄 Return<a id="🔄-return"></a>
[`SearchSimilarPostResponse`](./newscatcherapi_client/pydantic/search_similar_post_response.py)
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
`/api/search_similar` `post`
[🔙 **Back to Table of Contents**](#table-of-contents)
---
### `newscatcher.sources.get`<a id="newscatchersourcesget"></a>
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
#### 🛠️ Usage<a id="🛠️-usage"></a>
```python
get_response = newscatcher.sources.get(
lang=None,
countries=None,
predefined_sources=None,
include_additional_info=True,
from_rank=1,
to_rank=1,
source_name=None,
source_url=None,
is_news_domain=True,
news_domain_type=None,
news_type=None,
)
```
#### ⚙️ Parameters<a id="⚙️-parameters"></a>
##### lang: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id="lang-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy"></a>
##### countries: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id="countries-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy"></a>
##### predefined_sources: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id="predefined_sources-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy"></a>
##### include_additional_info: `bool`<a id="include_additional_info-bool"></a>
##### from_rank: `int`<a id="from_rank-int"></a>
##### to_rank: `int`<a id="to_rank-int"></a>
##### source_name: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id="source_name-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy"></a>
##### source_url: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id="source_url-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy"></a>
##### is_news_domain: `bool`<a id="is_news_domain-bool"></a>
##### news_domain_type: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id="news_domain_type-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy"></a>
##### news_type: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id="news_type-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy"></a>
#### 🔄 Return<a id="🔄-return"></a>
[`SourceResponse`](./newscatcherapi_client/pydantic/source_response.py)
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
`/api/sources` `get`
[🔙 **Back to Table of Contents**](#table-of-contents)
---
### `newscatcher.sources.post`<a id="newscatchersourcespost"></a>
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
#### 🛠️ Usage<a id="🛠️-usage"></a>
```python
post_response = newscatcher.sources.post(
lang=None,
countries=None,
predefined_sources=None,
include_additional_info=True,
from_rank=1,
to_rank=1,
source_name=None,
source_url=None,
is_news_domain=True,
news_domain_type=None,
news_type=None,
)
```
#### ⚙️ Parameters<a id="⚙️-parameters"></a>
##### lang: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id="lang-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy"></a>
##### countries: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id="countries-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy"></a>
##### predefined_sources: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id="predefined_sources-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy"></a>
##### include_additional_info: `bool`<a id="include_additional_info-bool"></a>
##### from_rank: `int`<a id="from_rank-int"></a>
##### to_rank: `int`<a id="to_rank-int"></a>
##### source_name: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id="source_name-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy"></a>
##### source_url: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id="source_url-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy"></a>
##### is_news_domain: `bool`<a id="is_news_domain-bool"></a>
##### news_domain_type: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id="news_domain_type-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy"></a>
##### news_type: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id="news_type-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy"></a>
#### ⚙️ Request Body<a id="⚙️-request-body"></a>
[`SourcesRequest`](./newscatcherapi_client/type/sources_request.py)
#### 🔄 Return<a id="🔄-return"></a>
[`SourceResponse`](./newscatcherapi_client/pydantic/source_response.py)
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
`/api/sources` `post`
[🔙 **Back to Table of Contents**](#table-of-contents)
---
### `newscatcher.subscription.get`<a id="newscatchersubscriptionget"></a>
This endpoint allows you to get info about your subscription plan.
#### 🛠️ Usage<a id="🛠️-usage"></a>
```python
get_response = newscatcher.subscription.get()
```
#### 🔄 Return<a id="🔄-return"></a>
[`SubscriptionResponse`](./newscatcherapi_client/pydantic/subscription_response.py)
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
`/api/subscription` `get`
[🔙 **Back to Table of Contents**](#table-of-contents)
---
### `newscatcher.subscription.post`<a id="newscatchersubscriptionpost"></a>
This endpoint allows you to get info about your subscription plan.
#### 🛠️ Usage<a id="🛠️-usage"></a>
```python
post_response = newscatcher.subscription.post()
```
#### 🔄 Return<a id="🔄-return"></a>
[`SubscriptionResponse`](./newscatcherapi_client/pydantic/subscription_response.py)
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
`/api/subscription` `post`
[🔙 **Back to Table of Contents**](#table-of-contents)
---
## Author<a id="author"></a>
This Python package is automatically generated by [Konfig](https://konfigthis.com)
Raw data
{
"_id": null,
"home_page": null,
"name": "newscatcherapi-python-sdk",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.7",
"maintainer_email": null,
"keywords": null,
"author": "Maksym Sugonyaka",
"author_email": "maksym@newscatcherapi.com",
"download_url": "https://files.pythonhosted.org/packages/a1/d3/7324d056d6c192252bb92e2483df108799f9a6d6182f56239d45fe0b3989/newscatcherapi_python_sdk-6.0.13.tar.gz",
"platform": null,
"description": "# newscatcherapi-python-sdk<a id=\"newscatcherapi-python-sdk\"></a>\n\n<img src='https://uploads-ssl.webflow.com/6429857b17973b636c2195c5/646c6f1eb774ff2f2997bec5_newscatcher_.svg' width='286' height='35' /> <br> <br>Visit our website <a href='https://newscatcherapi.com'>https://newscatcherapi.com</a>\n\n\n[](https://pypi.org/project/newscatcherapi-python-sdk/6.0.13)\n[](https://github.com/konfig-dev/newscatcher-sdks/tree/main/v3/python#readme)\n\n## Table of Contents<a id=\"table-of-contents\"></a>\n\n<!-- toc -->\n\n- [Requirements](#requirements)\n- [Installation](#installation)\n- [Getting Started](#getting-started)\n- [Async](#async)\n- [Raw HTTP Response](#raw-http-response)\n- [Reference](#reference)\n * [`newscatcher.authors.get`](#newscatcherauthorsget)\n * [`newscatcher.authors.post`](#newscatcherauthorspost)\n * [`newscatcher.latest_headlines.get`](#newscatcherlatest_headlinesget)\n * [`newscatcher.latest_headlines.post`](#newscatcherlatest_headlinespost)\n * [`newscatcher.search.get`](#newscatchersearchget)\n * [`newscatcher.search.post`](#newscatchersearchpost)\n * [`newscatcher.search_link.get`](#newscatchersearch_linkget)\n * [`newscatcher.search_link.post`](#newscatchersearch_linkpost)\n * [`newscatcher.search_similar.get`](#newscatchersearch_similarget)\n * [`newscatcher.search_similar.post`](#newscatchersearch_similarpost)\n * [`newscatcher.sources.get`](#newscatchersourcesget)\n * [`newscatcher.sources.post`](#newscatchersourcespost)\n * [`newscatcher.subscription.get`](#newscatchersubscriptionget)\n * [`newscatcher.subscription.post`](#newscatchersubscriptionpost)\n\n<!-- tocstop -->\n\n## Requirements<a id=\"requirements\"></a>\n\nPython >=3.7\n\n## Installation<a id=\"installation\"></a>\n\n```sh\npip install newscatcherapi-python-sdk==6.0.13\n```\n\n## Getting Started<a id=\"getting-started\"></a>\n\n```python\nfrom pprint import pprint\nfrom newscatcherapi_client import Newscatcher, ApiException\n\nnewscatcher = Newscatcher(\n api_key=\"YOUR_API_KEY\",\n)\n\ntry:\n # [Get] Search By Author Request\n get_response = newscatcher.authors.get(\n author_name=\"author_name_example\",\n not_author_name=\"string_example\",\n sources=None,\n predefined_sources=None,\n not_sources=None,\n lang=None,\n not_lang=None,\n countries=None,\n not_countries=None,\n from_=\"string_example\",\n to_=\"string_example\",\n published_date_precision=\"string_example\",\n by_parse_date=False,\n sort_by=\"relevancy\",\n ranked_only=\"string_example\",\n from_rank=1,\n to_rank=1,\n is_headline=True,\n is_opinion=True,\n is_paid_content=True,\n parent_url=None,\n all_links=None,\n all_domain_links=None,\n word_count_min=0,\n word_count_max=0,\n page=1,\n page_size=100,\n include_nlp_data=True,\n has_nlp=True,\n theme=\"string_example\",\n not_theme=\"string_example\",\n title_sentiment_min=3.14,\n title_sentiment_max=3.14,\n content_sentiment_min=3.14,\n content_sentiment_max=3.14,\n iptc_tags=None,\n not_iptc_tags=None,\n iab_tags=None,\n not_iab_tags=None,\n )\n print(get_response)\nexcept ApiException as e:\n print(\"Exception when calling AuthorsApi.get: %s\\n\" % e)\n pprint(e.body)\n if e.status == 422:\n pprint(e.body[\"detail\"])\n pprint(e.headers)\n pprint(e.status)\n pprint(e.reason)\n pprint(e.round_trip_time)\n```\n\n## Async<a id=\"async\"></a>\n\n`async` support is available by prepending `a` to any method.\n\n```python\nimport asyncio\nfrom pprint import pprint\nfrom newscatcherapi_client import Newscatcher, ApiException\n\nnewscatcher = Newscatcher(\n api_key=\"YOUR_API_KEY\",\n)\n\n\nasync def main():\n try:\n # [Get] Search By Author Request\n get_response = await newscatcher.authors.aget(\n author_name=\"author_name_example\",\n not_author_name=\"string_example\",\n sources=None,\n predefined_sources=None,\n not_sources=None,\n lang=None,\n not_lang=None,\n countries=None,\n not_countries=None,\n from_=\"string_example\",\n to_=\"string_example\",\n published_date_precision=\"string_example\",\n by_parse_date=False,\n sort_by=\"relevancy\",\n ranked_only=\"string_example\",\n from_rank=1,\n to_rank=1,\n is_headline=True,\n is_opinion=True,\n is_paid_content=True,\n parent_url=None,\n all_links=None,\n all_domain_links=None,\n word_count_min=0,\n word_count_max=0,\n page=1,\n page_size=100,\n include_nlp_data=True,\n has_nlp=True,\n theme=\"string_example\",\n not_theme=\"string_example\",\n title_sentiment_min=3.14,\n title_sentiment_max=3.14,\n content_sentiment_min=3.14,\n content_sentiment_max=3.14,\n iptc_tags=None,\n not_iptc_tags=None,\n iab_tags=None,\n not_iab_tags=None,\n )\n print(get_response)\n except ApiException as e:\n print(\"Exception when calling AuthorsApi.get: %s\\n\" % e)\n pprint(e.body)\n if e.status == 422:\n pprint(e.body[\"detail\"])\n pprint(e.headers)\n pprint(e.status)\n pprint(e.reason)\n pprint(e.round_trip_time)\n\n\nasyncio.run(main())\n```\n\n## Raw HTTP Response<a id=\"raw-http-response\"></a>\n\nTo access raw HTTP response values, use the `.raw` namespace.\n\n```python\nfrom pprint import pprint\nfrom newscatcherapi_client import Newscatcher, ApiException\n\nnewscatcher = Newscatcher(\n api_key=\"YOUR_API_KEY\",\n)\n\ntry:\n # [Get] Search By Author Request\n get_response = newscatcher.authors.raw.get(\n author_name=\"author_name_example\",\n not_author_name=\"string_example\",\n sources=None,\n predefined_sources=None,\n not_sources=None,\n lang=None,\n not_lang=None,\n countries=None,\n not_countries=None,\n from_=\"string_example\",\n to_=\"string_example\",\n published_date_precision=\"string_example\",\n by_parse_date=False,\n sort_by=\"relevancy\",\n ranked_only=\"string_example\",\n from_rank=1,\n to_rank=1,\n is_headline=True,\n is_opinion=True,\n is_paid_content=True,\n parent_url=None,\n all_links=None,\n all_domain_links=None,\n word_count_min=0,\n word_count_max=0,\n page=1,\n page_size=100,\n include_nlp_data=True,\n has_nlp=True,\n theme=\"string_example\",\n not_theme=\"string_example\",\n title_sentiment_min=3.14,\n title_sentiment_max=3.14,\n content_sentiment_min=3.14,\n content_sentiment_max=3.14,\n iptc_tags=None,\n not_iptc_tags=None,\n iab_tags=None,\n not_iab_tags=None,\n )\n pprint(get_response.body)\n pprint(get_response.headers)\n pprint(get_response.status)\n pprint(get_response.round_trip_time)\nexcept ApiException as e:\n print(\"Exception when calling AuthorsApi.get: %s\\n\" % e)\n pprint(e.body)\n if e.status == 422:\n pprint(e.body[\"detail\"])\n pprint(e.headers)\n pprint(e.status)\n pprint(e.reason)\n pprint(e.round_trip_time)\n```\n\n\n## Reference<a id=\"reference\"></a>\n### `newscatcher.authors.get`<a id=\"newscatcherauthorsget\"></a>\n\nThis endpoint allows you to search for articles by author. You need to specify the author name. You can also filter by language, country, source, and more.\n\n#### \ud83d\udee0\ufe0f Usage<a id=\"\ud83d\udee0\ufe0f-usage\"></a>\n\n```python\nget_response = newscatcher.authors.get(\n author_name=\"author_name_example\",\n not_author_name=\"string_example\",\n sources=None,\n predefined_sources=None,\n not_sources=None,\n lang=None,\n not_lang=None,\n countries=None,\n not_countries=None,\n from_=\"string_example\",\n to_=\"string_example\",\n published_date_precision=\"string_example\",\n by_parse_date=False,\n sort_by=\"relevancy\",\n ranked_only=\"string_example\",\n from_rank=1,\n to_rank=1,\n is_headline=True,\n is_opinion=True,\n is_paid_content=True,\n parent_url=None,\n all_links=None,\n all_domain_links=None,\n word_count_min=0,\n word_count_max=0,\n page=1,\n page_size=100,\n include_nlp_data=True,\n has_nlp=True,\n theme=\"string_example\",\n not_theme=\"string_example\",\n title_sentiment_min=3.14,\n title_sentiment_max=3.14,\n content_sentiment_min=3.14,\n content_sentiment_max=3.14,\n iptc_tags=None,\n not_iptc_tags=None,\n iab_tags=None,\n not_iab_tags=None,\n)\n```\n\n#### \u2699\ufe0f Parameters<a id=\"\u2699\ufe0f-parameters\"></a>\n\n##### author_name: `str`<a id=\"author_name-str\"></a>\n\n##### not_author_name: `str`<a id=\"not_author_name-str\"></a>\n\n##### sources: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id=\"sources-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy\"></a>\n\n##### predefined_sources: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id=\"predefined_sources-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy\"></a>\n\n##### not_sources: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id=\"not_sources-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy\"></a>\n\n##### lang: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id=\"lang-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy\"></a>\n\n##### not_lang: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id=\"not_lang-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy\"></a>\n\n##### countries: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id=\"countries-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy\"></a>\n\n##### not_countries: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id=\"not_countries-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy\"></a>\n\n##### from_: Union[`str`, `datetime`]<a id=\"from_-unionstr-datetime\"></a>\n\n\n##### to_: Union[`str`, `datetime`]<a id=\"to_-unionstr-datetime\"></a>\n\n\n##### published_date_precision: `str`<a id=\"published_date_precision-str\"></a>\n\n##### by_parse_date: `bool`<a id=\"by_parse_date-bool\"></a>\n\n##### sort_by: `str`<a id=\"sort_by-str\"></a>\n\n##### ranked_only: Union[`str`, `bool`]<a id=\"ranked_only-unionstr-bool\"></a>\n\n\n##### from_rank: `int`<a id=\"from_rank-int\"></a>\n\n##### to_rank: `int`<a id=\"to_rank-int\"></a>\n\n##### is_headline: `bool`<a id=\"is_headline-bool\"></a>\n\n##### is_opinion: `bool`<a id=\"is_opinion-bool\"></a>\n\n##### is_paid_content: `bool`<a id=\"is_paid_content-bool\"></a>\n\n##### parent_url: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id=\"parent_url-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy\"></a>\n\n##### all_links: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id=\"all_links-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy\"></a>\n\n##### all_domain_links: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id=\"all_domain_links-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy\"></a>\n\n##### word_count_min: `int`<a id=\"word_count_min-int\"></a>\n\n##### word_count_max: `int`<a id=\"word_count_max-int\"></a>\n\n##### page: `int`<a id=\"page-int\"></a>\n\n##### page_size: `int`<a id=\"page_size-int\"></a>\n\n##### include_nlp_data: `bool`<a id=\"include_nlp_data-bool\"></a>\n\n##### has_nlp: `bool`<a id=\"has_nlp-bool\"></a>\n\n##### theme: `str`<a id=\"theme-str\"></a>\n\n##### not_theme: `str`<a id=\"not_theme-str\"></a>\n\n##### title_sentiment_min: `Union[int, float]`<a id=\"title_sentiment_min-unionint-float\"></a>\n\n##### title_sentiment_max: `Union[int, float]`<a id=\"title_sentiment_max-unionint-float\"></a>\n\n##### content_sentiment_min: `Union[int, float]`<a id=\"content_sentiment_min-unionint-float\"></a>\n\n##### content_sentiment_max: `Union[int, float]`<a id=\"content_sentiment_max-unionint-float\"></a>\n\n##### iptc_tags: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id=\"iptc_tags-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy\"></a>\n\n##### not_iptc_tags: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id=\"not_iptc_tags-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy\"></a>\n\n##### iab_tags: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id=\"iab_tags-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy\"></a>\n\n##### not_iab_tags: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id=\"not_iab_tags-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy\"></a>\n\n#### \ud83d\udd04 Return<a id=\"\ud83d\udd04-return\"></a>\n\n[`AuthorsGetResponse`](./newscatcherapi_client/pydantic/authors_get_response.py)\n\n#### \ud83c\udf10 Endpoint<a id=\"\ud83c\udf10-endpoint\"></a>\n\n`/api/authors` `get`\n\n[\ud83d\udd19 **Back to Table of Contents**](#table-of-contents)\n\n---\n\n### `newscatcher.authors.post`<a id=\"newscatcherauthorspost\"></a>\n\nThis endpoint allows you to search for articles by author. You need to specify the author name. You can also filter by language, country, source, and more.\n\n#### \ud83d\udee0\ufe0f Usage<a id=\"\ud83d\udee0\ufe0f-usage\"></a>\n\n```python\npost_response = newscatcher.authors.post(\n author_name=\"string_example\",\n not_author_name=\"string_example\",\n sources=None,\n predefined_sources=None,\n not_sources=None,\n lang=None,\n not_lang=None,\n countries=None,\n not_countries=None,\n from_=\"string_example\",\n to_=\"string_example\",\n published_date_precision=\"string_example\",\n by_parse_date=False,\n sort_by=\"relevancy\",\n ranked_only=\"string_example\",\n from_rank=1,\n to_rank=1,\n is_headline=True,\n is_opinion=True,\n is_paid_content=True,\n parent_url=None,\n all_links=None,\n all_domain_links=None,\n word_count_min=0,\n word_count_max=0,\n page=1,\n page_size=100,\n include_nlp_data=True,\n has_nlp=True,\n theme=\"string_example\",\n not_theme=\"string_example\",\n title_sentiment_min=3.14,\n title_sentiment_max=3.14,\n content_sentiment_min=3.14,\n content_sentiment_max=3.14,\n iptc_tags=None,\n not_iptc_tags=None,\n iab_tags=None,\n not_iab_tags=None,\n)\n```\n\n#### \u2699\ufe0f Parameters<a id=\"\u2699\ufe0f-parameters\"></a>\n\n##### author_name: `str`<a id=\"author_name-str\"></a>\n\n##### not_author_name: `str`<a id=\"not_author_name-str\"></a>\n\n##### sources: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id=\"sources-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy\"></a>\n\n##### predefined_sources: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id=\"predefined_sources-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy\"></a>\n\n##### not_sources: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id=\"not_sources-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy\"></a>\n\n##### lang: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id=\"lang-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy\"></a>\n\n##### not_lang: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id=\"not_lang-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy\"></a>\n\n##### countries: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id=\"countries-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy\"></a>\n\n##### not_countries: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id=\"not_countries-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy\"></a>\n\n##### from_: Union[`str`, `datetime`]<a id=\"from_-unionstr-datetime\"></a>\n\n\n##### to_: Union[`str`, `datetime`]<a id=\"to_-unionstr-datetime\"></a>\n\n\n##### published_date_precision: `str`<a id=\"published_date_precision-str\"></a>\n\n##### by_parse_date: `bool`<a id=\"by_parse_date-bool\"></a>\n\n##### sort_by: `str`<a id=\"sort_by-str\"></a>\n\n##### ranked_only: Union[`str`, `bool`]<a id=\"ranked_only-unionstr-bool\"></a>\n\n\n##### from_rank: `int`<a id=\"from_rank-int\"></a>\n\n##### to_rank: `int`<a id=\"to_rank-int\"></a>\n\n##### is_headline: `bool`<a id=\"is_headline-bool\"></a>\n\n##### is_opinion: `bool`<a id=\"is_opinion-bool\"></a>\n\n##### is_paid_content: `bool`<a id=\"is_paid_content-bool\"></a>\n\n##### parent_url: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id=\"parent_url-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy\"></a>\n\n##### all_links: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id=\"all_links-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy\"></a>\n\n##### all_domain_links: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id=\"all_domain_links-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy\"></a>\n\n##### word_count_min: `int`<a id=\"word_count_min-int\"></a>\n\n##### word_count_max: `int`<a id=\"word_count_max-int\"></a>\n\n##### page: `int`<a id=\"page-int\"></a>\n\n##### page_size: `int`<a id=\"page_size-int\"></a>\n\n##### include_nlp_data: `bool`<a id=\"include_nlp_data-bool\"></a>\n\n##### has_nlp: `bool`<a id=\"has_nlp-bool\"></a>\n\n##### theme: `str`<a id=\"theme-str\"></a>\n\n##### not_theme: `str`<a id=\"not_theme-str\"></a>\n\n##### title_sentiment_min: `Union[int, float]`<a id=\"title_sentiment_min-unionint-float\"></a>\n\n##### title_sentiment_max: `Union[int, float]`<a id=\"title_sentiment_max-unionint-float\"></a>\n\n##### content_sentiment_min: `Union[int, float]`<a id=\"content_sentiment_min-unionint-float\"></a>\n\n##### content_sentiment_max: `Union[int, float]`<a id=\"content_sentiment_max-unionint-float\"></a>\n\n##### iptc_tags: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id=\"iptc_tags-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy\"></a>\n\n##### not_iptc_tags: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id=\"not_iptc_tags-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy\"></a>\n\n##### iab_tags: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id=\"iab_tags-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy\"></a>\n\n##### not_iab_tags: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id=\"not_iab_tags-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy\"></a>\n\n#### \u2699\ufe0f Request Body<a id=\"\u2699\ufe0f-request-body\"></a>\n\n[`AuthorSearchRequest`](./newscatcherapi_client/type/author_search_request.py)\n#### \ud83d\udd04 Return<a id=\"\ud83d\udd04-return\"></a>\n\n[`AuthorsPostResponse`](./newscatcherapi_client/pydantic/authors_post_response.py)\n\n#### \ud83c\udf10 Endpoint<a id=\"\ud83c\udf10-endpoint\"></a>\n\n`/api/authors` `post`\n\n[\ud83d\udd19 **Back to Table of Contents**](#table-of-contents)\n\n---\n\n### `newscatcher.latest_headlines.get`<a id=\"newscatcherlatest_headlinesget\"></a>\n\nThis endpoint allows you to get latest headlines. You need to specify since when you want to get the latest headlines. You can also filter by language, country, source, and more.\n\n#### \ud83d\udee0\ufe0f Usage<a id=\"\ud83d\udee0\ufe0f-usage\"></a>\n\n```python\nget_response = newscatcher.latest_headlines.get(\n when=\"7d\",\n by_parse_date=False,\n sort_by=\"relevancy\",\n lang=None,\n not_lang=None,\n countries=None,\n not_countries=None,\n sources=None,\n predefined_sources=None,\n not_sources=None,\n not_author_name=None,\n ranked_only=\"string_example\",\n is_headline=True,\n is_opinion=True,\n is_paid_content=True,\n parent_url=None,\n all_links=None,\n all_domain_links=None,\n word_count_min=0,\n word_count_max=0,\n page=1,\n page_size=100,\n clustering_variable=\"string_example\",\n clustering_enabled=True,\n clustering_threshold=3.14,\n include_nlp_data=True,\n has_nlp=True,\n theme=\"string_example\",\n not_theme=\"string_example\",\n org_entity_name=\"string_example\",\n per_entity_name=\"string_example\",\n loc_entity_name=\"string_example\",\n misc_entity_name=\"string_example\",\n title_sentiment_min=3.14,\n title_sentiment_max=3.14,\n content_sentiment_min=3.14,\n content_sentiment_max=3.14,\n iptc_tags=None,\n not_iptc_tags=None,\n iab_tags=None,\n not_iab_tags=None,\n)\n```\n\n#### \u2699\ufe0f Parameters<a id=\"\u2699\ufe0f-parameters\"></a>\n\n##### when: `str`<a id=\"when-str\"></a>\n\n##### by_parse_date: `bool`<a id=\"by_parse_date-bool\"></a>\n\n##### sort_by: `str`<a id=\"sort_by-str\"></a>\n\n##### lang: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id=\"lang-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy\"></a>\n\n##### not_lang: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id=\"not_lang-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy\"></a>\n\n##### countries: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id=\"countries-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy\"></a>\n\n##### not_countries: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id=\"not_countries-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy\"></a>\n\n##### sources: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id=\"sources-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy\"></a>\n\n##### predefined_sources: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id=\"predefined_sources-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy\"></a>\n\n##### not_sources: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id=\"not_sources-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy\"></a>\n\n##### not_author_name: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id=\"not_author_name-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy\"></a>\n\n##### ranked_only: Union[`str`, `bool`]<a id=\"ranked_only-unionstr-bool\"></a>\n\n\n##### is_headline: `bool`<a id=\"is_headline-bool\"></a>\n\n##### is_opinion: `bool`<a id=\"is_opinion-bool\"></a>\n\n##### is_paid_content: `bool`<a id=\"is_paid_content-bool\"></a>\n\n##### parent_url: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id=\"parent_url-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy\"></a>\n\n##### all_links: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id=\"all_links-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy\"></a>\n\n##### all_domain_links: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id=\"all_domain_links-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy\"></a>\n\n##### word_count_min: `int`<a id=\"word_count_min-int\"></a>\n\n##### word_count_max: `int`<a id=\"word_count_max-int\"></a>\n\n##### page: `int`<a id=\"page-int\"></a>\n\n##### page_size: `int`<a id=\"page_size-int\"></a>\n\n##### clustering_variable: `str`<a id=\"clustering_variable-str\"></a>\n\n##### clustering_enabled: `bool`<a id=\"clustering_enabled-bool\"></a>\n\n##### clustering_threshold: `Union[int, float]`<a id=\"clustering_threshold-unionint-float\"></a>\n\n##### include_nlp_data: `bool`<a id=\"include_nlp_data-bool\"></a>\n\n##### has_nlp: `bool`<a id=\"has_nlp-bool\"></a>\n\n##### theme: `str`<a id=\"theme-str\"></a>\n\n##### not_theme: `str`<a id=\"not_theme-str\"></a>\n\n##### org_entity_name: `str`<a id=\"org_entity_name-str\"></a>\n\n##### per_entity_name: `str`<a id=\"per_entity_name-str\"></a>\n\n##### loc_entity_name: `str`<a id=\"loc_entity_name-str\"></a>\n\n##### misc_entity_name: `str`<a id=\"misc_entity_name-str\"></a>\n\n##### title_sentiment_min: `Union[int, float]`<a id=\"title_sentiment_min-unionint-float\"></a>\n\n##### title_sentiment_max: `Union[int, float]`<a id=\"title_sentiment_max-unionint-float\"></a>\n\n##### content_sentiment_min: `Union[int, float]`<a id=\"content_sentiment_min-unionint-float\"></a>\n\n##### content_sentiment_max: `Union[int, float]`<a id=\"content_sentiment_max-unionint-float\"></a>\n\n##### iptc_tags: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id=\"iptc_tags-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy\"></a>\n\n##### not_iptc_tags: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id=\"not_iptc_tags-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy\"></a>\n\n##### iab_tags: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id=\"iab_tags-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy\"></a>\n\n##### not_iab_tags: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id=\"not_iab_tags-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy\"></a>\n\n#### \ud83d\udd04 Return<a id=\"\ud83d\udd04-return\"></a>\n\n[`LatestHeadlinesGetResponse`](./newscatcherapi_client/pydantic/latest_headlines_get_response.py)\n\n#### \ud83c\udf10 Endpoint<a id=\"\ud83c\udf10-endpoint\"></a>\n\n`/api/latest_headlines` `get`\n\n[\ud83d\udd19 **Back to Table of Contents**](#table-of-contents)\n\n---\n\n### `newscatcher.latest_headlines.post`<a id=\"newscatcherlatest_headlinespost\"></a>\n\nThis endpoint allows you to get latest headlines. You need to specify since when you want to get the latest headlines. You can also filter by language, country, source, and more.\n\n#### \ud83d\udee0\ufe0f Usage<a id=\"\ud83d\udee0\ufe0f-usage\"></a>\n\n```python\npost_response = newscatcher.latest_headlines.post(\n when=\"7d\",\n by_parse_date=False,\n sort_by=\"relevancy\",\n lang=None,\n not_lang=None,\n countries=None,\n not_countries=None,\n sources=None,\n predefined_sources=None,\n not_sources=None,\n not_author_name=None,\n ranked_only=\"string_example\",\n is_headline=True,\n is_opinion=True,\n is_paid_content=True,\n parent_url=None,\n all_links=None,\n all_domain_links=None,\n word_count_min=0,\n word_count_max=0,\n page=1,\n page_size=100,\n clustering_variable=\"string_example\",\n clustering_enabled=True,\n clustering_threshold=3.14,\n include_nlp_data=True,\n has_nlp=True,\n theme=\"string_example\",\n not_theme=\"string_example\",\n org_entity_name=\"string_example\",\n per_entity_name=\"string_example\",\n loc_entity_name=\"string_example\",\n misc_entity_name=\"string_example\",\n title_sentiment_min=3.14,\n title_sentiment_max=3.14,\n content_sentiment_min=3.14,\n content_sentiment_max=3.14,\n iptc_tags=None,\n not_iptc_tags=None,\n iab_tags=None,\n not_iab_tags=None,\n)\n```\n\n#### \u2699\ufe0f Parameters<a id=\"\u2699\ufe0f-parameters\"></a>\n\n##### when: `str`<a id=\"when-str\"></a>\n\n##### by_parse_date: `bool`<a id=\"by_parse_date-bool\"></a>\n\n##### sort_by: `str`<a id=\"sort_by-str\"></a>\n\n##### lang: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id=\"lang-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy\"></a>\n\n##### not_lang: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id=\"not_lang-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy\"></a>\n\n##### countries: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id=\"countries-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy\"></a>\n\n##### not_countries: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id=\"not_countries-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy\"></a>\n\n##### sources: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id=\"sources-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy\"></a>\n\n##### predefined_sources: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id=\"predefined_sources-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy\"></a>\n\n##### not_sources: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id=\"not_sources-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy\"></a>\n\n##### not_author_name: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id=\"not_author_name-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy\"></a>\n\n##### ranked_only: Union[`str`, `bool`]<a id=\"ranked_only-unionstr-bool\"></a>\n\n\n##### is_headline: `bool`<a id=\"is_headline-bool\"></a>\n\n##### is_opinion: `bool`<a id=\"is_opinion-bool\"></a>\n\n##### is_paid_content: `bool`<a id=\"is_paid_content-bool\"></a>\n\n##### parent_url: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id=\"parent_url-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy\"></a>\n\n##### all_links: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id=\"all_links-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy\"></a>\n\n##### all_domain_links: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id=\"all_domain_links-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy\"></a>\n\n##### word_count_min: `int`<a id=\"word_count_min-int\"></a>\n\n##### word_count_max: `int`<a id=\"word_count_max-int\"></a>\n\n##### page: `int`<a id=\"page-int\"></a>\n\n##### page_size: `int`<a id=\"page_size-int\"></a>\n\n##### clustering_variable: `str`<a id=\"clustering_variable-str\"></a>\n\n##### clustering_enabled: `bool`<a id=\"clustering_enabled-bool\"></a>\n\n##### clustering_threshold: `Union[int, float]`<a id=\"clustering_threshold-unionint-float\"></a>\n\n##### include_nlp_data: `bool`<a id=\"include_nlp_data-bool\"></a>\n\n##### has_nlp: `bool`<a id=\"has_nlp-bool\"></a>\n\n##### theme: `str`<a id=\"theme-str\"></a>\n\n##### not_theme: `str`<a id=\"not_theme-str\"></a>\n\n##### org_entity_name: `str`<a id=\"org_entity_name-str\"></a>\n\n##### per_entity_name: `str`<a id=\"per_entity_name-str\"></a>\n\n##### loc_entity_name: `str`<a id=\"loc_entity_name-str\"></a>\n\n##### misc_entity_name: `str`<a id=\"misc_entity_name-str\"></a>\n\n##### title_sentiment_min: `Union[int, float]`<a id=\"title_sentiment_min-unionint-float\"></a>\n\n##### title_sentiment_max: `Union[int, float]`<a id=\"title_sentiment_max-unionint-float\"></a>\n\n##### content_sentiment_min: `Union[int, float]`<a id=\"content_sentiment_min-unionint-float\"></a>\n\n##### content_sentiment_max: `Union[int, float]`<a id=\"content_sentiment_max-unionint-float\"></a>\n\n##### iptc_tags: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id=\"iptc_tags-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy\"></a>\n\n##### not_iptc_tags: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id=\"not_iptc_tags-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy\"></a>\n\n##### iab_tags: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id=\"iab_tags-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy\"></a>\n\n##### not_iab_tags: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id=\"not_iab_tags-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy\"></a>\n\n#### \u2699\ufe0f Request Body<a id=\"\u2699\ufe0f-request-body\"></a>\n\n[`LatestHeadlinesRequest`](./newscatcherapi_client/type/latest_headlines_request.py)\n#### \ud83d\udd04 Return<a id=\"\ud83d\udd04-return\"></a>\n\n[`LatestHeadlinesPostResponse`](./newscatcherapi_client/pydantic/latest_headlines_post_response.py)\n\n#### \ud83c\udf10 Endpoint<a id=\"\ud83c\udf10-endpoint\"></a>\n\n`/api/latest_headlines` `post`\n\n[\ud83d\udd19 **Back to Table of Contents**](#table-of-contents)\n\n---\n\n### `newscatcher.search.get`<a id=\"newscatchersearchget\"></a>\n\nThis endpoint allows you to search for articles. You can search for articles by keyword, language, country, source, and more.\n\n#### \ud83d\udee0\ufe0f Usage<a id=\"\ud83d\udee0\ufe0f-usage\"></a>\n\n```python\nget_response = newscatcher.search.get(\n q=\"q_example\",\n search_in=\"title_content\",\n predefined_sources=None,\n sources=None,\n not_sources=None,\n lang=None,\n not_lang=None,\n countries=None,\n not_countries=None,\n not_author_name=None,\n from_=\"string_example\",\n to_=\"string_example\",\n published_date_precision=\"string_example\",\n by_parse_date=False,\n sort_by=\"relevancy\",\n ranked_only=\"string_example\",\n from_rank=1,\n to_rank=1,\n is_headline=True,\n is_opinion=True,\n is_paid_content=True,\n parent_url=None,\n all_links=None,\n all_domain_links=None,\n word_count_min=0,\n word_count_max=0,\n page=1,\n page_size=100,\n clustering_variable=\"string_example\",\n clustering_enabled=True,\n clustering_threshold=3.14,\n include_nlp_data=True,\n has_nlp=True,\n theme=\"string_example\",\n not_theme=\"string_example\",\n org_entity_name=\"string_example\",\n per_entity_name=\"string_example\",\n loc_entity_name=\"string_example\",\n misc_entity_name=\"string_example\",\n title_sentiment_min=3.14,\n title_sentiment_max=3.14,\n content_sentiment_min=3.14,\n content_sentiment_max=3.14,\n iptc_tags=None,\n not_iptc_tags=None,\n source_name=None,\n iab_tags=None,\n not_iab_tags=None,\n exclude_duplicates=True,\n additional_domain_info=True,\n is_news_domain=True,\n news_domain_type=None,\n news_type=None,\n)\n```\n\n#### \u2699\ufe0f Parameters<a id=\"\u2699\ufe0f-parameters\"></a>\n\n##### q: `str`<a id=\"q-str\"></a>\n\n##### search_in: `str`<a id=\"search_in-str\"></a>\n\n##### predefined_sources: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id=\"predefined_sources-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy\"></a>\n\n##### sources: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id=\"sources-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy\"></a>\n\n##### not_sources: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id=\"not_sources-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy\"></a>\n\n##### lang: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id=\"lang-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy\"></a>\n\n##### not_lang: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id=\"not_lang-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy\"></a>\n\n##### countries: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id=\"countries-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy\"></a>\n\n##### not_countries: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id=\"not_countries-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy\"></a>\n\n##### not_author_name: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id=\"not_author_name-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy\"></a>\n\n##### from_: Union[`str`, `datetime`]<a id=\"from_-unionstr-datetime\"></a>\n\n\n##### to_: Union[`str`, `datetime`]<a id=\"to_-unionstr-datetime\"></a>\n\n\n##### published_date_precision: `str`<a id=\"published_date_precision-str\"></a>\n\n##### by_parse_date: `bool`<a id=\"by_parse_date-bool\"></a>\n\n##### sort_by: `str`<a id=\"sort_by-str\"></a>\n\n##### ranked_only: Union[`str`, `bool`]<a id=\"ranked_only-unionstr-bool\"></a>\n\n\n##### from_rank: `int`<a id=\"from_rank-int\"></a>\n\n##### to_rank: `int`<a id=\"to_rank-int\"></a>\n\n##### is_headline: `bool`<a id=\"is_headline-bool\"></a>\n\n##### is_opinion: `bool`<a id=\"is_opinion-bool\"></a>\n\n##### is_paid_content: `bool`<a id=\"is_paid_content-bool\"></a>\n\n##### parent_url: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id=\"parent_url-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy\"></a>\n\n##### all_links: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id=\"all_links-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy\"></a>\n\n##### all_domain_links: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id=\"all_domain_links-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy\"></a>\n\n##### word_count_min: `int`<a id=\"word_count_min-int\"></a>\n\n##### word_count_max: `int`<a id=\"word_count_max-int\"></a>\n\n##### page: `int`<a id=\"page-int\"></a>\n\n##### page_size: `int`<a id=\"page_size-int\"></a>\n\n##### clustering_variable: `str`<a id=\"clustering_variable-str\"></a>\n\n##### clustering_enabled: `bool`<a id=\"clustering_enabled-bool\"></a>\n\n##### clustering_threshold: `Union[int, float]`<a id=\"clustering_threshold-unionint-float\"></a>\n\n##### include_nlp_data: `bool`<a id=\"include_nlp_data-bool\"></a>\n\n##### has_nlp: `bool`<a id=\"has_nlp-bool\"></a>\n\n##### theme: `str`<a id=\"theme-str\"></a>\n\n##### not_theme: `str`<a id=\"not_theme-str\"></a>\n\n##### org_entity_name: `str`<a id=\"org_entity_name-str\"></a>\n\n##### per_entity_name: `str`<a id=\"per_entity_name-str\"></a>\n\n##### loc_entity_name: `str`<a id=\"loc_entity_name-str\"></a>\n\n##### misc_entity_name: `str`<a id=\"misc_entity_name-str\"></a>\n\n##### title_sentiment_min: `Union[int, float]`<a id=\"title_sentiment_min-unionint-float\"></a>\n\n##### title_sentiment_max: `Union[int, float]`<a id=\"title_sentiment_max-unionint-float\"></a>\n\n##### content_sentiment_min: `Union[int, float]`<a id=\"content_sentiment_min-unionint-float\"></a>\n\n##### content_sentiment_max: `Union[int, float]`<a id=\"content_sentiment_max-unionint-float\"></a>\n\n##### iptc_tags: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id=\"iptc_tags-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy\"></a>\n\n##### not_iptc_tags: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id=\"not_iptc_tags-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy\"></a>\n\n##### source_name: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id=\"source_name-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy\"></a>\n\n##### iab_tags: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id=\"iab_tags-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy\"></a>\n\n##### not_iab_tags: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id=\"not_iab_tags-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy\"></a>\n\n##### exclude_duplicates: `bool`<a id=\"exclude_duplicates-bool\"></a>\n\n##### additional_domain_info: `bool`<a id=\"additional_domain_info-bool\"></a>\n\n##### is_news_domain: `bool`<a id=\"is_news_domain-bool\"></a>\n\n##### news_domain_type: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id=\"news_domain_type-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy\"></a>\n\n##### news_type: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id=\"news_type-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy\"></a>\n\n#### \ud83d\udd04 Return<a id=\"\ud83d\udd04-return\"></a>\n\n[`SearchGetResponse`](./newscatcherapi_client/pydantic/search_get_response.py)\n\n#### \ud83c\udf10 Endpoint<a id=\"\ud83c\udf10-endpoint\"></a>\n\n`/api/search` `get`\n\n[\ud83d\udd19 **Back to Table of Contents**](#table-of-contents)\n\n---\n\n### `newscatcher.search.post`<a id=\"newscatchersearchpost\"></a>\n\nThis endpoint allows you to search for articles. You can search for articles by keyword, language, country, source, and more.\n\n#### \ud83d\udee0\ufe0f Usage<a id=\"\ud83d\udee0\ufe0f-usage\"></a>\n\n```python\npost_response = newscatcher.search.post(\n q=\"string_example\",\n search_in=\"title_content\",\n predefined_sources=None,\n sources=None,\n not_sources=None,\n lang=None,\n not_lang=None,\n countries=None,\n not_countries=None,\n not_author_name=None,\n from_=\"string_example\",\n to_=\"string_example\",\n published_date_precision=\"string_example\",\n by_parse_date=False,\n sort_by=\"relevancy\",\n ranked_only=\"string_example\",\n from_rank=1,\n to_rank=1,\n is_headline=True,\n is_opinion=True,\n is_paid_content=True,\n parent_url=None,\n all_links=None,\n all_domain_links=None,\n word_count_min=0,\n word_count_max=0,\n page=1,\n page_size=100,\n clustering_variable=\"string_example\",\n clustering_enabled=True,\n clustering_threshold=3.14,\n include_nlp_data=True,\n has_nlp=True,\n theme=\"string_example\",\n not_theme=\"string_example\",\n org_entity_name=\"string_example\",\n per_entity_name=\"string_example\",\n loc_entity_name=\"string_example\",\n misc_entity_name=\"string_example\",\n title_sentiment_min=3.14,\n title_sentiment_max=3.14,\n content_sentiment_min=3.14,\n content_sentiment_max=3.14,\n iptc_tags=None,\n not_iptc_tags=None,\n source_name=None,\n iab_tags=None,\n not_iab_tags=None,\n exclude_duplicates=True,\n additional_domain_info=True,\n is_news_domain=True,\n news_domain_type=None,\n news_type=None,\n)\n```\n\n#### \u2699\ufe0f Parameters<a id=\"\u2699\ufe0f-parameters\"></a>\n\n##### q: `str`<a id=\"q-str\"></a>\n\n##### search_in: `str`<a id=\"search_in-str\"></a>\n\n##### predefined_sources: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id=\"predefined_sources-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy\"></a>\n\n##### sources: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id=\"sources-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy\"></a>\n\n##### not_sources: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id=\"not_sources-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy\"></a>\n\n##### lang: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id=\"lang-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy\"></a>\n\n##### not_lang: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id=\"not_lang-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy\"></a>\n\n##### countries: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id=\"countries-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy\"></a>\n\n##### not_countries: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id=\"not_countries-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy\"></a>\n\n##### not_author_name: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id=\"not_author_name-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy\"></a>\n\n##### from_: Union[`str`, `datetime`]<a id=\"from_-unionstr-datetime\"></a>\n\n\n##### to_: Union[`str`, `datetime`]<a id=\"to_-unionstr-datetime\"></a>\n\n\n##### published_date_precision: `str`<a id=\"published_date_precision-str\"></a>\n\n##### by_parse_date: `bool`<a id=\"by_parse_date-bool\"></a>\n\n##### sort_by: `str`<a id=\"sort_by-str\"></a>\n\n##### ranked_only: Union[`str`, `bool`]<a id=\"ranked_only-unionstr-bool\"></a>\n\n\n##### from_rank: `int`<a id=\"from_rank-int\"></a>\n\n##### to_rank: `int`<a id=\"to_rank-int\"></a>\n\n##### is_headline: `bool`<a id=\"is_headline-bool\"></a>\n\n##### is_opinion: `bool`<a id=\"is_opinion-bool\"></a>\n\n##### is_paid_content: `bool`<a id=\"is_paid_content-bool\"></a>\n\n##### parent_url: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id=\"parent_url-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy\"></a>\n\n##### all_links: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id=\"all_links-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy\"></a>\n\n##### all_domain_links: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id=\"all_domain_links-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy\"></a>\n\n##### word_count_min: `int`<a id=\"word_count_min-int\"></a>\n\n##### word_count_max: `int`<a id=\"word_count_max-int\"></a>\n\n##### page: `int`<a id=\"page-int\"></a>\n\n##### page_size: `int`<a id=\"page_size-int\"></a>\n\n##### clustering_variable: `str`<a id=\"clustering_variable-str\"></a>\n\n##### clustering_enabled: `bool`<a id=\"clustering_enabled-bool\"></a>\n\n##### clustering_threshold: `Union[int, float]`<a id=\"clustering_threshold-unionint-float\"></a>\n\n##### include_nlp_data: `bool`<a id=\"include_nlp_data-bool\"></a>\n\n##### has_nlp: `bool`<a id=\"has_nlp-bool\"></a>\n\n##### theme: `str`<a id=\"theme-str\"></a>\n\n##### not_theme: `str`<a id=\"not_theme-str\"></a>\n\n##### org_entity_name: `str`<a id=\"org_entity_name-str\"></a>\n\n##### per_entity_name: `str`<a id=\"per_entity_name-str\"></a>\n\n##### loc_entity_name: `str`<a id=\"loc_entity_name-str\"></a>\n\n##### misc_entity_name: `str`<a id=\"misc_entity_name-str\"></a>\n\n##### title_sentiment_min: `Union[int, float]`<a id=\"title_sentiment_min-unionint-float\"></a>\n\n##### title_sentiment_max: `Union[int, float]`<a id=\"title_sentiment_max-unionint-float\"></a>\n\n##### content_sentiment_min: `Union[int, float]`<a id=\"content_sentiment_min-unionint-float\"></a>\n\n##### content_sentiment_max: `Union[int, float]`<a id=\"content_sentiment_max-unionint-float\"></a>\n\n##### iptc_tags: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id=\"iptc_tags-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy\"></a>\n\n##### not_iptc_tags: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id=\"not_iptc_tags-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy\"></a>\n\n##### source_name: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id=\"source_name-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy\"></a>\n\n##### iab_tags: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id=\"iab_tags-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy\"></a>\n\n##### not_iab_tags: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id=\"not_iab_tags-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy\"></a>\n\n##### exclude_duplicates: `bool`<a id=\"exclude_duplicates-bool\"></a>\n\n##### additional_domain_info: `bool`<a id=\"additional_domain_info-bool\"></a>\n\n##### is_news_domain: `bool`<a id=\"is_news_domain-bool\"></a>\n\n##### news_domain_type: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id=\"news_domain_type-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy\"></a>\n\n##### news_type: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id=\"news_type-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy\"></a>\n\n#### \u2699\ufe0f Request Body<a id=\"\u2699\ufe0f-request-body\"></a>\n\n[`SearchRequest`](./newscatcherapi_client/type/search_request.py)\n#### \ud83d\udd04 Return<a id=\"\ud83d\udd04-return\"></a>\n\n[`SearchPostResponse`](./newscatcherapi_client/pydantic/search_post_response.py)\n\n#### \ud83c\udf10 Endpoint<a id=\"\ud83c\udf10-endpoint\"></a>\n\n`/api/search` `post`\n\n[\ud83d\udd19 **Back to Table of Contents**](#table-of-contents)\n\n---\n\n### `newscatcher.search_link.get`<a id=\"newscatchersearch_linkget\"></a>\n\nThis endpoint allows you to search for articles. You can search for articles by id(s) or link(s).\n\n#### \ud83d\udee0\ufe0f Usage<a id=\"\ud83d\udee0\ufe0f-usage\"></a>\n\n```python\nget_response = newscatcher.search_link.get(\n ids=None,\n links=None,\n from_=\"string_example\",\n to_=\"string_example\",\n page=1,\n page_size=100,\n)\n```\n\n#### \u2699\ufe0f Parameters<a id=\"\u2699\ufe0f-parameters\"></a>\n\n##### ids: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id=\"ids-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy\"></a>\n\n##### links: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id=\"links-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy\"></a>\n\n##### from_: Union[`str`, `datetime`]<a id=\"from_-unionstr-datetime\"></a>\n\n\n##### to_: Union[`str`, `datetime`]<a id=\"to_-unionstr-datetime\"></a>\n\n\n##### page: `int`<a id=\"page-int\"></a>\n\n##### page_size: `int`<a id=\"page_size-int\"></a>\n\n#### \ud83d\udd04 Return<a id=\"\ud83d\udd04-return\"></a>\n\n[`DtoResponsesSearchResponseSearchResponse`](./newscatcherapi_client/pydantic/dto_responses_search_response_search_response.py)\n\n#### \ud83c\udf10 Endpoint<a id=\"\ud83c\udf10-endpoint\"></a>\n\n`/api/search_by_link` `get`\n\n[\ud83d\udd19 **Back to Table of Contents**](#table-of-contents)\n\n---\n\n### `newscatcher.search_link.post`<a id=\"newscatchersearch_linkpost\"></a>\n\nThis endpoint allows you to search for articles. You can search for articles by id(s) or link(s).\n\n#### \ud83d\udee0\ufe0f Usage<a id=\"\ud83d\udee0\ufe0f-usage\"></a>\n\n```python\npost_response = newscatcher.search_link.post(\n ids=None,\n links=None,\n from_=\"string_example\",\n to_=\"string_example\",\n page=1,\n page_size=100,\n)\n```\n\n#### \u2699\ufe0f Parameters<a id=\"\u2699\ufe0f-parameters\"></a>\n\n##### ids: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id=\"ids-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy\"></a>\n\n##### links: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id=\"links-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy\"></a>\n\n##### from_: Union[`str`, `datetime`]<a id=\"from_-unionstr-datetime\"></a>\n\n\n##### to_: Union[`str`, `datetime`]<a id=\"to_-unionstr-datetime\"></a>\n\n\n##### page: `int`<a id=\"page-int\"></a>\n\n##### page_size: `int`<a id=\"page_size-int\"></a>\n\n#### \u2699\ufe0f Request Body<a id=\"\u2699\ufe0f-request-body\"></a>\n\n[`SearchURLRequest`](./newscatcherapi_client/type/search_url_request.py)\n#### \ud83d\udd04 Return<a id=\"\ud83d\udd04-return\"></a>\n\n[`DtoResponsesSearchResponseSearchResponse`](./newscatcherapi_client/pydantic/dto_responses_search_response_search_response.py)\n\n#### \ud83c\udf10 Endpoint<a id=\"\ud83c\udf10-endpoint\"></a>\n\n`/api/search_by_link` `post`\n\n[\ud83d\udd19 **Back to Table of Contents**](#table-of-contents)\n\n---\n\n### `newscatcher.search_similar.get`<a id=\"newscatchersearch_similarget\"></a>\n\nThis endpoint returns a list of articles that are similar to the query provided. You also have the option to get similar articles for the results of a search.\n\n#### \ud83d\udee0\ufe0f Usage<a id=\"\ud83d\udee0\ufe0f-usage\"></a>\n\n```python\nget_response = newscatcher.search_similar.get(\n q=\"q_example\",\n search_in=\"title_content\",\n include_similar_documents=False,\n similar_documents_number=5,\n similar_documents_fields=\"title,content\",\n predefined_sources=None,\n sources=None,\n not_sources=None,\n lang=None,\n not_lang=None,\n countries=None,\n not_countries=None,\n from_=\"string_example\",\n to_=\"string_example\",\n by_parse_date=False,\n published_date_precision=\"string_example\",\n sort_by=\"relevancy\",\n ranked_only=\"string_example\",\n from_rank=1,\n to_rank=1,\n is_headline=True,\n is_opinion=True,\n is_paid_content=True,\n parent_url=None,\n all_links=None,\n all_domain_links=None,\n word_count_min=0,\n word_count_max=0,\n page=1,\n page_size=100,\n include_nlp_data=True,\n has_nlp=True,\n theme=\"string_example\",\n not_theme=\"string_example\",\n title_sentiment_min=3.14,\n title_sentiment_max=3.14,\n content_sentiment_min=3.14,\n content_sentiment_max=3.14,\n iptc_tags=None,\n not_iptc_tags=None,\n)\n```\n\n#### \u2699\ufe0f Parameters<a id=\"\u2699\ufe0f-parameters\"></a>\n\n##### q: `str`<a id=\"q-str\"></a>\n\n##### search_in: `str`<a id=\"search_in-str\"></a>\n\n##### include_similar_documents: `bool`<a id=\"include_similar_documents-bool\"></a>\n\n##### similar_documents_number: `int`<a id=\"similar_documents_number-int\"></a>\n\n##### similar_documents_fields: `str`<a id=\"similar_documents_fields-str\"></a>\n\n##### predefined_sources: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id=\"predefined_sources-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy\"></a>\n\n##### sources: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id=\"sources-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy\"></a>\n\n##### not_sources: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id=\"not_sources-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy\"></a>\n\n##### lang: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id=\"lang-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy\"></a>\n\n##### not_lang: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id=\"not_lang-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy\"></a>\n\n##### countries: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id=\"countries-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy\"></a>\n\n##### not_countries: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id=\"not_countries-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy\"></a>\n\n##### from_: Union[`str`, `datetime`]<a id=\"from_-unionstr-datetime\"></a>\n\n\n##### to_: Union[`str`, `datetime`]<a id=\"to_-unionstr-datetime\"></a>\n\n\n##### by_parse_date: `bool`<a id=\"by_parse_date-bool\"></a>\n\n##### published_date_precision: `str`<a id=\"published_date_precision-str\"></a>\n\n##### sort_by: `str`<a id=\"sort_by-str\"></a>\n\n##### ranked_only: Union[`str`, `bool`]<a id=\"ranked_only-unionstr-bool\"></a>\n\n\n##### from_rank: `int`<a id=\"from_rank-int\"></a>\n\n##### to_rank: `int`<a id=\"to_rank-int\"></a>\n\n##### is_headline: `bool`<a id=\"is_headline-bool\"></a>\n\n##### is_opinion: `bool`<a id=\"is_opinion-bool\"></a>\n\n##### is_paid_content: `bool`<a id=\"is_paid_content-bool\"></a>\n\n##### parent_url: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id=\"parent_url-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy\"></a>\n\n##### all_links: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id=\"all_links-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy\"></a>\n\n##### all_domain_links: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id=\"all_domain_links-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy\"></a>\n\n##### word_count_min: `int`<a id=\"word_count_min-int\"></a>\n\n##### word_count_max: `int`<a id=\"word_count_max-int\"></a>\n\n##### page: `int`<a id=\"page-int\"></a>\n\n##### page_size: `int`<a id=\"page_size-int\"></a>\n\n##### include_nlp_data: `bool`<a id=\"include_nlp_data-bool\"></a>\n\n##### has_nlp: `bool`<a id=\"has_nlp-bool\"></a>\n\n##### theme: `str`<a id=\"theme-str\"></a>\n\n##### not_theme: `str`<a id=\"not_theme-str\"></a>\n\n##### title_sentiment_min: `Union[int, float]`<a id=\"title_sentiment_min-unionint-float\"></a>\n\n##### title_sentiment_max: `Union[int, float]`<a id=\"title_sentiment_max-unionint-float\"></a>\n\n##### content_sentiment_min: `Union[int, float]`<a id=\"content_sentiment_min-unionint-float\"></a>\n\n##### content_sentiment_max: `Union[int, float]`<a id=\"content_sentiment_max-unionint-float\"></a>\n\n##### iptc_tags: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id=\"iptc_tags-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy\"></a>\n\n##### not_iptc_tags: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id=\"not_iptc_tags-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy\"></a>\n\n#### \ud83d\udd04 Return<a id=\"\ud83d\udd04-return\"></a>\n\n[`SearchSimilarGetResponse`](./newscatcherapi_client/pydantic/search_similar_get_response.py)\n\n#### \ud83c\udf10 Endpoint<a id=\"\ud83c\udf10-endpoint\"></a>\n\n`/api/search_similar` `get`\n\n[\ud83d\udd19 **Back to Table of Contents**](#table-of-contents)\n\n---\n\n### `newscatcher.search_similar.post`<a id=\"newscatchersearch_similarpost\"></a>\n\nThis endpoint returns a list of articles that are similar to the query provided. You also have the option to get similar articles for the results of a search.\n\n#### \ud83d\udee0\ufe0f Usage<a id=\"\ud83d\udee0\ufe0f-usage\"></a>\n\n```python\npost_response = newscatcher.search_similar.post(\n q=\"string_example\",\n search_in=\"title_content\",\n include_similar_documents=False,\n similar_documents_number=5,\n similar_documents_fields=\"title,content\",\n predefined_sources=None,\n sources=None,\n not_sources=None,\n lang=None,\n not_lang=None,\n countries=None,\n not_countries=None,\n from_=\"string_example\",\n to_=\"string_example\",\n by_parse_date=False,\n published_date_precision=\"string_example\",\n sort_by=\"relevancy\",\n ranked_only=\"string_example\",\n from_rank=1,\n to_rank=1,\n is_headline=True,\n is_opinion=True,\n is_paid_content=True,\n parent_url=None,\n all_links=None,\n all_domain_links=None,\n word_count_min=0,\n word_count_max=0,\n page=1,\n page_size=100,\n include_nlp_data=True,\n has_nlp=True,\n theme=\"string_example\",\n not_theme=\"string_example\",\n title_sentiment_min=3.14,\n title_sentiment_max=3.14,\n content_sentiment_min=3.14,\n content_sentiment_max=3.14,\n iptc_tags=None,\n not_iptc_tags=None,\n)\n```\n\n#### \u2699\ufe0f Parameters<a id=\"\u2699\ufe0f-parameters\"></a>\n\n##### q: `str`<a id=\"q-str\"></a>\n\n##### search_in: `str`<a id=\"search_in-str\"></a>\n\n##### include_similar_documents: `bool`<a id=\"include_similar_documents-bool\"></a>\n\n##### similar_documents_number: `int`<a id=\"similar_documents_number-int\"></a>\n\n##### similar_documents_fields: `str`<a id=\"similar_documents_fields-str\"></a>\n\n##### predefined_sources: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id=\"predefined_sources-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy\"></a>\n\n##### sources: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id=\"sources-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy\"></a>\n\n##### not_sources: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id=\"not_sources-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy\"></a>\n\n##### lang: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id=\"lang-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy\"></a>\n\n##### not_lang: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id=\"not_lang-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy\"></a>\n\n##### countries: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id=\"countries-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy\"></a>\n\n##### not_countries: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id=\"not_countries-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy\"></a>\n\n##### from_: Union[`str`, `datetime`]<a id=\"from_-unionstr-datetime\"></a>\n\n\n##### to_: Union[`str`, `datetime`]<a id=\"to_-unionstr-datetime\"></a>\n\n\n##### by_parse_date: `bool`<a id=\"by_parse_date-bool\"></a>\n\n##### published_date_precision: `str`<a id=\"published_date_precision-str\"></a>\n\n##### sort_by: `str`<a id=\"sort_by-str\"></a>\n\n##### ranked_only: Union[`str`, `bool`]<a id=\"ranked_only-unionstr-bool\"></a>\n\n\n##### from_rank: `int`<a id=\"from_rank-int\"></a>\n\n##### to_rank: `int`<a id=\"to_rank-int\"></a>\n\n##### is_headline: `bool`<a id=\"is_headline-bool\"></a>\n\n##### is_opinion: `bool`<a id=\"is_opinion-bool\"></a>\n\n##### is_paid_content: `bool`<a id=\"is_paid_content-bool\"></a>\n\n##### parent_url: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id=\"parent_url-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy\"></a>\n\n##### all_links: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id=\"all_links-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy\"></a>\n\n##### all_domain_links: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id=\"all_domain_links-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy\"></a>\n\n##### word_count_min: `int`<a id=\"word_count_min-int\"></a>\n\n##### word_count_max: `int`<a id=\"word_count_max-int\"></a>\n\n##### page: `int`<a id=\"page-int\"></a>\n\n##### page_size: `int`<a id=\"page_size-int\"></a>\n\n##### include_nlp_data: `bool`<a id=\"include_nlp_data-bool\"></a>\n\n##### has_nlp: `bool`<a id=\"has_nlp-bool\"></a>\n\n##### theme: `str`<a id=\"theme-str\"></a>\n\n##### not_theme: `str`<a id=\"not_theme-str\"></a>\n\n##### title_sentiment_min: `Union[int, float]`<a id=\"title_sentiment_min-unionint-float\"></a>\n\n##### title_sentiment_max: `Union[int, float]`<a id=\"title_sentiment_max-unionint-float\"></a>\n\n##### content_sentiment_min: `Union[int, float]`<a id=\"content_sentiment_min-unionint-float\"></a>\n\n##### content_sentiment_max: `Union[int, float]`<a id=\"content_sentiment_max-unionint-float\"></a>\n\n##### iptc_tags: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id=\"iptc_tags-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy\"></a>\n\n##### not_iptc_tags: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id=\"not_iptc_tags-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy\"></a>\n\n#### \u2699\ufe0f Request Body<a id=\"\u2699\ufe0f-request-body\"></a>\n\n[`MoreLikeThisRequest`](./newscatcherapi_client/type/more_like_this_request.py)\n#### \ud83d\udd04 Return<a id=\"\ud83d\udd04-return\"></a>\n\n[`SearchSimilarPostResponse`](./newscatcherapi_client/pydantic/search_similar_post_response.py)\n\n#### \ud83c\udf10 Endpoint<a id=\"\ud83c\udf10-endpoint\"></a>\n\n`/api/search_similar` `post`\n\n[\ud83d\udd19 **Back to Table of Contents**](#table-of-contents)\n\n---\n\n### `newscatcher.sources.get`<a id=\"newscatchersourcesget\"></a>\n\nThis 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\n\n#### \ud83d\udee0\ufe0f Usage<a id=\"\ud83d\udee0\ufe0f-usage\"></a>\n\n```python\nget_response = newscatcher.sources.get(\n lang=None,\n countries=None,\n predefined_sources=None,\n include_additional_info=True,\n from_rank=1,\n to_rank=1,\n source_name=None,\n source_url=None,\n is_news_domain=True,\n news_domain_type=None,\n news_type=None,\n)\n```\n\n#### \u2699\ufe0f Parameters<a id=\"\u2699\ufe0f-parameters\"></a>\n\n##### lang: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id=\"lang-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy\"></a>\n\n##### countries: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id=\"countries-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy\"></a>\n\n##### predefined_sources: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id=\"predefined_sources-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy\"></a>\n\n##### include_additional_info: `bool`<a id=\"include_additional_info-bool\"></a>\n\n##### from_rank: `int`<a id=\"from_rank-int\"></a>\n\n##### to_rank: `int`<a id=\"to_rank-int\"></a>\n\n##### source_name: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id=\"source_name-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy\"></a>\n\n##### source_url: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id=\"source_url-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy\"></a>\n\n##### is_news_domain: `bool`<a id=\"is_news_domain-bool\"></a>\n\n##### news_domain_type: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id=\"news_domain_type-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy\"></a>\n\n##### news_type: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/.py)<a id=\"news_type-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypepy\"></a>\n\n#### \ud83d\udd04 Return<a id=\"\ud83d\udd04-return\"></a>\n\n[`SourceResponse`](./newscatcherapi_client/pydantic/source_response.py)\n\n#### \ud83c\udf10 Endpoint<a id=\"\ud83c\udf10-endpoint\"></a>\n\n`/api/sources` `get`\n\n[\ud83d\udd19 **Back to Table of Contents**](#table-of-contents)\n\n---\n\n### `newscatcher.sources.post`<a id=\"newscatchersourcespost\"></a>\n\nThis 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\n\n#### \ud83d\udee0\ufe0f Usage<a id=\"\ud83d\udee0\ufe0f-usage\"></a>\n\n```python\npost_response = newscatcher.sources.post(\n lang=None,\n countries=None,\n predefined_sources=None,\n include_additional_info=True,\n from_rank=1,\n to_rank=1,\n source_name=None,\n source_url=None,\n is_news_domain=True,\n news_domain_type=None,\n news_type=None,\n)\n```\n\n#### \u2699\ufe0f Parameters<a id=\"\u2699\ufe0f-parameters\"></a>\n\n##### lang: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id=\"lang-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy\"></a>\n\n##### countries: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id=\"countries-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy\"></a>\n\n##### predefined_sources: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id=\"predefined_sources-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy\"></a>\n\n##### include_additional_info: `bool`<a id=\"include_additional_info-bool\"></a>\n\n##### from_rank: `int`<a id=\"from_rank-int\"></a>\n\n##### to_rank: `int`<a id=\"to_rank-int\"></a>\n\n##### source_name: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id=\"source_name-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy\"></a>\n\n##### source_url: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id=\"source_url-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy\"></a>\n\n##### is_news_domain: `bool`<a id=\"is_news_domain-bool\"></a>\n\n##### news_domain_type: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id=\"news_domain_type-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy\"></a>\n\n##### news_type: [`Union[bool, date, datetime, dict, float, int, list, str, None]`](./newscatcherapi_client/type/typing_union_bool_date_datetime_dict_float_int_list_str_none.py)<a id=\"news_type-unionbool-date-datetime-dict-float-int-list-str-nonenewscatcherapi_clienttypetyping_union_bool_date_datetime_dict_float_int_list_str_nonepy\"></a>\n\n#### \u2699\ufe0f Request Body<a id=\"\u2699\ufe0f-request-body\"></a>\n\n[`SourcesRequest`](./newscatcherapi_client/type/sources_request.py)\n#### \ud83d\udd04 Return<a id=\"\ud83d\udd04-return\"></a>\n\n[`SourceResponse`](./newscatcherapi_client/pydantic/source_response.py)\n\n#### \ud83c\udf10 Endpoint<a id=\"\ud83c\udf10-endpoint\"></a>\n\n`/api/sources` `post`\n\n[\ud83d\udd19 **Back to Table of Contents**](#table-of-contents)\n\n---\n\n### `newscatcher.subscription.get`<a id=\"newscatchersubscriptionget\"></a>\n\nThis endpoint allows you to get info about your subscription plan.\n\n#### \ud83d\udee0\ufe0f Usage<a id=\"\ud83d\udee0\ufe0f-usage\"></a>\n\n```python\nget_response = newscatcher.subscription.get()\n```\n\n#### \ud83d\udd04 Return<a id=\"\ud83d\udd04-return\"></a>\n\n[`SubscriptionResponse`](./newscatcherapi_client/pydantic/subscription_response.py)\n\n#### \ud83c\udf10 Endpoint<a id=\"\ud83c\udf10-endpoint\"></a>\n\n`/api/subscription` `get`\n\n[\ud83d\udd19 **Back to Table of Contents**](#table-of-contents)\n\n---\n\n### `newscatcher.subscription.post`<a id=\"newscatchersubscriptionpost\"></a>\n\nThis endpoint allows you to get info about your subscription plan.\n\n#### \ud83d\udee0\ufe0f Usage<a id=\"\ud83d\udee0\ufe0f-usage\"></a>\n\n```python\npost_response = newscatcher.subscription.post()\n```\n\n#### \ud83d\udd04 Return<a id=\"\ud83d\udd04-return\"></a>\n\n[`SubscriptionResponse`](./newscatcherapi_client/pydantic/subscription_response.py)\n\n#### \ud83c\udf10 Endpoint<a id=\"\ud83c\udf10-endpoint\"></a>\n\n`/api/subscription` `post`\n\n[\ud83d\udd19 **Back to Table of Contents**](#table-of-contents)\n\n---\n\n\n## Author<a id=\"author\"></a>\nThis Python package is automatically generated by [Konfig](https://konfigthis.com)\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Client for NewsCatcher-V3 Production API",
"version": "6.0.13",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1866973b9cd5a0933a699784e0d7f0cc39f26df3a11182cd720f7124b2c5889f",
"md5": "0b25c79c8cc5bd2c1e083eef3ab33e19",
"sha256": "1d62bfdec54dec552b8edf33d2bf5e130ad1cb65ba840c8e216fcc3d00779f12"
},
"downloads": -1,
"filename": "newscatcherapi_python_sdk-6.0.13-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0b25c79c8cc5bd2c1e083eef3ab33e19",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.7",
"size": 401682,
"upload_time": "2024-10-08T12:13:46",
"upload_time_iso_8601": "2024-10-08T12:13:46.026947Z",
"url": "https://files.pythonhosted.org/packages/18/66/973b9cd5a0933a699784e0d7f0cc39f26df3a11182cd720f7124b2c5889f/newscatcherapi_python_sdk-6.0.13-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a1d37324d056d6c192252bb92e2483df108799f9a6d6182f56239d45fe0b3989",
"md5": "01939d81566c51f8637d60d2fe50cbb2",
"sha256": "6fd2284df009657d3a090fd95595ff36ebc407ebf83356e89f93d1f36333a1f2"
},
"downloads": -1,
"filename": "newscatcherapi_python_sdk-6.0.13.tar.gz",
"has_sig": false,
"md5_digest": "01939d81566c51f8637d60d2fe50cbb2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.7",
"size": 204168,
"upload_time": "2024-10-08T12:13:47",
"upload_time_iso_8601": "2024-10-08T12:13:47.740854Z",
"url": "https://files.pythonhosted.org/packages/a1/d3/7324d056d6c192252bb92e2483df108799f9a6d6182f56239d45fe0b3989/newscatcherapi_python_sdk-6.0.13.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-08 12:13:47",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "newscatcherapi-python-sdk"
}
