Socket
Socket
Sign inDemoInstall

@factset/sdk-realtimenews

Package Overview
Dependencies
54
Maintainers
3
Versions
2
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    @factset/sdk-realtimenews

Real-Time News client library for JavaScript


Version published
Weekly downloads
2
Maintainers
3
Created
Weekly downloads
 

Readme

Source

FactSet

Real-Time News client library for JavaScript

npm Apache-2 license

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
  • MT Newswires
  • MoneyAM
  • newsaktuell
  • OMX
  • PR Newswire
  • Ritzau Finans
  • StreetAccount News
  • TDN News

See the Real-Time Quotes API 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: 3.0.0
  • Package version: 0.11.1
  • Build package: com.factset.sdk.codegen.FactSetJavascriptClientCodegen

For more information, please visit https://developer.factset.com/contact

Requirements

  • Node.js >= 14

Installation

npm

npm install @factset/sdk-utils @factset/sdk-realtimenews@0.11.1

yarn

yarn add @factset/sdk-utils @factset/sdk-realtimenews@0.11.1

Usage

  1. Generate authentication credentials.
  2. 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.

  3. Install dependencies.
  4. Run the following:
const { ApiClient, NewsApi } = require('@factset/sdk-realtimenews');
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/v3

ClassMethodHTTP requestDescription
realtimenews.NewsApigetNewsArticleGetGET /news/article/getDetails for a news article.
realtimenews.NewsApigetNewsArticleTypeGetGET /news/article/type/getDetails for a news article type.
realtimenews.NewsApigetNewsArticleTypeListGET /news/article/type/listList of news article types.
realtimenews.NewsApigetNewsDistributorGetGET /news/distributor/getDetails of a distributor.
realtimenews.NewsApigetNewsDistributorListGET /news/distributor/listList of distributors.
realtimenews.NewsApigetNewsPublisherGetGET /news/publisher/getDetails of a publisher.
realtimenews.NewsApigetNewsPublisherListGET /news/publisher/listList of publishers.
realtimenews.NewsApigetNewsPublisherListByDistributorGET /news/publisher/listByDistributorList of publishers provided by the given distributor.
realtimenews.NewsApipostNewsArticleListPOST /news/article/listList of news articles.
realtimenews.NewsApipostNewsArticleListByChainPOST /news/article/listByChainList news articles of an article chain.
realtimenews.NewsApipostNewsArticleListByIndexPOST /news/article/listByIndexNews articles for instruments that are constituents of the given indices.
realtimenews.NewsApipostNewsArticleListByInstrumentPOST /news/article/listByInstrumentNews articles for instruments.
realtimenews.NewsApipostNewsArticleListByMediaKindPOST /news/article/listByMediaKindList news articles which contain media of specific media kinds.
realtimenews.NewsApipostNewsArticleSearchByTextPOST /news/article/searchByTextSearch for news articles using a fulltext search.
realtimenews.NewsApipostNewsPublisherSearchByNamePOST /news/publisher/searchByNameSearch 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 2022 FactSet Research Systems Inc

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.

Keywords

FAQs

Last updated on 19 Jan 2024

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.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc