Skip to content

Latest commit

 

History

History
1784 lines (1191 loc) · 79.6 KB

README.md

File metadata and controls

1784 lines (1191 loc) · 79.6 KB
Raw

newscatcherapi-python-sdk



Visit our website https://newscatcherapi.com

PyPI README.md

Table of Contents

Requirements

Python >=3.7

Installation

pip install newscatcherapi-python-sdk==6.0.14

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",
        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",
            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",
        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",
    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: Union[str, bool]
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
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

AuthorsGetResponse

🌐 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",
    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: Union[str, bool]
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
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

AuthorSearchRequest

🔄 Return

AuthorsPostResponse

🌐 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,
    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

when: str
by_parse_date: bool
sort_by: str
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: Union[str, bool]
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

LatestHeadlinesGetResponse

🌐 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,
    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

when: str
by_parse_date: bool
sort_by: str
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: Union[str, bool]
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

LatestHeadlinesRequest

🔄 Return

LatestHeadlinesPostResponse

🌐 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,
    additional_domain_info=True,
    is_news_domain=True,
    news_domain_type=None,
    news_type=None,
)

⚙️ 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: Union[str, bool]
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
additional_domain_info: bool
is_news_domain: bool
news_domain_type: Union[bool, date, datetime, dict, float, int, list, str, None]
news_type: Union[bool, date, datetime, dict, float, int, list, str, None]

🔄 Return

SearchGetResponse

🌐 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,
    additional_domain_info=True,
    is_news_domain=True,
    news_domain_type=None,
    news_type=None,
)

⚙️ 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: Union[str, bool]
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
additional_domain_info: bool
is_news_domain: bool
news_domain_type: Union[bool, date, datetime, dict, float, int, list, str, None]
news_type: Union[bool, date, datetime, dict, float, int, list, str, None]

⚙️ Request Body

SearchRequest

🔄 Return

SearchPostResponse

🌐 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,
    from_="string_example",
    to_="string_example",
    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]
from_: Union[str, datetime]
to_: Union[str, datetime]
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,
    from_="string_example",
    to_="string_example",
    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]
from_: Union[str, datetime]
to_: Union[str, datetime]
page: int
page_size: int

⚙️ Request Body

SearchURLRequest

🔄 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",
    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: Union[str, bool]
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
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

SearchSimilarGetResponse

🌐 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",
    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: Union[str, bool]
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
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

MoreLikeThisRequest

🔄 Return

SearchSimilarPostResponse

🌐 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=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

lang: Union[bool, date, datetime, dict, float, int, list, str, None]
countries: Union[bool, date, datetime, dict, float, int, list, str, None]
predefined_sources: Union[bool, date, datetime, dict, float, int, list, str, None]
include_additional_info: bool
from_rank: int
to_rank: int
source_name: Union[bool, date, datetime, dict, float, int, list, str, None]
source_url: Union[bool, date, datetime, dict, float, int, list, str, None]
is_news_domain: bool
news_domain_type: Union[bool, date, datetime, dict, float, int, list, str, None]
news_type: Union[bool, date, datetime, dict, float, int, list, str, None]

🔄 Return

SourceResponse

🌐 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=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

lang: Union[bool, date, datetime, dict, float, int, list, str, None]
countries: Union[bool, date, datetime, dict, float, int, list, str, None]
predefined_sources: Union[bool, date, datetime, dict, float, int, list, str, None]
include_additional_info: bool
from_rank: int
to_rank: int
source_name: Union[bool, date, datetime, dict, float, int, list, str, None]
source_url: Union[bool, date, datetime, dict, float, int, list, str, None]
is_news_domain: bool
news_domain_type: Union[bool, date, datetime, dict, float, int, list, str, None]
news_type: Union[bool, date, datetime, dict, float, int, list, str, None]

⚙️ Request Body

SourcesRequest

🔄 Return

SourceResponse

🌐 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

SubscriptionResponse

🌐 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

SubscriptionResponse

🌐 Endpoint

/api/subscription post

🔙 Back to Table of Contents

Author

This Python package is automatically generated by Konfig