❤
npm
Sign UpSign In

@factset/sdk-streetaccountnews

0.40.1 • Public • Published

FactSet

StreetAccount News client library for JavaScript

API Version npm Apache-2 license

The StreetAccount News API provides access to FactSet's proprietary news provider, StreetAccount. StreetAccount, is a premium real-time market intelligence news service that delivers comprehensive U.S., Canadian, and European coverage (and expanding Asia coverage). All possible sources for corporate news are scanned and key story facts are highlighted and presented in an easy-to-read format.

StreetAccount Filters, Headlines, and Views:

These endpoints allow for the retrieval of news headlines using filters such as Watchlists/Indices/Tickers, Categories (the equivalent of 'Subjects' within the Workstation), Market Topics, Regions, and Sectors. Headlines can also be retrieved based on saved views within the Workstation.

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

  • API version: 1.0.0
  • SDK version: 0.40.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-streetaccountnews@0.40.1

yarn

yarn add @factset/sdk-utils @factset/sdk-streetaccountnews@0.40.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:

[!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-streetaccountnews');
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 _atrributes are specified, all filters will be returned in the response (this is the default response). 
};

// Call api endpoint
apiInstance.getStreetAccountFilters(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/streetaccount/v1

Class Method HTTP request Description
streetaccountnews.FiltersApi getStreetAccountFilters GET /filters Retrieve all StreetAccount filters
streetaccountnews.FiltersApi getStreetAccountFiltersCategories GET /filters/categories Retrieve all StreetAccount filter categories
streetaccountnews.FiltersApi getStreetAccountFiltersRegions GET /filters/regions Retrieve all StreetAccount filter regions
streetaccountnews.FiltersApi getStreetAccountFiltersSectors GET /filters/sectors Retrieve all StreetAccount filter sectors
streetaccountnews.FiltersApi getStreetAccountFiltersTopics GET /filters/topics Retrieve all StreetAccount filter topics
streetaccountnews.FiltersApi getStreetAccountFiltersWatchlists GET /filters/watchlists Retrieve all StreetAccount filter watchlists
streetaccountnews.HeadlinesApi getStreetAccountHeadlines POST /headlines Retrieve StreetAccount headlines for given filters
streetaccountnews.HeadlinesApi getStreetAccountHeadlinesByView POST /headlines/view Retrieve StreetAccount headlines for given view
streetaccountnews.ViewsApi createQuickAlertForView POST /quick-alert/create Creates a quick-alert for given saved view
streetaccountnews.ViewsApi createStreetAccountView POST /views/create Creates and saves a StreetAccount view
streetaccountnews.ViewsApi deleteQuickalertView POST /quick-alert/delete Deletes an existing quick alert for a view.
streetaccountnews.ViewsApi deleteStreetAccountView POST /views/delete Deletes an existing StreetAccount view
streetaccountnews.ViewsApi editStreetAccountView POST /views/update Edits and saves an existing StreetAccount view
streetaccountnews.ViewsApi getStreetAccountViews GET /views Retrieves StreetAccount search views

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-streetaccountnews

Repository

github.com/factset/enterprise-sdk

Homepage

developer.factset.com/

Weekly Downloads

47

Version

0.40.1

License

Apache-2.0

Unpacked Size

325 kB

Total Files

77

Last publish

Collaborators

  • enterprisesdk
  • fds
  • tsouthmaydfds
Try on RunKit
Report malware