FactSet.SDK.FactSetEstimates 1.1.5

Prefix Reserved
dotnet add package FactSet.SDK.FactSetEstimates --version 1.1.5                
NuGet\Install-Package FactSet.SDK.FactSetEstimates -Version 1.1.5                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="FactSet.SDK.FactSetEstimates" Version="1.1.5" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add FactSet.SDK.FactSetEstimates --version 1.1.5                
#r "nuget: FactSet.SDK.FactSetEstimates, 1.1.5"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install FactSet.SDK.FactSetEstimates as a Cake Addin
#addin nuget:?package=FactSet.SDK.FactSetEstimates&version=1.1.5

// Install FactSet.SDK.FactSetEstimates as a Cake Tool
#tool nuget:?package=FactSet.SDK.FactSetEstimates&version=1.1.5                

FactSet

FactSet Estimates client library for .NET

API Version Nuget Apache-2 license

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 .NET package is automatically generated by the OpenAPI Generator project:

  • API version: 2.5.0
  • SDK version: 1.1.5
  • Build package: com.factset.sdk.codegen.FactSetCSharpNetCoreClientCodegen

Requirements

  • .NET Standard >= 2.0

Installation

.NET CLI

dotnet add package FactSet.SDK.Utils
dotnet add package FactSet.SDK.FactSetEstimates -v 1.1.5

NuGet

nuget install FactSet.SDK.Utils
nuget install FactSet.SDK.FactSetEstimates -Version 1.1.5

Usage

  1. Generate authentication credentials.
  2. Setup .NET Standard 2.0 compatible environment.
  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

using System;
using System.Threading.Tasks;
using FactSet.SDK.Utils.Authentication;
using FactSet.SDK.FactSetEstimates.Api;
using FactSet.SDK.FactSetEstimates.Client;
using FactSet.SDK.FactSetEstimates.Model;

namespace Example
{
    public static class GetFixedDetailExample
    {
        public static async Task Main()
        {
            var config = new FactSet.SDK.FactSetEstimates.Client.Configuration();

            // 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-dotnet#authentication
            // for more information on using the ConfidentialClient class
            ConfidentialClient confidentialClient = await ConfidentialClient.CreateAsync("/path/to/app-config.json");
            config.OAuth2Client = confidentialClient;

            /* Basic authentication: FactSetApiKey */
            // See https://github.com/FactSet/enterprise-sdk#api-key
            // for information how to create an API key
            // config.Username = "USERNAME-SERIAL";
            // config.Password = "API-KEY";

            var apiInstance = new BrokerDetailApi(config);
            var ids = new List<string>(); // List<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. * 
            var metrics = new List<string>(); // List<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). 
            var startDate = "2019-07-30";  // string | Start date for point in time of estimates expressed in YYYY-MM-DD format. (optional) 
            var endDate = "2020-07-30";  // string | End date for point in time of estimates expressed in YYYY-MM-DD format. (optional) 
            var 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.   (optional)  (default to D)
            var 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   (optional)  (default to ANN)
            var includeAll = false;  // bool? | 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     (optional)  (default to false)
            var 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)  (optional) 
            var 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)  (optional) 
            var 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). (optional) 

            try
            {
                // Estimates detail data for fixed fiscal periods
                DetailResponse result = apiInstance.GetFixedDetail(ids, metrics, startDate, endDate, frequency, periodicity, includeAll, fiscalPeriodStart, fiscalPeriodEnd, currency);
                Console.WriteLine(result.ToJson());
            }
            catch (ApiException e)
            {
                Console.WriteLine("Exception when calling BrokerDetailApi.GetFixedDetail: " + e.Message );
                Console.WriteLine("Status Code: "+ e.ErrorCode);
                Console.WriteLine(e.StackTrace);
            }
        }
    }
}

Using a Proxy

To use the API client with a HTTP proxy, setup a System.Net.WebProxy

Configuration c = new Configuration();
System.Net.WebProxy webProxy = new System.Net.WebProxy("http://myProxyUrl:80/");
webProxy.Credentials = System.Net.CredentialCache.DefaultCredentials;
c.Proxy = webProxy;

Documentation for API Endpoints

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

Class Method HTTP request Description
BrokerDetailApi GetFixedDetail GET /factset-estimates/v2/fixed-detail Estimates detail data for fixed fiscal periods
BrokerDetailApi GetFixedDetailForList POST /factset-estimates/v2/fixed-detail Estimates detail data for fixed fiscal periods
BrokerDetailApi GetRollingDetail GET /factset-estimates/v2/rolling-detail FactSet estimates detail data for rolling fiscal periods
BrokerDetailApi GetRollingDetailForList POST /factset-estimates/v2/rolling-detail FactSet estimates detail data for rolling fiscal periods
ConsensusApi GetFixedConsensus GET /factset-estimates/v2/fixed-consensus Retrieves consensus estimates for a requested list of ids and fixed fiscal periods
ConsensusApi GetFixedConsensusForList POST /factset-estimates/v2/fixed-consensus FactSet consensus estimates for fixed fiscal periods
ConsensusApi GetRollingConsensus GET /factset-estimates/v2/rolling-consensus Retrieves consensus estimates for a requested list of ids and rolling fiscal periods.
ConsensusApi GetRollingConsensusForList POST /factset-estimates/v2/rolling-consensus Retrieves consensus estimates for a requested list of ids and rolling fiscal periods
DataItemsApi GetEstimateMetrics GET /factset-estimates/v2/metrics Available Estimate metrics
DataItemsApi GetEstimateMetricsForList POST /factset-estimates/v2/metrics Available Estimate metrics or ratios.
RatingsApi GetConsensusRatings GET /factset-estimates/v2/consensus-ratings Ratings consensus estimates to fetch Buy, Overweight, Hold, Underweight, and Sell.
RatingsApi GetConsensusRatingsForList POST /factset-estimates/v2/consensus-ratings Ratings consensus estimates to fetch Buy, Overweight, Hold, Underweight, and Sell.
RatingsApi GetDetailRatings GET /factset-estimates/v2/detail-ratings Broker Detail estimates to fetch Buy, Overweight, Hold, Underweight, and Sell.
RatingsApi GetDetailRatingsForList POST /factset-estimates/v2/detail-ratings Broker Detail estimates to fetch Buy, Overweight, Hold, Underweight, and Sell.
SegmentsApi GetSegments GET /factset-estimates/v2/segments Retrieves product & geographic segment estimates for a requested list of ids and fiscal periods
SegmentsApi GetSegmentsForList POST /factset-estimates/v2/segments Retrieves product segment estimates for a requested list of ids and fiscal periods
SurpriseApi GetSurprise GET /factset-estimates/v2/surprise Surprise estimates for rolling fiscal periods
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 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.

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.1.5 86 7/11/2024
1.1.4 110 4/10/2024
1.1.3 263 10/25/2023
1.1.2 130 8/30/2023
1.1.1 147 8/11/2023
1.1.0 140 7/11/2023
1.0.5 158 6/6/2023
1.0.4 141 5/11/2023
1.0.3 139 5/5/2023
1.0.2 226 3/1/2023
1.0.1 233 2/24/2023
1.0.0 375 8/31/2022
0.21.0 388 7/21/2022
0.20.0 393 5/24/2022
0.9.1 410 2/14/2022
0.9.0 410 2/2/2022

Refer to Changelog on GitHub source repository