Socket
Socket
Sign inDemoInstall

@factset/sdk-streetaccountnews

Package Overview
Dependencies
54
Maintainers
3
Versions
5
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    @factset/sdk-streetaccountnews

StreetAccount News client library for JavaScript


Version published
Weekly downloads
15
decreased by-84.21%
Maintainers
3
Created
Weekly downloads
 

Readme

Source

FactSet

StreetAccount News client library for JavaScript

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
  • Package version: 0.40.0
  • 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.0

yarn

yarn add @factset/sdk-utils @factset/sdk-streetaccountnews@0.40.0

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

ClassMethodHTTP requestDescription
streetaccountnews.FiltersApigetStreetAccountFiltersGET /filtersRetrieve all StreetAccount filters
streetaccountnews.FiltersApigetStreetAccountFiltersCategoriesGET /filters/categoriesRetrieve all StreetAccount filter categories
streetaccountnews.FiltersApigetStreetAccountFiltersRegionsGET /filters/regionsRetrieve all StreetAccount filter regions
streetaccountnews.FiltersApigetStreetAccountFiltersSectorsGET /filters/sectorsRetrieve all StreetAccount filter sectors
streetaccountnews.FiltersApigetStreetAccountFiltersTopicsGET /filters/topicsRetrieve all StreetAccount filter topics
streetaccountnews.FiltersApigetStreetAccountFiltersWatchlistsGET /filters/watchlistsRetrieve all StreetAccount filter watchlists
streetaccountnews.HeadlinesApigetStreetAccountHeadlinesPOST /headlinesRetrieve StreetAccount headlines for given filters
streetaccountnews.HeadlinesApigetStreetAccountHeadlinesByViewPOST /headlines/viewRetrieve StreetAccount headlines for given view
streetaccountnews.ViewsApicreateQuickAlertForViewPOST /quick-alert/createCreates a quick-alert for given saved view
streetaccountnews.ViewsApicreateStreetAccountViewPOST /views/createCreates and saves a StreetAccount view
streetaccountnews.ViewsApideleteQuickalertViewPOST /quick-alert/deleteDeletes an existing quick alert for a view.
streetaccountnews.ViewsApideleteStreetAccountViewPOST /views/deleteDeletes an existing StreetAccount view
streetaccountnews.ViewsApieditStreetAccountViewPOST /views/updateEdits and saves an existing StreetAccount view
streetaccountnews.ViewsApigetStreetAccountViewsGET /viewsRetrieves 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 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 Apr 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