@factset/sdk-factsetnews NPM

FactSet News client library for JavaScript

The FactSet News API provides access to FactSet’s news alongside business logic that allows users to replicate views and functionality consistent with the experience provided by the Workstation. This API provides the ability to create views and pull news headlines based on specific filters. There are the filters available for News:

Watchlists/Indices/Tickers
Sources
Company Filters
Market Topics
Countries
Regions

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

API version: 1.0.0
SDK version: 0.1.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-factsetnews@0.1.1

yarn

yarn add @factset/sdk-utils @factset/sdk-factsetnews@0.1.1

Usage

Generate authentication credentials.
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.
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, FiltersApi } = require('@factset/sdk-factsetnews');
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 FiltersApi();
const opts = {
  'attributes': ["null"] // [String] | Pass a list of filters to return the respective type of filter. Accepted list values are \"structured\" and/or \"flattened\". If no _attributes are specified, all filters will be returned in the response (this is the default response). 
};

// Call api endpoint
apiInstance.getFilters(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-factsetnews');

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/content/news/v1

Class	Method	HTTP request	Description
factsetnews.FiltersApi	getFilters	GET /filters	Retrieve all FactSet News filters
factsetnews.FiltersApi	getNewsFiltersCategories	GET /filters/categories	Retrieve all News filter categories
factsetnews.FiltersApi	getNewsFiltersCountries	GET /filters/countries	Retrieve all News filter countries
factsetnews.FiltersApi	getNewsFiltersRegions	GET /filters/regions	Retrieve all News filter regions
factsetnews.FiltersApi	getNewsFiltersSources	GET /filters/sources	Retrieve all News filter sources
factsetnews.FiltersApi	getNewsFiltersTopics	GET /filters/topics	Retrieve all News filter topics
factsetnews.FiltersApi	getNewsFiltersWatchlists	GET /filters/watchlists	Retrieve all News filter watchlists
factsetnews.HeadlinesApi	getFactSetNewsHeadlines	POST /headlines	Retrieve FactSet News headlines for the given filters
factsetnews.HeadlinesApi	getFactSetNewsHeadlinesByView	POST /headlines/view	Retrieve FactSet News headlines for given view
factsetnews.ViewsApi	createFactSetNewsView	POST /views/create	Creates and saves a FactSet News view
factsetnews.ViewsApi	createQuickAlertForView	POST /quick-alert/create	Creates a quick-alert for given saved view
factsetnews.ViewsApi	deleteQuickalertView	POST /quick-alert/delete	Deletes an existing quick alert for a view.
factsetnews.ViewsApi	deleteView	POST /views/delete	Deletes an existing App view
factsetnews.ViewsApi	editFactSetNewsView	POST /views/update	Edit an existing FactSet News view with filters specified
factsetnews.ViewsApi	getFactSetNewsViews	GET /views	Retrieves a list of search views created in News app

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 proxy-agent superagent

0.1.1

8 months ago

0.1.0

9 months ago