Newscatcherapi-typescript-sdk NPM

newscatcherapi-typescript-sdk

Visit our website https://newscatcherapi.com

Installation

npm i newscatcherapi-typescript-sdk

pnpm i newscatcherapi-typescript-sdk

yarn add newscatcherapi-typescript-sdk

Getting Started

import { Newscatcher } from "newscatcherapi-typescript-sdk";

const newscatcher = new Newscatcher({
  // Defining the base path is optional and defaults to https://v3-api.newscatcherapi.com
  // basePath: "https://v3-api.newscatcherapi.com",
  apiKey: "API_KEY",
});

const getResponse = await newscatcher.authors.get({
  authorName: "authorName_example",
  byParseDate: false,
  sortBy: "relevancy",
  page: 1,
  pageSize: 100,
});

console.log(getResponse);

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

const getResponse = await newscatcher.authors.get({
  authorName: "authorName_example",
  byParseDate: false,
  sortBy: "relevancy",
  page: 1,
  pageSize: 100,
});

⚙️ Parameters

authorName: `string`

notAuthorName: `string`

sources: `any`

predefinedSources: `any`

notSources: `any`

lang: `any`

notLang: `any`

countries: `any`

notCountries: `any`

publishedDatePrecision: `string`

byParseDate: `boolean`

sortBy: `string`

rankedOnly: `string`

fromRank: `number`

toRank: `number`

isHeadline: `boolean`

isPaidContent: `boolean`

parentUrl: `any`

allLinks: `any`

allDomainLinks: `any`

wordCountMin: `number`

wordCountMax: `number`

page: `number`

pageSize: `number`

includeNlpData: `boolean`

hasNlp: `boolean`

theme: `string`

notTheme: `string`

nerName: `string`

titleSentimentMin: `number`

titleSentimentMax: `number`

contentSentimentMin: `number`

contentSentimentMax: `number`

iptcTags: `any`

notIptcTags: `any`

iabTags: `any`

notIabTags: `any`

🔄 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

const postResponse = await newscatcher.authors.post({
  author_name: "author_name_example",
  by_parse_date: false,
  sort_by: "relevancy",
  page: 1,
  page_size: 100,
});

⚙️ Parameters

author_name: `string`

not_author_name: `string`

sources: `any`

predefined_sources: `any`

not_sources: `any`

lang: `any`

not_lang: `any`

countries: `any`

not_countries: `any`

from: `From`<a id="from-frommodelsfromts">

to: `To`<a id="to-tomodelstots">

published_date_precision: `string`

by_parse_date: `boolean`

sort_by: `string`

ranked_only: `string`

from_rank: `number`

to_rank: `number`

is_headline: `boolean`

is_paid_content: `boolean`

parent_url: `any`

all_links: `any`

all_domain_links: `any`

word_count_min: `number`

word_count_max: `number`

page: `number`

page_size: `number`

include_nlp_data: `boolean`

has_nlp: `boolean`

theme: `string`

not_theme: `string`

ner_name: `string`

title_sentiment_min: `number`

title_sentiment_max: `number`

content_sentiment_min: `number`

content_sentiment_max: `number`

iptc_tags: `any`

not_iptc_tags: `any`

iab_tags: `any`

not_iab_tags: `any`

🔄 Return

AuthorsPostResponse

🌐 Endpoint

/api/authors POST

🔙 Back to Table of Contents

`newscatcher.latestHeadlines.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

const getResponse = await newscatcher.latestHeadlines.get({
  when: "7d",
  byParseDate: false,
  page: 1,
  pageSize: 100,
});

⚙️ Parameters

when: `string`

byParseDate: `boolean`

lang: `any`

notLang: `any`

countries: `any`

notCountries: `any`

sources: `any`

predefinedSources: `any`

notSources: `any`

notAuthorName: `any`

rankedOnly: `string`

isHeadline: `boolean`

isPaidContent: `boolean`

parentUrl: `any`

allLinks: `any`

allDomainLinks: `any`

wordCountMin: `number`

wordCountMax: `number`

page: `number`

pageSize: `number`

clusteringVariable: `string`

clusteringEnabled: `boolean`

clusteringThreshold: `number`

includeNlpData: `boolean`

hasNlp: `boolean`

theme: `string`

notTheme: `string`

orgEntityName: `string`

perEntityName: `string`

locEntityName: `string`

miscEntityName: `string`

titleSentimentMin: `number`

titleSentimentMax: `number`

contentSentimentMin: `number`

contentSentimentMax: `number`

iptcTags: `any`

notIptcTags: `any`

iabTags: `any`

notIabTags: `any`

🔄 Return

LatestHeadlinesGetResponse

🌐 Endpoint

/api/latest_headlines GET

🔙 Back to Table of Contents

`newscatcher.latestHeadlines.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

