@factset/sdk-factsetestimates

FactSet Estimates client library for JavaScript

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
• Actuals
• 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.7.0
• SDK version: 2.3.0
• Build package: com.factset.sdk.codegen.FactSetJavascriptClientCodegen

Requirements

• Node.js >= 18

Installation

npm

npm install @factset/sdk-utils @factset/sdk-factsetestimates@2.3.0

yarn

yarn add @factset/sdk-utils @factset/sdk-factsetestimates@2.3.0

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, ActualsApi } = 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 ActualsApi();
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 = {
  'relativeFiscalStart': -2, // Number | Relative fiscal period, expressed as an integer, used to filter results. This is combined with the periodicity parameter to specify a relative estimate period. FactSet Estimates Actuals provides data for past periods. Therefore, the input for `relativeFiscalStart` must be an integer that is zero or less. For example, set to 0 and periodicity to ANN to ask for the current reported year (FY0). 
  'relativeFiscalEnd': 0, // Number | Relative fiscal period, expressed as an integer, used to filter results. This is combined with the periodicity parameter to specify a relative estimate period.Therefore, the input for `relativeFiscalEnd` must be an integer that is zero or less.  For example, set to -2 and periodicity to ANN to ask for two fiscal years before the latest (FY-2).
  'periodicity': "'ANN'", // String | The periodicity for the estimates requested, allowing you to fetch Quarterly, Semi-Annual, Annual, and NTMA/LTMA Estimates.   * **ANN** - Annual   * **QTR** - Quarterly   * **SEMI** - Semi-Annual    * **NTMA** - Next-Twelve-Months - Time-weighted Annual. Estimates use a percentage of annual estimates from two fiscal years to create an estimate based on the 12-month period. Visit [OA 16614](https://my.apps.factset.com/oa/pages/16614) for detail.   * **LTMA** - Last-Twelve-Months - Time-weighted Annual. Estimates use a percentage of annual estimates from two fiscal years to create an estimate based on the 12-month period. Visit [OA 16614](https://my.apps.factset.com/oa/pages/16614) for detail.    
  '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.getActuals(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:[e-mail]:8080');

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
factsetestimates.ActualsApi	getActuals	GET /factset-estimates/v2/actuals	Retrieves actuals for a requested list of ids and reported fiscal periods.
factsetestimates.ActualsApi	getActualsForList	POST /factset-estimates/v2/actuals	Retrieves actuals for a requested list of ids and reported fiscal periods.
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.SegmentActualsApi	getSegmentActuals	GET /factset-estimates/v2/segment-actuals	Retrieves Segment Actuals for a requested list of ids and reported fiscal periods.
factsetestimates.SegmentActualsApi	getSegmentActualsForList	POST /factset-estimates/v2/segment-actuals	Retrieves Segment Actuals for a requested list of ids and reported fiscal periods.
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

• factsetestimates.Actual
• factsetestimates.ActualsRequest
• factsetestimates.ActualsResponse
• factsetestimates.AnalystRating
• factsetestimates.AnalystRatingResponse
• factsetestimates.Category
• factsetestimates.CompanyReportsErrorResponse
• factsetestimates.ConsensusEstimate
• factsetestimates.ConsensusRatings
• factsetestimates.ConsensusRatingsRequest
• factsetestimates.ConsensusRatingsResponse
• factsetestimates.ConsensusResponse
• factsetestimates.DetailEstimate
• factsetestimates.DetailRatings
• factsetestimates.DetailRatingsRequest
• factsetestimates.DetailRatingsResponse
• factsetestimates.DetailResponse
• factsetestimates.ErrorObject
• factsetestimates.ErrorResponse
• factsetestimates.ErrorResponseSubErrors
• factsetestimates.Estimate
• factsetestimates.EstimateResponse
• factsetestimates.EstimateResponseData
• factsetestimates.EstimateType
• factsetestimates.EstimateTypesResponse
• factsetestimates.FixedConsensusRequest
• factsetestimates.FixedDetailRequest
• factsetestimates.Frequency
• factsetestimates.Meta
• factsetestimates.Metric
• factsetestimates.MetricsRequest
• factsetestimates.MetricsResponse
• factsetestimates.Pagination
• factsetestimates.Periodicity
• factsetestimates.PeriodicityDetail
• factsetestimates.PeriodicitySurprise
• factsetestimates.RatingsCount
• factsetestimates.RollingConsensusRequest
• factsetestimates.RollingDetailRequest
• factsetestimates.SegmentActuals
• factsetestimates.SegmentActualsRequest
• factsetestimates.SegmentActualsResponse
• factsetestimates.SegmentType
• factsetestimates.SegmentsEstimate
• factsetestimates.SegmentsRequest
• factsetestimates.SegmentsResponse
• factsetestimates.Statistic
• factsetestimates.Subcategory
• factsetestimates.Surprise
• factsetestimates.SurpriseHistory
• factsetestimates.SurpriseHistoryResponse
• factsetestimates.SurpriseHistoryResponseData
• factsetestimates.SurpriseRequest
• factsetestimates.SurpriseResponse
• factsetestimates.TargetPrice

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.