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

v2.1.0

Published

FactSet Estimates client library for JavaScript

Downloads

173

Vulnerabilities

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

Links

Git

Maintainers

enterprisesdkenterprisesdkfdsfdstsouthmaydfdstsouthmaydfds

Keywords

FactSetAPISDK

Readme

FactSet

FactSet Estimates client library for JavaScript

API Version npm Apache-2 license

With global coverage since 1999, the FactSet Estimates API provides you with comprehensive estimates and statistics on a wide variety of financial statement items as well as industry-specific metrics. The universe is comprised of over 19,000 active companies across 90+ countries with the following types of data included:

  • Consensus
  • Detail
  • Ratings
  • Surprise
  • Segments
  • New Estimates and Ratings Reports Endpoints

For clients seeking curated and relevant financial data, the FactSet Estimates API now includes Estimates and Ratings Reports endpoints. These powerful endpoints are designed for easy integration and consumption, delivering a wide array of financial metrics, estimates, and critical statistics in a highly accessible format suitable for both mobile and web applications.

Whether you are an analyst, investor, or financial professional, the Estimates and Ratings Reports endpoints offer detailed and actionable financial insights that can support thorough analyses and strategic decision-making processes.

The Estimates and Ratings Reports endpoints are especially valuable for B2B2C applications, empowering financial services firms, investment companies, and corporate finance teams to:

  • Elevate Client Engagement: Enrich user experiences in client-facing applications with comprehensive and up-to-date financial metrics.

  • Build Custom Reporting Tools: Create tailored dashboards and analytics tools that provide deep insights and foster better financial understanding.

By adopting the FactSet Estimates API with its enriched Estimates and Ratings Reports endpoints, businesses can streamline their financial data integration process, improve operational efficiency, and deliver superior financial insights to their clients and end-users. This API is rate-limited to 10 requests per second and 10 concurrent requests per user.

Download API Specification

To programmatically download the FactSet Estimates API Specification file in .yaml format, utilize the link below. You must be authorized for this API to extract the specification. This specification can then be used for Codegen to create your own SDKs. You can also access it by selecting the "Download Spec" button beside the version information.

https://api.factset.com/content/factset-estimates/v2/spec/swagger.yaml

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

  • API version: 2.6.0
  • SDK version: 2.1.0
  • Build package: com.factset.sdk.codegen.FactSetJavascriptClientCodegen

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, BrokerDetailApi } = require('@factset/sdk-factsetestimates');
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 BrokerDetailApi();
const ids = ["AAPL-USA"]; // [String] | Security or Entity identifiers. FactSet Identifiers, tickers, CUSIP and SEDOL are accepted input. <p>***ids limit** =  3000 per request*</p> * Make Note - id limit of 3000 for defaults, otherwise the service is limited to a 30 second duration. This can be reached when increasing total number of metrics requested and depth of history. * 
const metrics = ["SALES"]; // [String] | Requested metrics. Use the /metrics endpoint to return a list of available estimate items. Note, the number of metrics you are allowed to supply is limited to 1 for now. **Top 10** most used metrics are **EPS, SALES, DPS, EBITDA,EBIT, PRICE_TGT, CFPS, BPS, NET_INC, and ASSETS**.  For more details, visit [Online Assistant Page #15034](https://oa.apps.factset.com/pages/15034). 
const opts = {
  'startDate': 2019-07-30, // String | Start date for point in time of estimates expressed in YYYY-MM-DD format.
  'endDate': 2019-08-30, // String | End date for point in time of estimates expressed in YYYY-MM-DD format.
  'frequency': D, // String | Controls the frequency of the data returned.   * **D** = Daily   * **W** = Weekly, based on the last day of the week of the start date.   * **AM** = Monthly, based on the start date (e.g., if the start date is June 16, data is displayed for June 16, May 16, April 16 etc.).         * **AQ** = Quarterly, based on the start date.   * **AY** = Actual Annual, based on the start date.  
  'periodicity': "'ANN'", // String | The periodicity for the estimates requested, allowing you to fetch Quarterly, Semi-Annual, and Annual Estimates.   * **ANN** - Annual   * **QTR** - Quarterly   * **SEMI** - Semi-Annual  
  'includeAll': false, // Boolean | Include All filter is used to identify included and excluded broker details from the consensus   By default the service would return only the brokers included in the consensus-   * **TRUE** = Returns all the brokers included and excluded in the consensus   * **FALSE** = Returns only the broker details included in the consensus    
  'fiscalPeriodStart': 2019, // String | Fiscal period start expressed in absolute date formats. Date that will fall back to most recent completed period during resolution.   * **Fiscal Quarter-end** - YYYY/FQ (e.g., 2019/1F, 2019/2F, 2019/3F, 2019/4F)   * **Fiscal Year-end** - YYYY (e.g. 2019) 
  'fiscalPeriodEnd': 2020, // String | Fiscal period start expressed in absolute date formats. Date that will fall back to most recent completed period during resolution.   * **Fiscal Quarter-end** - YYYY/FQ (e.g., 2019/1F, 2019/2F, 2019/3F, 2019/4F)   * **Fiscal Year-end** - YYYY (e.g. 2019) 
  'currency': USD // String | Currency code for adjusting the data. Use 'ESTIMATE' as input value for the values in Estimate Currency. For a list of currency ISO codes, visit [Online Assistant Page #1470](https://oa.apps.factset.com/pages/1470).
};