const postResponse = await newscatcher.latestHeadlines.post({
  when: "7d",
  by_parse_date: false,
  page: 1,
  page_size: 100,
});

⚙️ Parameters

when: `string`

by_parse_date: `boolean`

lang: `any`

not_lang: `any`

countries: `any`

not_countries: `any`

sources: `any`

predefined_sources: `any`

not_sources: `any`

not_author_name: `any`

ranked_only: `string`

is_headline: `boolean`

is_paid_content: `boolean`

parent_url: `any`

all_links: `any`

all_domain_links: `any`

word_count_min: `number`

word_count_max: `number`

page: `number`

page_size: `number`

clustering_variable: `string`

clustering_enabled: `boolean`

clustering_threshold: `number`

include_nlp_data: `boolean`

has_nlp: `boolean`

theme: `string`

not_theme: `string`

ORG_entity_name: `string`

PER_entity_name: `string`

LOC_entity_name: `string`

MISC_entity_name: `string`

title_sentiment_min: `number`

title_sentiment_max: `number`

content_sentiment_min: `number`

content_sentiment_max: `number`

iptc_tags: `any`

not_iptc_tags: `any`

iab_tags: `any`

not_iab_tags: `any`

🔄 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

const getResponse = await newscatcher.search.get({
  q: "q_example",
  searchIn: "title_content",
  byParseDate: false,
  sortBy: "relevancy",
  page: 1,
  pageSize: 100,
});

⚙️ Parameters

q: `string`

searchIn: `string`

predefinedSources: `any`

sources: `any`

notSources: `any`

lang: `any`

notLang: `any`

countries: `any`

notCountries: `any`

notAuthorName: `any`

publishedDatePrecision: `string`

byParseDate: `boolean`

sortBy: `string`

rankedOnly: `string`

fromRank: `number`

toRank: `number`

isHeadline: `boolean`

isPaidContent: `boolean`

parentUrl: `any`

allLinks: `any`

allDomainLinks: `any`

wordCountMin: `number`

wordCountMax: `number`

page: `number`

pageSize: `number`

clusteringVariable: `string`

clusteringEnabled: `boolean`

clusteringThreshold: `number`

includeNlpData: `boolean`

hasNlp: `boolean`

theme: `string`

notTheme: `string`

orgEntityName: `string`

perEntityName: `string`

locEntityName: `string`

miscEntityName: `string`

titleSentimentMin: `number`

titleSentimentMax: `number`

contentSentimentMin: `number`

contentSentimentMax: `number`

iptcTags: `any`

notIptcTags: `any`

sourceName: `any`

iabTags: `any`

notIabTags: `any`

excludeDuplicates: `boolean`

🔄 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

const postResponse = await newscatcher.search.post({
  q: "q_example",
  search_in: "title_content",
  by_parse_date: false,
  sort_by: "relevancy",
  page: 1,
  page_size: 100,
});

⚙️ Parameters

q: `string`

search_in: `string`

predefined_sources: `any`

sources: `any`

not_sources: `any`

lang: `any`

not_lang: `any`

countries: `any`

not_countries: `any`

not_author_name: `any`

from: `From`<a id="from-frommodelsfromts">

to: `To`<a id="to-tomodelstots">

published_date_precision: `string`

by_parse_date: `boolean`

sort_by: `string`

ranked_only: `string`

from_rank: `number`

to_rank: `number`

is_headline: `boolean`

is_paid_content: `boolean`

parent_url: `any`

all_links: `any`

all_domain_links: `any`

word_count_min: `number`

word_count_max: `number`

page: `number`

page_size: `number`

clustering_variable: `string`

clustering_enabled: `boolean`

clustering_threshold: `number`

include_nlp_data: `boolean`

has_nlp: `boolean`

theme: `string`

not_theme: `string`

ORG_entity_name: `string`

PER_entity_name: `string`

LOC_entity_name: `string`

MISC_entity_name: `string`

title_sentiment_min: `number`

title_sentiment_max: `number`

content_sentiment_min: `number`

content_sentiment_max: `number`

iptc_tags: `any`

not_iptc_tags: `any`

source_name: `any`

iab_tags: `any`

not_iab_tags: `any`

exclude_duplicates: `boolean`

🔄 Return

SearchPostResponse

🌐 Endpoint

/api/search POST

🔙 Back to Table of Contents

`newscatcher.searchLink.get`

This endpoint allows you to search for articles. You can search for articles by id(s) or link(s).

🛠️ Usage

const getResponse = await newscatcher.searchLink.get({
  page: 1,
  pageSize: 100,
});

⚙️ Parameters

ids: `any`

links: `any`

page: `number`

pageSize: `number`

🔄 Return

DtoResponsesSearchResponseSearchResponse

🌐 Endpoint

