@factset/sdk-realtimenews
v0.12.0
Published
Real-Time News client library for JavaScript
Downloads
69
Readme
Real-Time News 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
- 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
- SDK version: 0.12.0
- 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/[email protected]
yarn
yarn add @factset/sdk-utils @factset/[email protected]
Usage
- Generate authentication credentials.
- Setup Node.js environment
Install and activate Node.js >=18. If you're using nvm:
nvm install 18 nvm use 18
(optional) Install yarn.
- Install dependencies.
- 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, 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);
},
);
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:[email protected]:8080');
Documentation for API Endpoints
All URIs are relative to https://api.factset.com/wealth/v3
Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- 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/listByDistributor | 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/listByChain | List news articles of an article chain. realtimenews.NewsApi | postNewsArticleListByIndex | POST /news/article/listByIndex | News articles for instruments that are constituents of the given indices. realtimenews.NewsApi | postNewsArticleListByInstrument | POST /news/article/listByInstrument | News articles for instruments. realtimenews.NewsApi | postNewsArticleListByMediaKind | POST /news/article/listByMediaKind | List news articles which contain media of specific media kinds. realtimenews.NewsApi | postNewsArticleSearchByText | POST /news/article/searchByText | Search for news articles using a fulltext search. realtimenews.NewsApi | postNewsPublisherSearchByName | POST /news/publisher/searchByName | Search for publishers.
Documentation for Models
- realtimenews.CursorBasedPaginationOutputObject
- realtimenews.CursorBasedPaginationOutputObjectWithoutTotal
- realtimenews.ErrorMetaObject
- realtimenews.InlineResponse200
- realtimenews.InlineResponse2001
- realtimenews.InlineResponse20010
- realtimenews.InlineResponse20010Data
- realtimenews.InlineResponse20010Meta
- realtimenews.InlineResponse20011
- realtimenews.InlineResponse20011Data
- realtimenews.InlineResponse2001Categories
- realtimenews.InlineResponse2001Chain
- realtimenews.InlineResponse2001Data
- realtimenews.InlineResponse2001Distributor
- realtimenews.InlineResponse2001Fsym
- realtimenews.InlineResponse2001FsymSecurity
- realtimenews.InlineResponse2001Instruments
- realtimenews.InlineResponse2001Language
- realtimenews.InlineResponse2001Meta
- realtimenews.InlineResponse2001Publisher
- realtimenews.InlineResponse2001Types
- realtimenews.InlineResponse2002
- realtimenews.InlineResponse2002Data
- realtimenews.InlineResponse2002DataArticles
- realtimenews.InlineResponse2002DataDistributor
- realtimenews.InlineResponse2003
- realtimenews.InlineResponse2003Data
- realtimenews.InlineResponse2003DataIdentifiers
- realtimenews.InlineResponse2003DataStatus
- realtimenews.InlineResponse2004
- realtimenews.InlineResponse2004Data
- realtimenews.InlineResponse2004DataIdentifiers
- realtimenews.InlineResponse2004DataStatus
- realtimenews.InlineResponse2005
- realtimenews.InlineResponse2005Data
- realtimenews.InlineResponse2006
- realtimenews.InlineResponse2006Data
- realtimenews.InlineResponse2007
- realtimenews.InlineResponse2007Data
- realtimenews.InlineResponse2007DataDelivery
- realtimenews.InlineResponse2008
- realtimenews.InlineResponse2008Data
- realtimenews.InlineResponse2009
- realtimenews.InlineResponse2009Data
- realtimenews.InlineResponse2009DataDistributor
- realtimenews.InlineResponse200Data
- realtimenews.InlineResponse200DataCategories
- realtimenews.InlineResponse200DataDistributor
- realtimenews.InlineResponse200DataFsym
- realtimenews.InlineResponse200DataFsymSecurity
- realtimenews.InlineResponse200DataInstruments
- realtimenews.InlineResponse200DataLanguage
- realtimenews.InlineResponse200DataMedia
- realtimenews.InlineResponse200DataPublisher
- realtimenews.InlineResponse200DataTypes
- realtimenews.InlineResponse200Meta
- realtimenews.OffsetBasedPaginationOutputObject
- realtimenews.OffsetBasedPaginationOutputObjectWithoutTotal
- realtimenews.PartialOutputObject
- realtimenews.PostNewsArticleListByChainRequest
- realtimenews.PostNewsArticleListByChainRequestData
- realtimenews.PostNewsArticleListByChainRequestDataFilter
- realtimenews.PostNewsArticleListByIndexRequest
- realtimenews.PostNewsArticleListByIndexRequestData
- realtimenews.PostNewsArticleListByIndexRequestDataIdentifier
- realtimenews.PostNewsArticleListByInstrumentRequest
- realtimenews.PostNewsArticleListByInstrumentRequestData
- realtimenews.PostNewsArticleListByInstrumentRequestDataIdentifier
- realtimenews.PostNewsArticleListByMediaKindRequest
- realtimenews.PostNewsArticleListByMediaKindRequestData
- realtimenews.PostNewsArticleListRequest
- realtimenews.PostNewsArticleListRequestData
- realtimenews.PostNewsArticleListRequestDataFilter
- realtimenews.PostNewsArticleListRequestDataFilterCategories
- realtimenews.PostNewsArticleListRequestDataFilterDistributor
- realtimenews.PostNewsArticleListRequestDataFilterLanguage
- realtimenews.PostNewsArticleListRequestDataFilterPublisher
- realtimenews.PostNewsArticleListRequestDataFilterRange
- realtimenews.PostNewsArticleListRequestDataFilterRegions
- realtimenews.PostNewsArticleListRequestDataFilterTypes
- realtimenews.PostNewsArticleListRequestMeta
- realtimenews.PostNewsArticleListRequestMetaPagination
- realtimenews.PostNewsArticleListRequestMetaSubscription
- realtimenews.PostNewsArticleSearchByTextRequest
- realtimenews.PostNewsArticleSearchByTextRequestData
- realtimenews.PostNewsArticleSearchByTextRequestDataCategories
- realtimenews.PostNewsArticleSearchByTextRequestDataCriteria
- realtimenews.PostNewsArticleSearchByTextRequestDataDistributor
- realtimenews.PostNewsArticleSearchByTextRequestDataIndices
- realtimenews.PostNewsArticleSearchByTextRequestDataInstruments
- realtimenews.PostNewsArticleSearchByTextRequestDataLanguage
- realtimenews.PostNewsArticleSearchByTextRequestDataPublisher
- realtimenews.PostNewsArticleSearchByTextRequestDataRegions
- realtimenews.PostNewsArticleSearchByTextRequestDataText
- realtimenews.PostNewsArticleSearchByTextRequestDataTextCriteria
- realtimenews.PostNewsArticleSearchByTextRequestDataTypes
- realtimenews.PostNewsPublisherSearchByNameRequest
- realtimenews.PostNewsPublisherSearchByNameRequestData
- realtimenews.PostNewsPublisherSearchByNameRequestDataFilter
- realtimenews.PostNewsPublisherSearchByNameRequestDataFilterDelivery
- realtimenews.PostNewsPublisherSearchByNameRequestDataFilterDistributor
- realtimenews.PostNewsPublisherSearchByNameRequestMeta
- realtimenews.StatusObject
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.