Client for NewsCatcher-V3 Production API
Project description
newscatcherapi-python-sdk
Visit our website https://newscatcherapi.com
Table of Contents
- Requirements
- Installation
- Getting Started
- Async
- Raw HTTP Response
- Reference
newscatcher.authors.getnewscatcher.authors.postnewscatcher.latest_headlines.getnewscatcher.latest_headlines.postnewscatcher.search.getnewscatcher.search.postnewscatcher.search_link.getnewscatcher.search_link.postnewscatcher.search_similar.getnewscatcher.search_similar.postnewscatcher.sources.getnewscatcher.sources.postnewscatcher.subscription.getnewscatcher.subscription.post
Requirements
Python >=3.7
Installation
pip install newscatcherapi-python-sdk==6.0.7
Getting Started
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",
ner_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,
)
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
async support is available by prepending a to any method.
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",
ner_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,
)
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
To access raw HTTP response values, use the .raw namespace.
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",
ner_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,
)
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
newscatcher.authors.get
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
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",
ner_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
author_name: str
not_author_name: str
sources: Union[bool, date, datetime, dict, float, int, list, str, None]
predefined_sources: Union[bool, date, datetime, dict, float, int, list, str, None]
not_sources: Union[bool, date, datetime, dict, float, int, list, str, None]
lang: Union[bool, date, datetime, dict, float, int, list, str, None]
not_lang: Union[bool, date, datetime, dict, float, int, list, str, None]
countries: Union[bool, date, datetime, dict, float, int, list, str, None]
not_countries: Union[bool, date, datetime, dict, float, int, list, str, None]
from_: Union[str, datetime]
to_: Union[str, datetime]
published_date_precision: str
by_parse_date: bool
sort_by: str
ranked_only: str
from_rank: int
to_rank: int
is_headline: bool
is_opinion: bool
is_paid_content: bool
parent_url: Union[bool, date, datetime, dict, float, int, list, str, None]
all_links: Union[bool, date, datetime, dict, float, int, list, str, None]
all_domain_links: Union[bool, date, datetime, dict, float, int, list, str, None]
word_count_min: int
word_count_max: int
page: int
page_size: int
include_nlp_data: bool
has_nlp: bool
theme: str
not_theme: str
ner_name: str
title_sentiment_min: Union[int, float]
title_sentiment_max: Union[int, float]
content_sentiment_min: Union[int, float]
content_sentiment_max: Union[int, float]
iptc_tags: Union[bool, date, datetime, dict, float, int, list, str, None]
not_iptc_tags: Union[bool, date, datetime, dict, float, int, list, str, None]
iab_tags: Union[bool, date, datetime, dict, float, int, list, str, None]
not_iab_tags: Union[bool, date, datetime, dict, float, int, list, str, None]
๐ Return
๐ Endpoint
/api/authors get
๐ Back to Table of Contents
newscatcher.authors.post
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
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",
ner_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
author_name: str
not_author_name: str
sources: Union[bool, date, datetime, dict, float, int, list, str, None]
predefined_sources: Union[bool, date, datetime, dict, float, int, list, str, None]
not_sources: Union[bool, date, datetime, dict, float, int, list, str, None]
lang: Union[bool, date, datetime, dict, float, int, list, str, None]
not_lang: Union[bool, date, datetime, dict, float, int, list, str, None]
countries: Union[bool, date, datetime, dict, float, int, list, str, None]
not_countries: Union[bool, date, datetime, dict, float, int, list, str, None]
from_: Union[str, datetime]
to_: Union[str, datetime]
published_date_precision: str
by_parse_date: bool
sort_by: str
ranked_only: str
from_rank: int
to_rank: int
is_headline: bool
is_opinion: bool
is_paid_content: bool
parent_url: Union[bool, date, datetime, dict, float, int, list, str, None]
all_links: Union[bool, date, datetime, dict, float, int, list, str, None]
all_domain_links: Union[bool, date, datetime, dict, float, int, list, str, None]
word_count_min: int
word_count_max: int
page: int
page_size: int
include_nlp_data: bool
has_nlp: bool
theme: str
not_theme: str
ner_name: str
title_sentiment_min: Union[int, float]
title_sentiment_max: Union[int, float]
content_sentiment_min: Union[int, float]
content_sentiment_max: Union[int, float]
iptc_tags: Union[bool, date, datetime, dict, float, int, list, str, None]
not_iptc_tags: Union[bool, date, datetime, dict, float, int, list, str, None]
iab_tags: Union[bool, date, datetime, dict, float, int, list, str, None]
not_iab_tags: Union[bool, date, datetime, dict, float, int, list, str, None]
โ๏ธ Request Body
๐ Return
๐ Endpoint
/api/authors post
๐ Back to Table of Contents
newscatcher.latest_headlines.get
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
get_response = newscatcher.latest_headlines.get(
when="7d",
by_parse_date=False,
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
when: str
by_parse_date: bool
lang: Union[bool, date, datetime, dict, float, int, list, str, None]
not_lang: Union[bool, date, datetime, dict, float, int, list, str, None]
countries: Union[bool, date, datetime, dict, float, int, list, str, None]
not_countries: Union[bool, date, datetime, dict, float, int, list, str, None]
sources: Union[bool, date, datetime, dict, float, int, list, str, None]
predefined_sources: Union[bool, date, datetime, dict, float, int, list, str, None]
not_sources: Union[bool, date, datetime, dict, float, int, list, str, None]
not_author_name: Union[bool, date, datetime, dict, float, int, list, str, None]
ranked_only: str
is_headline: bool
is_opinion: bool
is_paid_content: bool
parent_url: Union[bool, date, datetime, dict, float, int, list, str, None]
all_links: Union[bool, date, datetime, dict, float, int, list, str, None]
all_domain_links: Union[bool, date, datetime, dict, float, int, list, str, None]
word_count_min: int
word_count_max: int
page: int
page_size: int
clustering_variable: str
clustering_enabled: bool
clustering_threshold: Union[int, float]
include_nlp_data: bool
has_nlp: bool
theme: str
not_theme: str
org_entity_name: str
per_entity_name: str
loc_entity_name: str
misc_entity_name: str
title_sentiment_min: Union[int, float]
title_sentiment_max: Union[int, float]
content_sentiment_min: Union[int, float]
content_sentiment_max: Union[int, float]
iptc_tags: Union[bool, date, datetime, dict, float, int, list, str, None]
not_iptc_tags: Union[bool, date, datetime, dict, float, int, list, str, None]
iab_tags: Union[bool, date, datetime, dict, float, int, list, str, None]
not_iab_tags: Union[bool, date, datetime, dict, float, int, list, str, None]
๐ Return
๐ Endpoint
/api/latest_headlines get
๐ Back to Table of Contents
newscatcher.latest_headlines.post
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
post_response = newscatcher.latest_headlines.post(
when="7d",
by_parse_date=False,
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
when: str
by_parse_date: bool
lang: Union[bool, date, datetime, dict, float, int, list, str, None]
not_lang: Union[bool, date, datetime, dict, float, int, list, str, None]
countries: Union[bool, date, datetime, dict, float, int, list, str, None]
not_countries: Union[bool, date, datetime, dict, float, int, list, str, None]
sources: Union[bool, date, datetime, dict, float, int, list, str, None]
predefined_sources: Union[bool, date, datetime, dict, float, int, list, str, None]
not_sources: Union[bool, date, datetime, dict, float, int, list, str, None]
not_author_name: Union[bool, date, datetime, dict, float, int, list, str, None]
ranked_only: str
is_headline: bool
is_opinion: bool
is_paid_content: bool
parent_url: Union[bool, date, datetime, dict, float, int, list, str, None]
all_links: Union[bool, date, datetime, dict, float, int, list, str, None]
all_domain_links: Union[bool, date, datetime, dict, float, int, list, str, None]
word_count_min: int
word_count_max: int
page: int
page_size: int
clustering_variable: str
clustering_enabled: bool
clustering_threshold: Union[int, float]
include_nlp_data: bool
has_nlp: bool
theme: str
not_theme: str
org_entity_name: str
per_entity_name: str
loc_entity_name: str
misc_entity_name: str
title_sentiment_min: Union[int, float]
title_sentiment_max: Union[int, float]
content_sentiment_min: Union[int, float]
content_sentiment_max: Union[int, float]
iptc_tags: Union[bool, date, datetime, dict, float, int, list, str, None]
not_iptc_tags: Union[bool, date, datetime, dict, float, int, list, str, None]
iab_tags: Union[bool, date, datetime, dict, float, int, list, str, None]
not_iab_tags: Union[bool, date, datetime, dict, float, int, list, str, None]
โ๏ธ Request Body
๐ Return
๐ Endpoint
/api/latest_headlines post
๐ Back to Table of Contents
newscatcher.search.get
This endpoint allows you to search for articles. You can search for articles by keyword, language, country, source, and more.
๐ ๏ธ Usage
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,
)
โ๏ธ Parameters
q: str
search_in: str
predefined_sources: Union[bool, date, datetime, dict, float, int, list, str, None]
sources: Union[bool, date, datetime, dict, float, int, list, str, None]
not_sources: Union[bool, date, datetime, dict, float, int, list, str, None]
lang: Union[bool, date, datetime, dict, float, int, list, str, None]
not_lang: Union[bool, date, datetime, dict, float, int, list, str, None]
countries: Union[bool, date, datetime, dict, float, int, list, str, None]
not_countries: Union[bool, date, datetime, dict, float, int, list, str, None]
not_author_name: Union[bool, date, datetime, dict, float, int, list, str, None]
from_: Union[str, datetime]
to_: Union[str, datetime]
published_date_precision: str
by_parse_date: bool
sort_by: str
ranked_only: str
from_rank: int
to_rank: int
is_headline: bool
is_opinion: bool
is_paid_content: bool
parent_url: Union[bool, date, datetime, dict, float, int, list, str, None]
all_links: Union[bool, date, datetime, dict, float, int, list, str, None]
all_domain_links: Union[bool, date, datetime, dict, float, int, list, str, None]
word_count_min: int
word_count_max: int
page: int
page_size: int
clustering_variable: str
clustering_enabled: bool
clustering_threshold: Union[int, float]
include_nlp_data: bool
has_nlp: bool
theme: str
not_theme: str
org_entity_name: str
per_entity_name: str
loc_entity_name: str
misc_entity_name: str
title_sentiment_min: Union[int, float]
title_sentiment_max: Union[int, float]
content_sentiment_min: Union[int, float]
content_sentiment_max: Union[int, float]
iptc_tags: Union[bool, date, datetime, dict, float, int, list, str, None]
not_iptc_tags: Union[bool, date, datetime, dict, float, int, list, str, None]
source_name: Union[bool, date, datetime, dict, float, int, list, str, None]
iab_tags: Union[bool, date, datetime, dict, float, int, list, str, None]
not_iab_tags: Union[bool, date, datetime, dict, float, int, list, str, None]
exclude_duplicates: bool
๐ Return
๐ Endpoint
/api/search get
๐ Back to Table of Contents
newscatcher.search.post
This endpoint allows you to search for articles. You can search for articles by keyword, language, country, source, and more.
๐ ๏ธ Usage
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,
)
โ๏ธ Parameters
q: str
search_in: str
predefined_sources: Union[bool, date, datetime, dict, float, int, list, str, None]
sources: Union[bool, date, datetime, dict, float, int, list, str, None]
not_sources: Union[bool, date, datetime, dict, float, int, list, str, None]
lang: Union[bool, date, datetime, dict, float, int, list, str, None]
not_lang: Union[bool, date, datetime, dict, float, int, list, str, None]
countries: Union[bool, date, datetime, dict, float, int, list, str, None]
not_countries: Union[bool, date, datetime, dict, float, int, list, str, None]
not_author_name: Union[bool, date, datetime, dict, float, int, list, str, None]
from_: Union[str, datetime]
to_: Union[str, datetime]
published_date_precision: str
by_parse_date: bool
sort_by: str
ranked_only: str
from_rank: int
to_rank: int
is_headline: bool
is_opinion: bool
is_paid_content: bool
parent_url: Union[bool, date, datetime, dict, float, int, list, str, None]
all_links: Union[bool, date, datetime, dict, float, int, list, str, None]
all_domain_links: Union[bool, date, datetime, dict, float, int, list, str, None]
word_count_min: int
word_count_max: int
page: int
page_size: int
clustering_variable: str
clustering_enabled: bool
clustering_threshold: Union[int, float]
include_nlp_data: bool
has_nlp: bool
theme: str
not_theme: str
org_entity_name: str
per_entity_name: str
loc_entity_name: str
misc_entity_name: str
title_sentiment_min: Union[int, float]
title_sentiment_max: Union[int, float]
content_sentiment_min: Union[int, float]
content_sentiment_max: Union[int, float]
iptc_tags: Union[bool, date, datetime, dict, float, int, list, str, None]
not_iptc_tags: Union[bool, date, datetime, dict, float, int, list, str, None]
source_name: Union[bool, date, datetime, dict, float, int, list, str, None]
iab_tags: Union[bool, date, datetime, dict, float, int, list, str, None]
not_iab_tags: Union[bool, date, datetime, dict, float, int, list, str, None]
exclude_duplicates: bool
โ๏ธ Request Body
๐ Return
๐ Endpoint
/api/search post
๐ Back to Table of Contents
newscatcher.search_link.get
This endpoint allows you to search for articles. You can search for articles by id(s) or link(s).
๐ ๏ธ Usage
get_response = newscatcher.search_link.get(
ids=None,
links=None,
page=1,
page_size=100,
)
โ๏ธ Parameters
ids: Union[bool, date, datetime, dict, float, int, list, str, None]
links: Union[bool, date, datetime, dict, float, int, list, str, None]
page: int
page_size: int
๐ Return
DtoResponsesSearchResponseSearchResponse
๐ Endpoint
/api/search_by_link get
๐ Back to Table of Contents
newscatcher.search_link.post
This endpoint allows you to search for articles. You can search for articles by id(s) or link(s).
๐ ๏ธ Usage
post_response = newscatcher.search_link.post(
ids=None,
links=None,
page=1,
page_size=100,
)
โ๏ธ Parameters
ids: Union[bool, date, datetime, dict, float, int, list, str, None]
links: Union[bool, date, datetime, dict, float, int, list, str, None]
page: int
page_size: int
โ๏ธ Request Body
๐ Return
DtoResponsesSearchResponseSearchResponse
๐ Endpoint
/api/search_by_link post
๐ Back to Table of Contents
newscatcher.search_similar.get
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
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",
ner_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,
)
โ๏ธ Parameters
q: str
search_in: str
include_similar_documents: bool
similar_documents_number: int
similar_documents_fields: str
predefined_sources: Union[bool, date, datetime, dict, float, int, list, str, None]
sources: Union[bool, date, datetime, dict, float, int, list, str, None]
not_sources: Union[bool, date, datetime, dict, float, int, list, str, None]
lang: Union[bool, date, datetime, dict, float, int, list, str, None]
not_lang: Union[bool, date, datetime, dict, float, int, list, str, None]
countries: Union[bool, date, datetime, dict, float, int, list, str, None]
not_countries: Union[bool, date, datetime, dict, float, int, list, str, None]
from_: Union[str, datetime]
to_: Union[str, datetime]
by_parse_date: bool
published_date_precision: str
sort_by: str
ranked_only: str
from_rank: int
to_rank: int
is_headline: bool
is_opinion: bool
is_paid_content: bool
parent_url: Union[bool, date, datetime, dict, float, int, list, str, None]
all_links: Union[bool, date, datetime, dict, float, int, list, str, None]
all_domain_links: Union[bool, date, datetime, dict, float, int, list, str, None]
word_count_min: int
word_count_max: int
page: int
page_size: int
include_nlp_data: bool
has_nlp: bool
theme: str
not_theme: str
ner_name: str
title_sentiment_min: Union[int, float]
title_sentiment_max: Union[int, float]
content_sentiment_min: Union[int, float]
content_sentiment_max: Union[int, float]
iptc_tags: Union[bool, date, datetime, dict, float, int, list, str, None]
not_iptc_tags: Union[bool, date, datetime, dict, float, int, list, str, None]
๐ Return
๐ Endpoint
/api/search_similar get
๐ Back to Table of Contents
newscatcher.search_similar.post
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
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",
ner_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,
)
โ๏ธ Parameters
q: str
search_in: str
include_similar_documents: bool
similar_documents_number: int
similar_documents_fields: str
predefined_sources: Union[bool, date, datetime, dict, float, int, list, str, None]
sources: Union[bool, date, datetime, dict, float, int, list, str, None]
not_sources: Union[bool, date, datetime, dict, float, int, list, str, None]
lang: Union[bool, date, datetime, dict, float, int, list, str, None]
not_lang: Union[bool, date, datetime, dict, float, int, list, str, None]
countries: Union[bool, date, datetime, dict, float, int, list, str, None]
not_countries: Union[bool, date, datetime, dict, float, int, list, str, None]
from_: Union[str, datetime]
to_: Union[str, datetime]
by_parse_date: bool
published_date_precision: str
sort_by: str
ranked_only: str
from_rank: int
to_rank: int
is_headline: bool
is_opinion: bool
is_paid_content: bool
parent_url: Union[bool, date, datetime, dict, float, int, list, str, None]
all_links: Union[bool, date, datetime, dict, float, int, list, str, None]
all_domain_links: Union[bool, date, datetime, dict, float, int, list, str, None]
word_count_min: int
word_count_max: int
page: int
page_size: int
include_nlp_data: bool
has_nlp: bool
theme: str
not_theme: str
ner_name: str
title_sentiment_min: Union[int, float]
title_sentiment_max: Union[int, float]
content_sentiment_min: Union[int, float]
content_sentiment_max: Union[int, float]
iptc_tags: Union[bool, date, datetime, dict, float, int, list, str, None]
not_iptc_tags: Union[bool, date, datetime, dict, float, int, list, str, None]
โ๏ธ Request Body
๐ Return
๐ Endpoint
/api/search_similar post
๐ Back to Table of Contents
newscatcher.sources.get
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
get_response = newscatcher.sources.get(
lang="string_example",
countries="string_example",
predefined_sources="string_example",
include_additional_info=True,
from_rank=1,
to_rank=1,
source_name=None,
source_url="string_example",
)
โ๏ธ Parameters
lang: str
countries: str
predefined_sources: str
include_additional_info: bool
from_rank: int
to_rank: int
source_name: Union[bool, date, datetime, dict, float, int, list, str, None]
source_url: str
๐ Return
๐ Endpoint
/api/sources get
๐ Back to Table of Contents
newscatcher.sources.post
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
post_response = newscatcher.sources.post(
lang="string_example",
countries="string_example",
predefined_sources="string_example",
include_additional_info=True,
from_rank=1,
to_rank=1,
source_name=None,
source_url="string_example",
)
โ๏ธ Parameters
lang: str
countries: str
predefined_sources: str
include_additional_info: bool
from_rank: int
to_rank: int
source_name: Union[bool, date, datetime, dict, float, int, list, str, None]
source_url: str
โ๏ธ Request Body
๐ Return
๐ Endpoint
/api/sources post
๐ Back to Table of Contents
newscatcher.subscription.get
This endpoint allows you to get info about your subscription plan.
๐ ๏ธ Usage
get_response = newscatcher.subscription.get()
๐ Return
๐ Endpoint
/api/subscription get
๐ Back to Table of Contents
newscatcher.subscription.post
This endpoint allows you to get info about your subscription plan.
๐ ๏ธ Usage
post_response = newscatcher.subscription.post()
๐ Return
๐ Endpoint
/api/subscription post
๐ Back to Table of Contents
Author
This Python package is automatically generated by Konfig
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for newscatcherapi_python_sdk-6.0.7.tar.gz
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 4ba6173f23f0048ae39ff04fd464f8b676bc15da11430f5682929c2af6c10d9f |
|
| MD5 | 740e5e697f33e1bb0a18c9e8aefc65d0 |
|
| BLAKE2b-256 | 91d54062bf466594da1228ce9cb750e40f375e4d963f90f32b503b91259cfcb9 |
Close
Hashes for newscatcherapi_python_sdk-6.0.7-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 2526a4781a26ca4f874c3f601ead0286ed569996be7eda77c26e2a5364fccee8 |
|
| MD5 | 99b7fee7f79c799edd271d74f9b3d413 |
|
| BLAKE2b-256 | 7fe567ec8e46977bd707e66d87ca0ce18a4c44480add4be83e8e5508a0436822 |
