[](https://www.factset.com)
# FactSet Estimates client library for Python
[]()
[](https://pypi.org/project/fds.sdk.FactSetEstimates/)
[](https://www.apache.org/licenses/LICENSE-2.0)
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.
<p>This API is rate-limited to 10 requests per second and 10 concurrent requests per user.</p>
**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](https://api.factset.com/content/factset-estimates/v2/spec/swagger.yaml)
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: 2.6.0
- SDK version: 1.2.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
## Requirements
* Python >= 3.7
## Installation
### Poetry
```shell
poetry add fds.sdk.utils fds.sdk.FactSetEstimates==1.2.0
```
### pip
```shell
pip install fds.sdk.utils fds.sdk.FactSetEstimates==1.2.0
```
## Usage
1. [Generate authentication credentials](../../../../README.md#authentication).
2. Setup Python environment.
1. Install and activate python 3.7+. If you're using [pyenv](https://github.com/pyenv/pyenv):
```sh
pyenv install 3.9.7
pyenv shell 3.9.7
```
2. (optional) [Install poetry](https://python-poetry.org/docs/#installation).
3. [Install dependencies](#installation).
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
```python
from fds.sdk.utils.authentication import ConfidentialClient
import fds.sdk.FactSetEstimates
from fds.sdk.FactSetEstimates.api import broker_detail_api
from fds.sdk.FactSetEstimates.models import *
from dateutil.parser import parse as dateutil_parser
from pprint import pprint
# See configuration.py for a list of all supported configuration parameters.
# 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-python#authentication
# for more information on using the ConfidentialClient class
configuration = fds.sdk.FactSetEstimates.Configuration(
fds_oauth_client=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
# configuration = fds.sdk.FactSetEstimates.Configuration(
# username='USERNAME-SERIAL',
# password='API-KEY'
# )
# Enter a context with an instance of the API client
with fds.sdk.FactSetEstimates.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = broker_detail_api.BrokerDetailApi(api_client)
ids = ["AAPL-USA"] # [str] | 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. *
metrics = ["SALES"] # [str] | 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).
start_date = "2019-07-30" # str | Start date for point in time of estimates expressed in YYYY-MM-DD format. (optional)
end_date = "2019-08-30" # str | End date for point in time of estimates expressed in YYYY-MM-DD format. (optional)
frequency = "D" # str | 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) if omitted the server will use the default value of "D"
periodicity = "ANN" # str | The periodicity for the estimates requested, allowing you to fetch Quarterly, Semi-Annual, and Annual Estimates. * **ANN** - Annual * **QTR** - Quarterly * **SEMI** - Semi-Annual (optional) if omitted the server will use the default value of "ANN"
include_all = 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) if omitted the server will use the default value of False
fiscal_period_start = "2019" # str | 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)
fiscal_period_end = "2020" # str | 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)
currency = "USD" # str | 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
# example passing only required values which don't have defaults set
# and optional values
api_response = api_instance.get_fixed_detail(ids, metrics, start_date=start_date, end_date=end_date, frequency=frequency, periodicity=periodicity, include_all=include_all, fiscal_period_start=fiscal_period_start, fiscal_period_end=fiscal_period_end, currency=currency)
pprint(api_response)
except fds.sdk.FactSetEstimates.ApiException as e:
print("Exception when calling BrokerDetailApi->get_fixed_detail: %s\n" % e)
# # Get response, http status code and response headers
# try:
# # Estimates detail data for fixed fiscal periods
# api_response, http_status_code, response_headers = api_instance.get_fixed_detail_with_http_info(ids, metrics, start_date=start_date, end_date=end_date, frequency=frequency, periodicity=periodicity, include_all=include_all, fiscal_period_start=fiscal_period_start, fiscal_period_end=fiscal_period_end, currency=currency)
# pprint(api_response)
# pprint(http_status_code)
# pprint(response_headers)
# except fds.sdk.FactSetEstimates.ApiException as e:
# print("Exception when calling BrokerDetailApi->get_fixed_detail: %s\n" % e)
# # Get response asynchronous
# try:
# # Estimates detail data for fixed fiscal periods
# async_result = api_instance.get_fixed_detail_async(ids, metrics, start_date=start_date, end_date=end_date, frequency=frequency, periodicity=periodicity, include_all=include_all, fiscal_period_start=fiscal_period_start, fiscal_period_end=fiscal_period_end, currency=currency)
# api_response = async_result.get()
# pprint(api_response)
# except fds.sdk.FactSetEstimates.ApiException as e:
# print("Exception when calling BrokerDetailApi->get_fixed_detail: %s\n" % e)
# # Get response, http status code and response headers asynchronous
# try:
# # Estimates detail data for fixed fiscal periods
# async_result = api_instance.get_fixed_detail_with_http_info_async(ids, metrics, start_date=start_date, end_date=end_date, frequency=frequency, periodicity=periodicity, include_all=include_all, fiscal_period_start=fiscal_period_start, fiscal_period_end=fiscal_period_end, currency=currency)
# api_response, http_status_code, response_headers = async_result.get()
# pprint(api_response)
# pprint(http_status_code)
# pprint(response_headers)
# except fds.sdk.FactSetEstimates.ApiException as e:
# print("Exception when calling BrokerDetailApi->get_fixed_detail: %s\n" % e)
```
### Using Pandas
To convert an API response to a Pandas DataFrame, it is necessary to transform it first to a dictionary.
```python
import pandas as pd
response_dict = api_response.to_dict()['data']
simple_json_response = pd.DataFrame(response_dict)
nested_json_response = pd.json_normalize(response_dict)
```
### Debugging
The SDK uses the standard library [`logging`](https://docs.python.org/3/library/logging.html#module-logging) module.
Setting `debug` to `True` on an instance of the `Configuration` class sets the log-level of related packages to `DEBUG`
and enables additional logging in Pythons [HTTP Client](https://docs.python.org/3/library/http.client.html).
**Note**: This prints out sensitive information (e.g. the full request and response). Use with care.
```python
import logging
import fds.sdk.FactSetEstimates
logging.basicConfig(level=logging.DEBUG)
configuration = fds.sdk.FactSetEstimates.Configuration(...)
configuration.debug = True
```
### Configure a Proxy
You can pass proxy settings to the Configuration class:
* `proxy`: The URL of the proxy to use.
* `proxy_headers`: a dictionary to pass additional headers to the proxy (e.g. `Proxy-Authorization`).
```python
import fds.sdk.FactSetEstimates
configuration = fds.sdk.FactSetEstimates.Configuration(
# ...
proxy="http://secret:password@localhost:5050",
proxy_headers={
"Custom-Proxy-Header": "Custom-Proxy-Header-Value"
}
)
```
### Custom SSL Certificate
TLS/SSL certificate verification can be configured with the following Configuration parameters:
* `ssl_ca_cert`: a path to the certificate to use for verification in `PEM` format.
* `verify_ssl`: setting this to `False` disables the verification of certificates.
Disabling the verification is not recommended, but it might be useful during
local development or testing.
```python
import fds.sdk.FactSetEstimates
configuration = fds.sdk.FactSetEstimates.Configuration(
# ...
ssl_ca_cert='/path/to/ca.pem'
)
```
### Request Retries
In case the request retry behaviour should be customized, it is possible to pass a `urllib3.Retry` object to the `retry` property of the Configuration.
```python
from urllib3 import Retry
import fds.sdk.FactSetEstimates
configuration = fds.sdk.FactSetEstimates.Configuration(
# ...
)
configuration.retries = Retry(total=3, status_forcelist=[500, 502, 503, 504])
```
## Documentation for API Endpoints
All URIs are relative to *https://api.factset.com/content*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*BrokerDetailApi* | [**get_fixed_detail**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/BrokerDetailApi.md#get_fixed_detail) | **GET** /factset-estimates/v2/fixed-detail | Estimates detail data for fixed fiscal periods
*BrokerDetailApi* | [**get_fixed_detail_for_list**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/BrokerDetailApi.md#get_fixed_detail_for_list) | **POST** /factset-estimates/v2/fixed-detail | Estimates detail data for fixed fiscal periods
*BrokerDetailApi* | [**get_rolling_detail**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/BrokerDetailApi.md#get_rolling_detail) | **GET** /factset-estimates/v2/rolling-detail | FactSet estimates detail data for rolling fiscal periods
*BrokerDetailApi* | [**get_rolling_detail_for_list**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/BrokerDetailApi.md#get_rolling_detail_for_list) | **POST** /factset-estimates/v2/rolling-detail | FactSet estimates detail data for rolling fiscal periods
*ConsensusApi* | [**get_fixed_consensus**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/ConsensusApi.md#get_fixed_consensus) | **GET** /factset-estimates/v2/fixed-consensus | Retrieves consensus estimates for a requested list of ids and fixed fiscal periods
*ConsensusApi* | [**get_fixed_consensus_for_list**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/ConsensusApi.md#get_fixed_consensus_for_list) | **POST** /factset-estimates/v2/fixed-consensus | FactSet consensus estimates for fixed fiscal periods
*ConsensusApi* | [**get_rolling_consensus**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/ConsensusApi.md#get_rolling_consensus) | **GET** /factset-estimates/v2/rolling-consensus | Retrieves consensus estimates for a requested list of ids and rolling fiscal periods.
*ConsensusApi* | [**get_rolling_consensus_for_list**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/ConsensusApi.md#get_rolling_consensus_for_list) | **POST** /factset-estimates/v2/rolling-consensus | Retrieves consensus estimates for a requested list of ids and rolling fiscal periods
*DataItemsApi* | [**get_estimate_metrics**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/DataItemsApi.md#get_estimate_metrics) | **GET** /factset-estimates/v2/metrics | Available Estimate metrics
*DataItemsApi* | [**get_estimate_metrics_for_list**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/DataItemsApi.md#get_estimate_metrics_for_list) | **POST** /factset-estimates/v2/metrics | Available Estimate metrics or ratios.
*EstimatesAndRatingsReportsApi* | [**get_estimate_types**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/EstimatesAndRatingsReportsApi.md#get_estimate_types) | **GET** /factset-estimates/v2/company-reports/estimate-types | Returns a list of valid estimate types.
*EstimatesAndRatingsReportsApi* | [**get_estimates**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/EstimatesAndRatingsReportsApi.md#get_estimates) | **GET** /factset-estimates/v2/company-reports/forecast | Returns forecasted estimates.
*EstimatesAndRatingsReportsApi* | [**get_surprise_history**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/EstimatesAndRatingsReportsApi.md#get_surprise_history) | **GET** /factset-estimates/v2/company-reports/surprise-history | Surprise History
*RatingsApi* | [**get_consensus_ratings**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/RatingsApi.md#get_consensus_ratings) | **GET** /factset-estimates/v2/consensus-ratings | Ratings consensus estimates to fetch Buy, overWeight, Hold, underWeight, and Sell.
*RatingsApi* | [**get_consensus_ratings_for_list**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/RatingsApi.md#get_consensus_ratings_for_list) | **POST** /factset-estimates/v2/consensus-ratings | Ratings consensus estimates to fetch Buy, overWeight, Hold, underWeight, and Sell.
*RatingsApi* | [**get_detail_ratings**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/RatingsApi.md#get_detail_ratings) | **GET** /factset-estimates/v2/detail-ratings | Broker Detail estimates to fetch Buy, overWeight, Hold, underWeight, and Sell.
*RatingsApi* | [**get_detail_ratings_for_list**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/RatingsApi.md#get_detail_ratings_for_list) | **POST** /factset-estimates/v2/detail-ratings | Broker Detail estimates to fetch Buy, overWeight, Hold, underWeight, and Sell.
*SegmentsApi* | [**get_segments**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/SegmentsApi.md#get_segments) | **GET** /factset-estimates/v2/segments | Retrieves product & geographic segment estimates for a requested list of ids and fiscal periods
*SegmentsApi* | [**get_segments_for_list**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/SegmentsApi.md#get_segments_for_list) | **POST** /factset-estimates/v2/segments | Retrieves product segment estimates for a requested list of ids and fiscal periods
*SurpriseApi* | [**get_surprise**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/SurpriseApi.md#get_surprise) | **GET** /factset-estimates/v2/surprise | Surprise estimates for rolling fiscal periods
*SurpriseApi* | [**get_surprise_for_list**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/SurpriseApi.md#get_surprise_for_list) | **POST** /factset-estimates/v2/surprise | Surprise estimates for rolling fiscal periods
## Documentation For Models
- [AnalystRating](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/AnalystRating.md)
- [AnalystRatingResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/AnalystRatingResponse.md)
- [Category](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/Category.md)
- [ConsensusEstimate](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/ConsensusEstimate.md)
- [ConsensusRatings](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/ConsensusRatings.md)
- [ConsensusRatingsRequest](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/ConsensusRatingsRequest.md)
- [ConsensusRatingsResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/ConsensusRatingsResponse.md)
- [ConsensusResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/ConsensusResponse.md)
- [DetailEstimate](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/DetailEstimate.md)
- [DetailRatings](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/DetailRatings.md)
- [DetailRatingsRequest](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/DetailRatingsRequest.md)
- [DetailRatingsResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/DetailRatingsResponse.md)
- [DetailResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/DetailResponse.md)
- [ErrorObject](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/ErrorObject.md)
- [ErrorResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/ErrorResponse.md)
- [ErrorResponseSubErrors](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/ErrorResponseSubErrors.md)
- [Estimate](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/Estimate.md)
- [EstimateResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/EstimateResponse.md)
- [EstimateResponseData](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/EstimateResponseData.md)
- [EstimateType](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/EstimateType.md)
- [EstimateTypesResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/EstimateTypesResponse.md)
- [FixedConsensusRequest](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/FixedConsensusRequest.md)
- [FixedDetailRequest](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/FixedDetailRequest.md)
- [Frequency](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/Frequency.md)
- [Ids](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/Ids.md)
- [Meta](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/Meta.md)
- [Metric](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/Metric.md)
- [Metrics](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/Metrics.md)
- [MetricsRequest](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/MetricsRequest.md)
- [MetricsResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/MetricsResponse.md)
- [Pagination](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/Pagination.md)
- [Periodicity](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/Periodicity.md)
- [PeriodicityDetail](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/PeriodicityDetail.md)
- [PeriodicitySurprise](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/PeriodicitySurprise.md)
- [RatingsCount](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/RatingsCount.md)
- [RollingConsensusRequest](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/RollingConsensusRequest.md)
- [RollingDetailRequest](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/RollingDetailRequest.md)
- [SegmentIds](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/SegmentIds.md)
- [SegmentType](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/SegmentType.md)
- [SegmentsEstimate](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/SegmentsEstimate.md)
- [SegmentsRequest](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/SegmentsRequest.md)
- [SegmentsResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/SegmentsResponse.md)
- [Statistic](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/Statistic.md)
- [Subcategory](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/Subcategory.md)
- [Surprise](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/Surprise.md)
- [SurpriseHistory](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/SurpriseHistory.md)
- [SurpriseHistoryResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/SurpriseHistoryResponse.md)
- [SurpriseHistoryResponseData](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/SurpriseHistoryResponseData.md)
- [SurpriseRequest](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/SurpriseRequest.md)
- [SurpriseResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/SurpriseResponse.md)
- [TargetPrice](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/TargetPrice.md)
## Documentation For Authorization
## FactSetApiKey
- **Type**: HTTP basic authentication
## FactSetOAuth2
- **Type**: OAuth
- **Flow**: application
- **Authorization URL**:
- **Scopes**: N/A
## Notes for Large OpenAPI documents
If the OpenAPI document is large, imports in fds.sdk.FactSetEstimates.apis and fds.sdk.FactSetEstimates.models may fail with a
RecursionError indicating the maximum recursion limit has been exceeded. In that case, there are a couple of solutions:
Solution 1:
Use specific imports for apis and models like:
- `from fds.sdk.FactSetEstimates.api.default_api import DefaultApi`
- `from fds.sdk.FactSetEstimates.model.pet import Pet`
Solution 2:
Before importing the package, adjust the maximum recursion limit as shown below:
```
import sys
sys.setrecursionlimit(1500)
import fds.sdk.FactSetEstimates
from fds.sdk.FactSetEstimates.apis import *
from fds.sdk.FactSetEstimates.models import *
```
## Contributing
Please refer to the [contributing guide](../../../../CONTRIBUTING.md).
## 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.
Raw data
{
"_id": null,
"home_page": "https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2",
"name": "fds.sdk.FactSetEstimates",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "FactSet, API, SDK",
"author": "FactSet Research Systems",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/f8/e5/94ecad9e53dc40e1d58681da82812512566e576ec5f207bd6e7fe7bc7829/fds.sdk.FactSetEstimates-1.2.0.tar.gz",
"platform": null,
"description": "[](https://www.factset.com)\n\n# FactSet Estimates client library for Python\n\n[]()\n[](https://pypi.org/project/fds.sdk.FactSetEstimates/)\n[](https://www.apache.org/licenses/LICENSE-2.0)\n\nWith 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:\n \n- **Consensus**\n- **Detail**\n- **Ratings**\n- **Surprise**\n- **Segments**\n- **New Estimates and Ratings Reports Endpoints**\n\nFor 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.\n \nWhether 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.\n \nThe Estimates and Ratings Reports endpoints are especially valuable for B2B2C applications, empowering financial services firms, investment companies, and corporate finance teams to:\n \n- **Elevate Client Engagement:** Enrich user experiences in client-facing applications with comprehensive and up-to-date financial metrics.\n\n- **Build Custom Reporting Tools:** Create tailored dashboards and analytics tools that provide deep insights and foster better financial understanding.\n\nBy 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.\n <p>This API is rate-limited to 10 requests per second and 10 concurrent requests per user.</p>\n\n**Download API Specification**\n \n 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.\n \n [https://api.factset.com/content/factset-estimates/v2/spec/swagger.yaml](https://api.factset.com/content/factset-estimates/v2/spec/swagger.yaml)\n\n\nThis Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:\n\n- API version: 2.6.0\n- SDK version: 1.2.0\n- Build package: org.openapitools.codegen.languages.PythonClientCodegen\n\n## Requirements\n\n* Python >= 3.7\n\n## Installation\n\n### Poetry\n\n```shell\npoetry add fds.sdk.utils fds.sdk.FactSetEstimates==1.2.0\n```\n\n### pip\n\n```shell\npip install fds.sdk.utils fds.sdk.FactSetEstimates==1.2.0\n```\n\n## Usage\n\n1. [Generate authentication credentials](../../../../README.md#authentication).\n2. Setup Python environment.\n 1. Install and activate python 3.7+. If you're using [pyenv](https://github.com/pyenv/pyenv):\n\n ```sh\n pyenv install 3.9.7\n pyenv shell 3.9.7\n ```\n\n 2. (optional) [Install poetry](https://python-poetry.org/docs/#installation).\n3. [Install dependencies](#installation).\n4. Run the following:\n\n> [!IMPORTANT]\n> The parameter variables defined below are just examples and may potentially contain non valid values. Please replace them with valid values.\n\n### Example Code\n\n```python\nfrom fds.sdk.utils.authentication import ConfidentialClient\n\nimport fds.sdk.FactSetEstimates\nfrom fds.sdk.FactSetEstimates.api import broker_detail_api\nfrom fds.sdk.FactSetEstimates.models import *\nfrom dateutil.parser import parse as dateutil_parser\nfrom pprint import pprint\n\n# See configuration.py for a list of all supported configuration parameters.\n\n# Examples for each supported authentication method are below,\n# choose one that satisfies your use case.\n\n# (Preferred) OAuth 2.0: FactSetOAuth2\n# See https://github.com/FactSet/enterprise-sdk#oauth-20\n# for information on how to create the app-config.json file\n#\n# The confidential client instance should be reused in production environments.\n# See https://github.com/FactSet/enterprise-sdk-utils-python#authentication\n# for more information on using the ConfidentialClient class\nconfiguration = fds.sdk.FactSetEstimates.Configuration(\n fds_oauth_client=ConfidentialClient('/path/to/app-config.json')\n)\n\n# Basic authentication: FactSetApiKey\n# See https://github.com/FactSet/enterprise-sdk#api-key\n# for information how to create an API key\n# configuration = fds.sdk.FactSetEstimates.Configuration(\n# username='USERNAME-SERIAL',\n# password='API-KEY'\n# )\n\n# Enter a context with an instance of the API client\nwith fds.sdk.FactSetEstimates.ApiClient(configuration) as api_client:\n # Create an instance of the API class\n api_instance = broker_detail_api.BrokerDetailApi(api_client)\n ids = [\"AAPL-USA\"] # [str] | 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. * \n metrics = [\"SALES\"] # [str] | 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). \n start_date = \"2019-07-30\" # str | Start date for point in time of estimates expressed in YYYY-MM-DD format. (optional)\n end_date = \"2019-08-30\" # str | End date for point in time of estimates expressed in YYYY-MM-DD format. (optional)\n frequency = \"D\" # str | 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) if omitted the server will use the default value of \"D\"\n periodicity = \"ANN\" # str | The periodicity for the estimates requested, allowing you to fetch Quarterly, Semi-Annual, and Annual Estimates. * **ANN** - Annual * **QTR** - Quarterly * **SEMI** - Semi-Annual (optional) if omitted the server will use the default value of \"ANN\"\n include_all = 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) if omitted the server will use the default value of False\n fiscal_period_start = \"2019\" # str | 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)\n fiscal_period_end = \"2020\" # str | 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)\n currency = \"USD\" # str | 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)\n\n try:\n # Estimates detail data for fixed fiscal periods\n # example passing only required values which don't have defaults set\n # and optional values\n api_response = api_instance.get_fixed_detail(ids, metrics, start_date=start_date, end_date=end_date, frequency=frequency, periodicity=periodicity, include_all=include_all, fiscal_period_start=fiscal_period_start, fiscal_period_end=fiscal_period_end, currency=currency)\n\n pprint(api_response)\n except fds.sdk.FactSetEstimates.ApiException as e:\n print(\"Exception when calling BrokerDetailApi->get_fixed_detail: %s\\n\" % e)\n\n # # Get response, http status code and response headers\n # try:\n # # Estimates detail data for fixed fiscal periods\n # api_response, http_status_code, response_headers = api_instance.get_fixed_detail_with_http_info(ids, metrics, start_date=start_date, end_date=end_date, frequency=frequency, periodicity=periodicity, include_all=include_all, fiscal_period_start=fiscal_period_start, fiscal_period_end=fiscal_period_end, currency=currency)\n\n\n # pprint(api_response)\n # pprint(http_status_code)\n # pprint(response_headers)\n # except fds.sdk.FactSetEstimates.ApiException as e:\n # print(\"Exception when calling BrokerDetailApi->get_fixed_detail: %s\\n\" % e)\n\n # # Get response asynchronous\n # try:\n # # Estimates detail data for fixed fiscal periods\n # async_result = api_instance.get_fixed_detail_async(ids, metrics, start_date=start_date, end_date=end_date, frequency=frequency, periodicity=periodicity, include_all=include_all, fiscal_period_start=fiscal_period_start, fiscal_period_end=fiscal_period_end, currency=currency)\n # api_response = async_result.get()\n\n\n # pprint(api_response)\n # except fds.sdk.FactSetEstimates.ApiException as e:\n # print(\"Exception when calling BrokerDetailApi->get_fixed_detail: %s\\n\" % e)\n\n # # Get response, http status code and response headers asynchronous\n # try:\n # # Estimates detail data for fixed fiscal periods\n # async_result = api_instance.get_fixed_detail_with_http_info_async(ids, metrics, start_date=start_date, end_date=end_date, frequency=frequency, periodicity=periodicity, include_all=include_all, fiscal_period_start=fiscal_period_start, fiscal_period_end=fiscal_period_end, currency=currency)\n # api_response, http_status_code, response_headers = async_result.get()\n\n\n # pprint(api_response)\n # pprint(http_status_code)\n # pprint(response_headers)\n # except fds.sdk.FactSetEstimates.ApiException as e:\n # print(\"Exception when calling BrokerDetailApi->get_fixed_detail: %s\\n\" % e)\n\n```\n\n### Using Pandas\n\nTo convert an API response to a Pandas DataFrame, it is necessary to transform it first to a dictionary.\n```python\nimport pandas as pd\n\nresponse_dict = api_response.to_dict()['data']\n\nsimple_json_response = pd.DataFrame(response_dict)\nnested_json_response = pd.json_normalize(response_dict)\n```\n\n### Debugging\n\nThe SDK uses the standard library [`logging`](https://docs.python.org/3/library/logging.html#module-logging) module.\n\nSetting `debug` to `True` on an instance of the `Configuration` class sets the log-level of related packages to `DEBUG`\nand enables additional logging in Pythons [HTTP Client](https://docs.python.org/3/library/http.client.html).\n\n**Note**: This prints out sensitive information (e.g. the full request and response). Use with care.\n\n```python\nimport logging\nimport fds.sdk.FactSetEstimates\n\nlogging.basicConfig(level=logging.DEBUG)\n\nconfiguration = fds.sdk.FactSetEstimates.Configuration(...)\nconfiguration.debug = True\n```\n\n### Configure a Proxy\n\nYou can pass proxy settings to the Configuration class:\n\n* `proxy`: The URL of the proxy to use.\n* `proxy_headers`: a dictionary to pass additional headers to the proxy (e.g. `Proxy-Authorization`).\n\n```python\nimport fds.sdk.FactSetEstimates\n\nconfiguration = fds.sdk.FactSetEstimates.Configuration(\n # ...\n proxy=\"http://secret:password@localhost:5050\",\n proxy_headers={\n \"Custom-Proxy-Header\": \"Custom-Proxy-Header-Value\"\n }\n)\n```\n\n### Custom SSL Certificate\n\nTLS/SSL certificate verification can be configured with the following Configuration parameters:\n\n* `ssl_ca_cert`: a path to the certificate to use for verification in `PEM` format.\n* `verify_ssl`: setting this to `False` disables the verification of certificates.\n Disabling the verification is not recommended, but it might be useful during\n local development or testing.\n\n```python\nimport fds.sdk.FactSetEstimates\n\nconfiguration = fds.sdk.FactSetEstimates.Configuration(\n # ...\n ssl_ca_cert='/path/to/ca.pem'\n)\n```\n\n### Request Retries\n\nIn case the request retry behaviour should be customized, it is possible to pass a `urllib3.Retry` object to the `retry` property of the Configuration.\n\n```python\nfrom urllib3 import Retry\nimport fds.sdk.FactSetEstimates\n\nconfiguration = fds.sdk.FactSetEstimates.Configuration(\n # ...\n)\n\nconfiguration.retries = Retry(total=3, status_forcelist=[500, 502, 503, 504])\n```\n\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *https://api.factset.com/content*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*BrokerDetailApi* | [**get_fixed_detail**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/BrokerDetailApi.md#get_fixed_detail) | **GET** /factset-estimates/v2/fixed-detail | Estimates detail data for fixed fiscal periods\n*BrokerDetailApi* | [**get_fixed_detail_for_list**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/BrokerDetailApi.md#get_fixed_detail_for_list) | **POST** /factset-estimates/v2/fixed-detail | Estimates detail data for fixed fiscal periods\n*BrokerDetailApi* | [**get_rolling_detail**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/BrokerDetailApi.md#get_rolling_detail) | **GET** /factset-estimates/v2/rolling-detail | FactSet estimates detail data for rolling fiscal periods\n*BrokerDetailApi* | [**get_rolling_detail_for_list**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/BrokerDetailApi.md#get_rolling_detail_for_list) | **POST** /factset-estimates/v2/rolling-detail | FactSet estimates detail data for rolling fiscal periods\n*ConsensusApi* | [**get_fixed_consensus**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/ConsensusApi.md#get_fixed_consensus) | **GET** /factset-estimates/v2/fixed-consensus | Retrieves consensus estimates for a requested list of ids and fixed fiscal periods\n*ConsensusApi* | [**get_fixed_consensus_for_list**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/ConsensusApi.md#get_fixed_consensus_for_list) | **POST** /factset-estimates/v2/fixed-consensus | FactSet consensus estimates for fixed fiscal periods\n*ConsensusApi* | [**get_rolling_consensus**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/ConsensusApi.md#get_rolling_consensus) | **GET** /factset-estimates/v2/rolling-consensus | Retrieves consensus estimates for a requested list of ids and rolling fiscal periods.\n*ConsensusApi* | [**get_rolling_consensus_for_list**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/ConsensusApi.md#get_rolling_consensus_for_list) | **POST** /factset-estimates/v2/rolling-consensus | Retrieves consensus estimates for a requested list of ids and rolling fiscal periods\n*DataItemsApi* | [**get_estimate_metrics**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/DataItemsApi.md#get_estimate_metrics) | **GET** /factset-estimates/v2/metrics | Available Estimate metrics\n*DataItemsApi* | [**get_estimate_metrics_for_list**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/DataItemsApi.md#get_estimate_metrics_for_list) | **POST** /factset-estimates/v2/metrics | Available Estimate metrics or ratios.\n*EstimatesAndRatingsReportsApi* | [**get_estimate_types**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/EstimatesAndRatingsReportsApi.md#get_estimate_types) | **GET** /factset-estimates/v2/company-reports/estimate-types | Returns a list of valid estimate types.\n*EstimatesAndRatingsReportsApi* | [**get_estimates**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/EstimatesAndRatingsReportsApi.md#get_estimates) | **GET** /factset-estimates/v2/company-reports/forecast | Returns forecasted estimates.\n*EstimatesAndRatingsReportsApi* | [**get_surprise_history**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/EstimatesAndRatingsReportsApi.md#get_surprise_history) | **GET** /factset-estimates/v2/company-reports/surprise-history | Surprise History\n*RatingsApi* | [**get_consensus_ratings**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/RatingsApi.md#get_consensus_ratings) | **GET** /factset-estimates/v2/consensus-ratings | Ratings consensus estimates to fetch Buy, overWeight, Hold, underWeight, and Sell.\n*RatingsApi* | [**get_consensus_ratings_for_list**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/RatingsApi.md#get_consensus_ratings_for_list) | **POST** /factset-estimates/v2/consensus-ratings | Ratings consensus estimates to fetch Buy, overWeight, Hold, underWeight, and Sell.\n*RatingsApi* | [**get_detail_ratings**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/RatingsApi.md#get_detail_ratings) | **GET** /factset-estimates/v2/detail-ratings | Broker Detail estimates to fetch Buy, overWeight, Hold, underWeight, and Sell.\n*RatingsApi* | [**get_detail_ratings_for_list**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/RatingsApi.md#get_detail_ratings_for_list) | **POST** /factset-estimates/v2/detail-ratings | Broker Detail estimates to fetch Buy, overWeight, Hold, underWeight, and Sell.\n*SegmentsApi* | [**get_segments**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/SegmentsApi.md#get_segments) | **GET** /factset-estimates/v2/segments | Retrieves product & geographic segment estimates for a requested list of ids and fiscal periods\n*SegmentsApi* | [**get_segments_for_list**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/SegmentsApi.md#get_segments_for_list) | **POST** /factset-estimates/v2/segments | Retrieves product segment estimates for a requested list of ids and fiscal periods\n*SurpriseApi* | [**get_surprise**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/SurpriseApi.md#get_surprise) | **GET** /factset-estimates/v2/surprise | Surprise estimates for rolling fiscal periods\n*SurpriseApi* | [**get_surprise_for_list**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/SurpriseApi.md#get_surprise_for_list) | **POST** /factset-estimates/v2/surprise | Surprise estimates for rolling fiscal periods\n\n\n## Documentation For Models\n\n - [AnalystRating](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/AnalystRating.md)\n - [AnalystRatingResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/AnalystRatingResponse.md)\n - [Category](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/Category.md)\n - [ConsensusEstimate](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/ConsensusEstimate.md)\n - [ConsensusRatings](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/ConsensusRatings.md)\n - [ConsensusRatingsRequest](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/ConsensusRatingsRequest.md)\n - [ConsensusRatingsResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/ConsensusRatingsResponse.md)\n - [ConsensusResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/ConsensusResponse.md)\n - [DetailEstimate](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/DetailEstimate.md)\n - [DetailRatings](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/DetailRatings.md)\n - [DetailRatingsRequest](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/DetailRatingsRequest.md)\n - [DetailRatingsResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/DetailRatingsResponse.md)\n - [DetailResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/DetailResponse.md)\n - [ErrorObject](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/ErrorObject.md)\n - [ErrorResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/ErrorResponse.md)\n - [ErrorResponseSubErrors](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/ErrorResponseSubErrors.md)\n - [Estimate](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/Estimate.md)\n - [EstimateResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/EstimateResponse.md)\n - [EstimateResponseData](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/EstimateResponseData.md)\n - [EstimateType](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/EstimateType.md)\n - [EstimateTypesResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/EstimateTypesResponse.md)\n - [FixedConsensusRequest](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/FixedConsensusRequest.md)\n - [FixedDetailRequest](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/FixedDetailRequest.md)\n - [Frequency](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/Frequency.md)\n - [Ids](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/Ids.md)\n - [Meta](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/Meta.md)\n - [Metric](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/Metric.md)\n - [Metrics](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/Metrics.md)\n - [MetricsRequest](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/MetricsRequest.md)\n - [MetricsResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/MetricsResponse.md)\n - [Pagination](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/Pagination.md)\n - [Periodicity](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/Periodicity.md)\n - [PeriodicityDetail](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/PeriodicityDetail.md)\n - [PeriodicitySurprise](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/PeriodicitySurprise.md)\n - [RatingsCount](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/RatingsCount.md)\n - [RollingConsensusRequest](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/RollingConsensusRequest.md)\n - [RollingDetailRequest](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/RollingDetailRequest.md)\n - [SegmentIds](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/SegmentIds.md)\n - [SegmentType](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/SegmentType.md)\n - [SegmentsEstimate](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/SegmentsEstimate.md)\n - [SegmentsRequest](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/SegmentsRequest.md)\n - [SegmentsResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/SegmentsResponse.md)\n - [Statistic](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/Statistic.md)\n - [Subcategory](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/Subcategory.md)\n - [Surprise](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/Surprise.md)\n - [SurpriseHistory](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/SurpriseHistory.md)\n - [SurpriseHistoryResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/SurpriseHistoryResponse.md)\n - [SurpriseHistoryResponseData](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/SurpriseHistoryResponseData.md)\n - [SurpriseRequest](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/SurpriseRequest.md)\n - [SurpriseResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/SurpriseResponse.md)\n - [TargetPrice](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/TargetPrice.md)\n\n\n## Documentation For Authorization\n\n\n## FactSetApiKey\n\n- **Type**: HTTP basic authentication\n\n\n## FactSetOAuth2\n\n- **Type**: OAuth\n- **Flow**: application\n- **Authorization URL**: \n- **Scopes**: N/A\n\n\n## Notes for Large OpenAPI documents\nIf the OpenAPI document is large, imports in fds.sdk.FactSetEstimates.apis and fds.sdk.FactSetEstimates.models may fail with a\nRecursionError indicating the maximum recursion limit has been exceeded. In that case, there are a couple of solutions:\n\nSolution 1:\nUse specific imports for apis and models like:\n- `from fds.sdk.FactSetEstimates.api.default_api import DefaultApi`\n- `from fds.sdk.FactSetEstimates.model.pet import Pet`\n\nSolution 2:\nBefore importing the package, adjust the maximum recursion limit as shown below:\n```\nimport sys\nsys.setrecursionlimit(1500)\nimport fds.sdk.FactSetEstimates\nfrom fds.sdk.FactSetEstimates.apis import *\nfrom fds.sdk.FactSetEstimates.models import *\n```\n\n## Contributing\n\nPlease refer to the [contributing guide](../../../../CONTRIBUTING.md).\n\n## Copyright\n\nCopyright 2022 FactSet Research Systems Inc\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n\n\n\n",
"bugtrack_url": null,
"license": "Apache License, Version 2.0",
"summary": "FactSet Estimates client library for Python",
"version": "1.2.0",
"project_urls": {
"Homepage": "https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2"
},
"split_keywords": [
"factset",
" api",
" sdk"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "25ce3fa6024441d7102b2e536014b654e623954ce2645e5be67515efbef0d53b",
"md5": "90a075a9caa06f3153fd4c5d7b0363d9",
"sha256": "be3448c841de6d917b21ae279dd7deae7f10a7191a4257b8a4d598d47c495214"
},
"downloads": -1,
"filename": "fds.sdk.FactSetEstimates-1.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "90a075a9caa06f3153fd4c5d7b0363d9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 287703,
"upload_time": "2024-11-06T11:52:55",
"upload_time_iso_8601": "2024-11-06T11:52:55.922392Z",
"url": "https://files.pythonhosted.org/packages/25/ce/3fa6024441d7102b2e536014b654e623954ce2645e5be67515efbef0d53b/fds.sdk.FactSetEstimates-1.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f8e594ecad9e53dc40e1d58681da82812512566e576ec5f207bd6e7fe7bc7829",
"md5": "5a37fe0d393dad59d026138800fcf6ed",
"sha256": "5c7f2bb6b9261709b0d666b5880e9de00d9c02ac5ea0d81f5cb7fb2f4cc20d67"
},
"downloads": -1,
"filename": "fds.sdk.FactSetEstimates-1.2.0.tar.gz",
"has_sig": false,
"md5_digest": "5a37fe0d393dad59d026138800fcf6ed",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 118757,
"upload_time": "2024-11-06T11:52:54",
"upload_time_iso_8601": "2024-11-06T11:52:54.515984Z",
"url": "https://files.pythonhosted.org/packages/f8/e5/94ecad9e53dc40e1d58681da82812512566e576ec5f207bd6e7fe7bc7829/fds.sdk.FactSetEstimates-1.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-06 11:52:54",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "FactSet",
"github_project": "enterprise-sdk",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "fds.sdk.factsetestimates"
}
JSON