/api/search_by_link GET

🔙 Back to Table of Contents

`newscatcher.searchLink.post`

This endpoint allows you to search for articles. You can search for articles by id(s) or link(s).

🛠️ Usage

const postResponse = await newscatcher.searchLink.post({
  page: 1,
  page_size: 100,
});

⚙️ Parameters

ids: `any`

links: `any`

page: `number`

page_size: `number`

🔄 Return

DtoResponsesSearchResponseSearchResponse

🌐 Endpoint

/api/search_by_link POST

🔙 Back to Table of Contents

`newscatcher.searchSimilar.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

const getResponse = await newscatcher.searchSimilar.get({
  q: "q_example",
  searchIn: "title_content",
  includeSimilarDocuments: false,
  similarDocumentsNumber: 5,
  similarDocumentsFields: "title,content",
  byParseDate: false,
  sortBy: "relevancy",
  page: 1,
  pageSize: 100,
});

⚙️ Parameters

q: `string`

searchIn: `string`

includeSimilarDocuments: `boolean`

similarDocumentsNumber: `number`

similarDocumentsFields: `string`

predefinedSources: `any`

sources: `any`

notSources: `any`

lang: `any`

notLang: `any`

countries: `any`

notCountries: `any`

byParseDate: `boolean`

publishedDatePrecision: `string`

sortBy: `string`

rankedOnly: `string`

fromRank: `number`

toRank: `number`

isHeadline: `boolean`

isPaidContent: `boolean`

parentUrl: `any`

allLinks: `any`

allDomainLinks: `any`

wordCountMin: `number`

wordCountMax: `number`

page: `number`

pageSize: `number`

includeNlpData: `boolean`

hasNlp: `boolean`

theme: `string`

notTheme: `string`

nerName: `string`

titleSentimentMin: `number`

titleSentimentMax: `number`

contentSentimentMin: `number`

contentSentimentMax: `number`

iptcTags: `any`

notIptcTags: `any`

🔄 Return

SearchSimilarGetResponse

🌐 Endpoint

/api/search_similar GET

🔙 Back to Table of Contents

`newscatcher.searchSimilar.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

const postResponse = await newscatcher.searchSimilar.post({
  q: "q_example",
  search_in: "title_content",
  include_similar_documents: false,
  similar_documents_number: 5,
  similar_documents_fields: "title,content",
  by_parse_date: false,
  sort_by: "relevancy",
  page: 1,
  page_size: 100,
});

⚙️ Parameters

q: `string`

search_in: `string`

include_similar_documents: `boolean`

similar_documents_number: `number`

similar_documents_fields: `string`

predefined_sources: `any`

sources: `any`

not_sources: `any`

lang: `any`

not_lang: `any`

countries: `any`

not_countries: `any`

from: `From`<a id="from-frommodelsfromts">

to: `To`<a id="to-tomodelstots">

by_parse_date: `boolean`

published_date_precision: `string`

sort_by: `string`

ranked_only: `string`

from_rank: `number`

to_rank: `number`

is_headline: `boolean`

is_paid_content: `boolean`

parent_url: `any`

all_links: `any`

all_domain_links: `any`

word_count_min: `number`

word_count_max: `number`

page: `number`

page_size: `number`

include_nlp_data: `boolean`

has_nlp: `boolean`

theme: `string`

not_theme: `string`

ner_name: `string`

title_sentiment_min: `number`

title_sentiment_max: `number`

content_sentiment_min: `number`

content_sentiment_max: `number`

iptc_tags: `any`

not_iptc_tags: `any`

🔄 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

const getResponse = await newscatcher.sources.get({});

⚙️ Parameters

lang: `string`

countries: `string`

predefinedSources: `string`

includeAdditionalInfo: `boolean`

fromRank: `number`

toRank: `number`

sourceName: `any`

sourceUrl: `string`

🔄 Return

SourceResponse

🌐 Endpoint

/api/sources GET

🔙 Back to Table of Contents

`newscatcher.sources.post`

🛠️ Usage

const postResponse = await newscatcher.sources.post({});

⚙️ Parameters

lang: `string`

countries: `string`

predefined_sources: `string`

include_additional_info: `boolean`

from_rank: `number`

to_rank: `number`

source_name: `any`

source_url: `string`

🔄 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

const getResponse = await 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

const postResponse = await newscatcher.subscription.post();

🔄 Return

SubscriptionResponse

🌐 Endpoint

/api/subscription POST

🔙 Back to Table of Contents

Author

This TypeScript package is automatically generated by Konfig

axios typescript konfig newscatcherapi-typescript-sdk

axios

@everything-registry/sub-chunk-2266

21 days ago

26 days ago

1 month ago

1 month ago

2 months ago

6 months ago

6 months ago

6 months ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago