newscatcherapi-typescript-sdk
Advanced tools
Readme
Visit our website https://newscatcherapi.com
newscatcher.authors.getnewscatcher.authors.postnewscatcher.latestHeadlines.getnewscatcher.latestHeadlines.postnewscatcher.search.getnewscatcher.search.postnewscatcher.searchLink.getnewscatcher.searchLink.postnewscatcher.searchSimilar.getnewscatcher.searchSimilar.postnewscatcher.sources.getnewscatcher.sources.postnewscatcher.subscription.getnewscatcher.subscription.postnpm | pnpm | yarn |
|---|---|---|
|
|
|
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);
newscatcher.authors.getThis 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.
const getResponse = await newscatcher.authors.get({
authorName: "authorName_example",
byParseDate: false,
sortBy: "relevancy",
page: 1,
pageSize: 100,
});
stringstringanyanyanyanyanyanyanyFromTostringbooleanstringstringnumbernumberbooleanbooleananyanyanynumbernumbernumbernumberbooleanbooleanstringstringstringnumbernumbernumbernumberanyanyanyany/api/authors GET
newscatcher.authors.postThis 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.
const postResponse = await newscatcher.authors.post({
author_name: "author_name_example",
by_parse_date: false,
sort_by: "relevancy",
page: 1,
page_size: 100,
});
stringstringanyanyanyanyanyanyanyFromTostringbooleanstringstringnumbernumberbooleanbooleananyanyanynumbernumbernumbernumberbooleanbooleanstringstringstringnumbernumbernumbernumberanyanyanyany/api/authors POST
newscatcher.latestHeadlines.getThis 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.
const getResponse = await newscatcher.latestHeadlines.get({
when: "7d",
byParseDate: false,
page: 1,
pageSize: 100,
});
stringbooleananyanyanyanyanyanyanyanystringbooleanbooleananyanyanynumbernumbernumbernumberstringbooleannumberbooleanbooleanstringstringstringstringstringstringnumbernumbernumbernumberanyanyanyany/api/latest_headlines GET
newscatcher.latestHeadlines.postThis 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.
const postResponse = await newscatcher.latestHeadlines.post({
when: "7d",
by_parse_date: false,
page: 1,
page_size: 100,
});
stringbooleananyanyanyanyanyanyanyanystringbooleanbooleananyanyanynumbernumbernumbernumberstringbooleannumberbooleanbooleanstringstringstringstringstringstringnumbernumbernumbernumberanyanyanyany/api/latest_headlines POST
newscatcher.search.getThis endpoint allows you to search for articles. You can search for articles by keyword, language, country, source, and more.
const getResponse = await newscatcher.search.get({
q: "q_example",
searchIn: "title_content",
byParseDate: false,
sortBy: "relevancy",
page: 1,
pageSize: 100,
});
stringstringanyanyanyanyanyanyanyanyFromTostringbooleanstringstringnumbernumberbooleanbooleananyanyanynumbernumbernumbernumberstringbooleannumberbooleanbooleanstringstringstringstringstringstringnumbernumbernumbernumberanyanyanyanyany/api/search GET
newscatcher.search.postThis endpoint allows you to search for articles. You can search for articles by keyword, language, country, source, and more.
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,
});
stringstringanyanyanyanyanyanyanyanyFromTostringbooleanstringstringnumbernumberbooleanbooleananyanyanynumbernumbernumbernumberstringbooleannumberbooleanbooleanstringstringstringstringstringstringnumbernumbernumbernumberanyanyanyanyany/api/search POST
newscatcher.searchLink.getThis endpoint allows you to search for articles. You can search for articles by id(s) or link(s).
const getResponse = await newscatcher.searchLink.get({
page: 1,
pageSize: 100,
});
anyanynumbernumberDtoResponsesSearchResponseSearchResponse
/api/search_by_link GET
newscatcher.searchLink.postThis endpoint allows you to search for articles. You can search for articles by id(s) or link(s).
const postResponse = await newscatcher.searchLink.post({
page: 1,
page_size: 100,
});
anyanynumbernumberDtoResponsesSearchResponseSearchResponse
/api/search_by_link POST
newscatcher.searchSimilar.getThis 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.
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,
});
stringstringbooleannumberstringanyanyanyanyanyanyanyFromTobooleanstringstringstringnumbernumberbooleanbooleananyanyanynumbernumbernumbernumberbooleanbooleanstringstringstringnumbernumbernumbernumberanyany/api/search_similar GET
newscatcher.searchSimilar.postThis 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.
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,
});
stringstringbooleannumberstringanyanyanyanyanyanyanyFromTobooleanstringstringstringnumbernumberbooleanbooleananyanyanynumbernumbernumbernumberbooleanbooleanstringstringstringnumbernumbernumbernumberanyany/api/search_similar POST
newscatcher.sources.getThis 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
const getResponse = await newscatcher.sources.get({});
stringstringstringbooleannumbernumberanystring/api/sources GET
newscatcher.sources.postThis 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
const postResponse = await newscatcher.sources.post({});
stringstringstringbooleannumbernumberanystring/api/sources POST
newscatcher.subscription.getThis endpoint allows you to get info about your subscription plan.
const getResponse = await newscatcher.subscription.get();
/api/subscription GET
newscatcher.subscription.postThis endpoint allows you to get info about your subscription plan.
const postResponse = await newscatcher.subscription.post();
/api/subscription POST
This TypeScript package is automatically generated by Konfig
FAQs
Client for NewsCatcher-V3 Production API
The npm package newscatcherapi-typescript-sdk receives a total of 57 weekly downloads. As such, newscatcherapi-typescript-sdk popularity was classified as not popular.
We found that newscatcherapi-typescript-sdk demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
UnitedHealth Group disclosed that the ransomware attack on Change Healthcare compromised protected health information for millions in the U.S., with estimated costs to the company expected to reach $1 billion.
Security News
GitHub is susceptible to a CDN flaw that allows attackers to host malware on any public repository.
Security News
At Node Congress, Socket CEO Feross Aboukhadijeh uncovers the darker aspects of open source, where applications that rely heavily on third-party dependencies can be exploited in supply chain attacks.