// Call api endpoint
apiInstance.getFixedDetail(ids, metrics, 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-factsetestimates');

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

Documentation for API Endpoints

All URIs are relative to https://api.factset.com/content

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- factsetestimates.BrokerDetailApi | getFixedDetail | GET /factset-estimates/v2/fixed-detail | Estimates detail data for fixed fiscal periods factsetestimates.BrokerDetailApi | getFixedDetailForList | POST /factset-estimates/v2/fixed-detail | Estimates detail data for fixed fiscal periods factsetestimates.BrokerDetailApi | getRollingDetail | GET /factset-estimates/v2/rolling-detail | FactSet estimates detail data for rolling fiscal periods factsetestimates.BrokerDetailApi | getRollingDetailForList | POST /factset-estimates/v2/rolling-detail | FactSet estimates detail data for rolling fiscal periods factsetestimates.ConsensusApi | getFixedConsensus | GET /factset-estimates/v2/fixed-consensus | Retrieves consensus estimates for a requested list of ids and fixed fiscal periods factsetestimates.ConsensusApi | getFixedConsensusForList | POST /factset-estimates/v2/fixed-consensus | FactSet consensus estimates for fixed fiscal periods factsetestimates.ConsensusApi | getRollingConsensus | GET /factset-estimates/v2/rolling-consensus | Retrieves consensus estimates for a requested list of ids and rolling fiscal periods. factsetestimates.ConsensusApi | getRollingConsensusForList | POST /factset-estimates/v2/rolling-consensus | Retrieves consensus estimates for a requested list of ids and rolling fiscal periods factsetestimates.DataItemsApi | getEstimateMetrics | GET /factset-estimates/v2/metrics | Available Estimate metrics factsetestimates.DataItemsApi | getEstimateMetricsForList | POST /factset-estimates/v2/metrics | Available Estimate metrics or ratios. factsetestimates.EstimatesAndRatingsReportsApi | getAnalystRatings | GET /factset-estimates/v2/company-reports/analyst-ratings | Retrieves the historical monthly view of analyst ratings for a given identifier. factsetestimates.EstimatesAndRatingsReportsApi | getEstimateTypes | GET /factset-estimates/v2/company-reports/estimate-types | Returns a list of valid estimate types. factsetestimates.EstimatesAndRatingsReportsApi | getEstimates | GET /factset-estimates/v2/company-reports/forecast | Returns forecasted estimates. factsetestimates.EstimatesAndRatingsReportsApi | getSurpriseHistory | GET /factset-estimates/v2/company-reports/surprise-history | Surprise History factsetestimates.RatingsApi | getConsensusRatings | GET /factset-estimates/v2/consensus-ratings | Ratings consensus estimates to fetch Buy, overWeight, Hold, underWeight, and Sell. factsetestimates.RatingsApi | getConsensusRatingsForList | POST /factset-estimates/v2/consensus-ratings | Ratings consensus estimates to fetch Buy, overWeight, Hold, underWeight, and Sell. factsetestimates.RatingsApi | getDetailRatings | GET /factset-estimates/v2/detail-ratings | Broker Detail estimates to fetch Buy, overWeight, Hold, underWeight, and Sell. factsetestimates.RatingsApi | getDetailRatingsForList | POST /factset-estimates/v2/detail-ratings | Broker Detail estimates to fetch Buy, overWeight, Hold, underWeight, and Sell. factsetestimates.SegmentsApi | getSegments | GET /factset-estimates/v2/segments | Retrieves product & geographic segment estimates for a requested list of ids and fiscal periods factsetestimates.SegmentsApi | getSegmentsForList | POST /factset-estimates/v2/segments | Retrieves product segment estimates for a requested list of ids and fiscal periods factsetestimates.SurpriseApi | getSurprise | GET /factset-estimates/v2/surprise | Surprise estimates for rolling fiscal periods factsetestimates.SurpriseApi | getSurpriseForList | POST /factset-estimates/v2/surprise | Surprise estimates for rolling fiscal periods

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.