FactSet Estimates client library for JavaScript

Gain access to 20+ years of comprehensive estimates and statistics of over 250+ estimated metrics, including financial statement items, product segments, geosegments, and industry metrics. FactSet's consensus estimates are aggregated from a wide base of over 800+ contributors and cover over 19,000 active companies across 90+ countries. Data returned can be accessed on the data frequencies based on quarterly, fiscal years, and calendar years. FactSet Estimates updates on a real time basis intraday (every 5 minutes). Updating times vary based on earning season vs. non-earning season but the goal is to have the data available to the client within a few hours that FactSet receives updated information. Often times updates times can be much faster as FactSet has always been known as one of the fastest estimate providers in the market.

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

• API version: 2.5.0
• Package version: 1.1.2
• Build package: org.openapitools.codegen.languages.JavascriptClientCodegen

Requirements

• Node.js >= 14

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 >=14. If you're using nvm:

      nvm install 16
      nvm use 16

   2. (optional) Install yarn.

3. Install dependencies.
4. Run the following:

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': 2020-07-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);
  },
);

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

• factsetestimates.Category
• factsetestimates.ConsensusEstimate
• factsetestimates.ConsensusRatings
• factsetestimates.ConsensusRatingsRequest
• factsetestimates.ConsensusRatingsResponse
• factsetestimates.ConsensusResponse
• factsetestimates.DetailEstimate
• factsetestimates.DetailRatings
• factsetestimates.DetailRatingsRequest
• factsetestimates.DetailRatingsResponse
• factsetestimates.DetailResponse
• factsetestimates.ErrorResponse
• factsetestimates.ErrorResponseSubErrors
• factsetestimates.FixedConsensusRequest
• factsetestimates.FixedDetailRequest
• factsetestimates.Frequency
• factsetestimates.Metric
• factsetestimates.MetricsRequest
• factsetestimates.MetricsResponse
• factsetestimates.Periodicity
• factsetestimates.PeriodicityDetail
• factsetestimates.PeriodicitySurprise
• factsetestimates.RollingConsensusRequest
• factsetestimates.RollingDetailRequest
• factsetestimates.SegmentType
• factsetestimates.SegmentsEstimate
• factsetestimates.SegmentsRequest
• factsetestimates.SegmentsResponse
• factsetestimates.Statistic
• factsetestimates.Subcategory
• factsetestimates.Surprise
• factsetestimates.SurpriseRequest
• factsetestimates.SurpriseResponse

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.