npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@factset/sdk-streetaccountnews

v2.1.0

Published

StreetAccount News client library for JavaScript

Downloads

73

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

fdsfdstsouthmaydfdstsouthmaydfdsenterprisesdkenterprisesdk

Keywords

FactSetAPISDK

Readme

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.

StreetAccount Historical Stories:

These endpoints provide access to historical StreetAccount (SA) news. The API delivers SA stories in XML format based on user-specified date input parameters. Output files are securely available to users through a URL. This API has three endpoints: Create, Status, and Get.

Please note that this API only supports adhoc requests for historical files and does not support real-time files. If real-time push is required, consider using other methods such as SFTP, QNT account, or Azure Storage. Both historical and real-time Street Account news can be delivered via SFTP, QNT account, or Azure Storage.

The files delivered contain both metadata and content body, eliminating the need for multiple requests through multiple services to retrieve all the information.

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

  • API version: 1.1.0
  • SDK version: 2.1.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

  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, 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);
  },
);

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-streetaccountnews');

const apiClient = ApiClient.instance;
apiClient.setProxyUrl('http://username:[email protected]:8080');

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.StreetAccountHistoricalStoriesApi | getFilesData | GET /historical/files/get | Returns the StreetAccount Historical data in files requested in the /historical/files/create endpoint. streetaccountnews.StreetAccountHistoricalStoriesApi | getStatusData | GET /historical/files/status | Returns the status of the request streetaccountnews.StreetAccountHistoricalStoriesApi | requestFiles | POST /historical/files/create | Requests the creation of StreetAccount News Files with historical data. 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.