❤
npm
Sign UpSign In

@factset/sdk-realtimenews

0.20.1 • Public • Published

FactSet

Real-Time News client library for JavaScript

API Version 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: 4.0.0
  • SDK version: 0.20.1
  • Build package: com.factset.sdk.codegen.FactSetJavascriptClientCodegen

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

Requirements

  • Node.js >= 18

Installation

npm

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

yarn

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

Usage

  1. Generate authentication credentials.
  2. Setup Node.js environment

    1. Install and activate Node.js >=18. If you're using nvm:

      nvm install 18
nvm use 18

    2. (optional) Install yarn.

  3. Install dependencies.
  4. Run the following:

[!IMPORTANT] The parameter variables defined below are just examples and may potentially contain non valid values. Please replace them with valid values.

Example Code

const { ApiClient, BasicApi } = 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 BasicApi();
const opts = {
  'attributes': ["null"] // [String] | Limit the attributes returned in the response to the specified set.
};

// Call api endpoint
apiInstance.getBasicAssetClassList(opts).then(
  data => {

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

Using a Proxy

To add a HTTP proxy for the API client, you can set the proxyUrl for the ApiClient instance:

const { ApiClient } = require('@factset/sdk-realtimenews');

const apiClient = ApiClient.instance;
apiClient.setProxyUrl('http://username:password@proxy.example.com:8080');

Documentation for API Endpoints

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

Class Method HTTP request Description
realtimenews.BasicApi getBasicAssetClassList GET /basic/asset-class/list List of asset classes.
realtimenews.BasicApi getBasicBenchmarkTypeList GET /basic/benchmark/type/list List of benchmark types.
realtimenews.BasicApi getBasicFrequencyTypeList GET /basic/frequency/type/list List of frequency types.
realtimenews.BasicApi getBasicLanguageGet GET /basic/language/get Details for a language.
realtimenews.BasicApi getBasicLanguageGetByCode GET /basic/language/get-by-code Details for a language identified by code.
realtimenews.BasicApi getBasicLanguageList GET /basic/language/list List of languages.
realtimenews.BasicApi getBasicMarketGet GET /basic/market/get Details of a market.
realtimenews.BasicApi getBasicMarketGroupList GET /basic/market/group/list List of market groups.
realtimenews.BasicApi getBasicMarketTypeList GET /basic/market/type/list List of market types.
realtimenews.BasicApi getBasicMediaKindList GET /basic/media/kind/list List of media kinds.
realtimenews.BasicApi getBasicRegionContinentGet GET /basic/region/continent/get Details for a continent.
realtimenews.BasicApi getBasicRegionContinentList GET /basic/region/continent/list List of continents.
realtimenews.BasicApi getBasicRegionCountryGet GET /basic/region/country/get Details for a country.
realtimenews.BasicApi getBasicRegionCountryGetByCode GET /basic/region/country/get-by-code Details for a country identified by code.
realtimenews.BasicApi getBasicRegionCountryList GET /basic/region/country/list List of countries.
realtimenews.BasicApi getBasicRegionGet GET /basic/region/get Details for a region.
realtimenews.BasicApi getBasicRegionList GET /basic/region/list List of regions.
realtimenews.BasicApi getBasicTimezoneGet GET /basic/timezone/get Details of a timezone.
realtimenews.BasicApi getBasicTimezoneGetByName GET /basic/timezone/get-by-name Details of a timezone identified by name.
realtimenews.BasicApi getBasicValueUnitAlternativeList GET /basic/value-unit/alternative/list List of alternative units.
realtimenews.BasicApi getBasicValueUnitCurrencyFractionalGet GET /basic/value-unit/currency/fractional/get Details of a fractional currency.
realtimenews.BasicApi getBasicValueUnitCurrencyFractionalList GET /basic/value-unit/currency/fractional/list List of fractional currencies.
realtimenews.BasicApi getBasicValueUnitGet GET /basic/value-unit/get Details of a value unit.
realtimenews.BasicApi postBasicBackgroundTextTypeList POST /basic/background-text/type/list List of background text types.
realtimenews.BasicApi postBasicDeliveryList POST /basic/delivery/list List of deliveries.
realtimenews.BasicApi postBasicMarketList POST /basic/market/list List of markets.
realtimenews.BasicApi postBasicMediaTypeList POST /basic/media/type/list List of Internet media types.
realtimenews.BasicApi postBasicMicOperatingList POST /basic/mic/operating/list List of operating market identifier codes (MIC).
realtimenews.BasicApi postBasicTimezoneList POST /basic/timezone/list List of timezones.
realtimenews.BasicApi postBasicValueUnitCurrencyList POST /basic/value-unit/currency/list List of currencies.
realtimenews.BasicApi postBasicValueUnitCurrencyMainList POST /basic/value-unit/currency/main/list List of main currencies.
realtimenews.BasicApi postBasicValueUnitList POST /basic/value-unit/list List of value units.
realtimenews.CategoryApi getCategoryDatasetList GET /category/dataset/list List of entitled category datasets.
realtimenews.CategoryApi getCategoryGet GET /category/get Details of a category.
realtimenews.CategoryApi getCategoryInstrumentList GET /category/instrument/list List of instruments where a specific dataset has assigned a given category.
realtimenews.CategoryApi getCategoryLevelGet GET /category/level/get Details of a category level.
realtimenews.CategoryApi getCategoryList GET /category/list List of categories.
realtimenews.CategoryApi getCategoryListByLevel GET /category/list-by-level List of categories assigned to a category level.
realtimenews.CategoryApi getCategoryListBySystem GET /category/list-by-system List of categories assigned to a category system.
realtimenews.CategoryApi getCategoryPathGet GET /category/path/get Path from the first level to the level of a specific category.
realtimenews.CategoryApi getCategorySystemGet GET /category/system/get Details of an entitled category system.
realtimenews.CategoryApi getCategorySystemList GET /category/system/list List of entitled category systems.
realtimenews.CategoryApi getCategorySystemTypeList GET /category/system/type/list List of category system types.
realtimenews.NewsApi getNewsArticleGet GET /news/article/get Details for a news article.
realtimenews.NewsApi getNewsArticleTypeGet GET /news/article/type/get Details for a news article type.
realtimenews.NewsApi getNewsArticleTypeList GET /news/article/type/list List of news article types.
realtimenews.NewsApi getNewsDistributorGet GET /news/distributor/get Details of a distributor.
realtimenews.NewsApi getNewsDistributorList GET /news/distributor/list List of distributors.
realtimenews.NewsApi getNewsPublisherGet GET /news/publisher/get Details of a publisher.
realtimenews.NewsApi getNewsPublisherList GET /news/publisher/list List of publishers.
realtimenews.NewsApi getNewsPublisherListByDistributor GET /news/publisher/list-by-distributor List of publishers provided by the given distributor.
realtimenews.NewsApi postNewsArticleList POST /news/article/list List of news articles.
realtimenews.NewsApi postNewsArticleListByChain POST /news/article/list-by-chain List news articles of an article chain.
realtimenews.NewsApi postNewsArticleListByIndex POST /news/article/list-by-index News articles for instruments that are constituents of the given indices.
realtimenews.NewsApi postNewsArticleListByInstrument POST /news/article/list-by-instrument News articles for instruments.
realtimenews.NewsApi postNewsArticleListByMediaKind POST /news/article/list-by-media-kind List news articles which contain media of specific media kinds.
realtimenews.NewsApi postNewsArticleSearchByText POST /news/article/search-by-text Search for news articles using a fulltext search.
realtimenews.NewsApi postNewsPublisherSearchByName POST /news/publisher/search-by-name 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

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.

Readme

Keywords

Package Sidebar

Install

npm i @factset/sdk-realtimenews

Repository

github.com/factset/enterprise-sdk

Homepage

developer.factset.com/

Weekly Downloads

1

Version

0.20.1

License

Apache-2.0

Unpacked Size

1.65 MB

Total Files

335

Last publish

Collaborators

  • fds
  • tsouthmaydfds
  • enterprisesdk
  • fbecker-fds
Try on RunKit
Report malware