@factset/sdk-newsapifordigitalportals NPM

News API for Digital Portals client library for JavaScript

Consume FactSet’s StreetAccount news and 3rd party content through an API that seamlessly integrates with quotes, time series, watchlists, and other Functional APIs.

Search for news articles from various news distributors and publishers. Incorporate a multitude of search parameters such as region, category, source, article type and provider-specific meta data, to easily filter out the noise.

All search and list endpoints can be subscribed to receive streamed updates.

News providers include:

APA
AWP
Businesswire
Cercle Finance
Direkt News SE
Dow Jones News
dpa
dpa-AFX
EUWAX
GlobenewsWire
Kauppalehti
Midnight Trader
MoneyAM
newsaktuell
OMX
PR Newswire
Ritzau Finans
StreetAccount News
TDN News

See the Quotes API for Digital Portals for access to detailed price and performance information, plus basic support for security identifier cross-reference.

This TypeScript/JavaScript package is automatically generated by the OpenAPI Generator project:

API version: 2
Package version: 0.10.6
Build package: org.openapitools.codegen.languages.JavascriptClientCodegen

Requirements

Node.js >= 14

Installation

npm

npm install @factset/sdk-utils @factset/sdk-newsapifordigitalportals@0.10.6

yarn

yarn add @factset/sdk-utils @factset/sdk-newsapifordigitalportals@0.10.6

Usage

Generate authentication credentials.
Setup Node.js environment
1. Install and activate Node.js >=14. If you're using nvm:
```
nvm install 16
nvm use 16
```
2. (optional) Install yarn.
Install dependencies.
Run the following:

const { ApiClient, NewsApi } = require('@factset/sdk-newsapifordigitalportals');
const { ConfidentialClient } = require('@factset/sdk-utils');

const apiClient = ApiClient.instance;

// Examples for each supported authentication method are below,
// choose one that satisfies your use case.

// (Preferred) OAuth 2.0: FactSetOAuth2
// See https://github.com/FactSet/enterprise-sdk#oauth-20
// for information on how to create the app-config.json file
//
// The confidential client instance should be reused in production environments.
// See https://github.com/FactSet/enterprise-sdk-utils-typescript#authentication
// for more information on using the ConfidentialClient class
apiClient.factsetOauth2Client = new ConfidentialClient('/path/to/app-config.json');

// Basic authentication: FactSetApiKey
// See https://github.com/FactSet/enterprise-sdk#api-key
// for information how to create an API key
// const FactSetApiKey = apiClient.authentications['FactSetApiKey'];
// FactSetApiKey.username = 'USERNAME-SERIAL';
// FactSetApiKey.password = 'API-KEY';

const apiInstance = new NewsApi();
const code = "code_example"; // String | 
const opts = {
  'includeMedia': false, // Boolean | 
  'attributes': ["null"], // [String] | Limit the attributes returned in the response to the specified set.
  'language': "language_example" // String | 
};

// Call api endpoint
apiInstance.getNewsArticleGet(code, opts).then(
  data => {

    console.log('API called successfully. Returned data:');
    console.log(data);
  },
  error => {
    console.error(error);
  },
);

Documentation for API Endpoints

All URIs are relative to https://api.factset.com/wealth/v1

Class	Method	HTTP request	Description
newsapifordigitalportals.NewsApi	getNewsArticleGet	GET /news/article/get	Details for a news article.
newsapifordigitalportals.NewsApi	getNewsArticleTypeGet	GET /news/article/type/get	Details for a news article type.
newsapifordigitalportals.NewsApi	getNewsArticleTypeList	GET /news/article/type/list	List of news article types.
newsapifordigitalportals.NewsApi	getNewsDistributorGet	GET /news/distributor/get	Details of a distributor.
newsapifordigitalportals.NewsApi	getNewsDistributorList	GET /news/distributor/list	List of distributors.
newsapifordigitalportals.NewsApi	getNewsPublisherGet	GET /news/publisher/get	Details of a publisher.
newsapifordigitalportals.NewsApi	getNewsPublisherList	GET /news/publisher/list	List of publishers.
newsapifordigitalportals.NewsApi	getNewsPublisherListByDistributor	GET /news/publisher/listByDistributor	List of publishers provided by the given distributor.
newsapifordigitalportals.NewsApi	postNewsArticleList	POST /news/article/list	List of news articles.
newsapifordigitalportals.NewsApi	postNewsArticleListByChain	POST /news/article/listByChain	List news articles of an article chain.
newsapifordigitalportals.NewsApi	postNewsArticleListByIndex	POST /news/article/listByIndex	News articles for instruments that are constituents of the given indices.
newsapifordigitalportals.NewsApi	postNewsArticleListByInstrument	POST /news/article/listByInstrument	News articles for instruments.
newsapifordigitalportals.NewsApi	postNewsArticleListByMediaKind	POST /news/article/listByMediaKind	List news articles which contain media of specific media kinds.
newsapifordigitalportals.NewsApi	postNewsArticleSearchByText	POST /news/article/searchByText	Search for news articles using a fulltext search.
newsapifordigitalportals.NewsApi	postNewsPublisherSearchByName	POST /news/publisher/searchByName	Search for publishers.

Documentation for Models

Documentation for Authorization

FactSetApiKey

Type: HTTP basic authentication

FactSetOAuth2

Type: OAuth
Flow: application
Authorization URL:
Scopes: N/A

Contributing

Please refer to the contributing guide.

Copyright

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

FactSet API SDK

@factset/sdk-utils superagent

@everything-registry/sub-chunk-312

8 months ago

7 months ago

11 months ago

1 year ago