fds.sdk.FactSetEstimates 4.0.1__tar.gz → 4.2.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (108) hide show
  1. {fds_sdk_factsetestimates-4.0.1 → fds_sdk_factsetestimates-4.2.0}/PKG-INFO +10 -9
  2. {fds_sdk_factsetestimates-4.0.1 → fds_sdk_factsetestimates-4.2.0}/README.md +9 -8
  3. {fds_sdk_factsetestimates-4.0.1 → fds_sdk_factsetestimates-4.2.0}/fds/sdk/FactSetEstimates/__init__.py +2 -2
  4. {fds_sdk_factsetestimates-4.0.1 → fds_sdk_factsetestimates-4.2.0}/fds/sdk/FactSetEstimates/api/actuals_api.py +9 -9
  5. {fds_sdk_factsetestimates-4.0.1 → fds_sdk_factsetestimates-4.2.0}/fds/sdk/FactSetEstimates/api/broker_detail_api.py +51 -33
  6. {fds_sdk_factsetestimates-4.0.1 → fds_sdk_factsetestimates-4.2.0}/fds/sdk/FactSetEstimates/api/consensus_api.py +33 -33
  7. {fds_sdk_factsetestimates-4.0.1 → fds_sdk_factsetestimates-4.2.0}/fds/sdk/FactSetEstimates/api/data_items_api.py +51 -5
  8. {fds_sdk_factsetestimates-4.0.1 → fds_sdk_factsetestimates-4.2.0}/fds/sdk/FactSetEstimates/api/estimates_and_ratings_reports_api.py +1 -1
  9. {fds_sdk_factsetestimates-4.0.1 → fds_sdk_factsetestimates-4.2.0}/fds/sdk/FactSetEstimates/api/guidance_api.py +17 -17
  10. {fds_sdk_factsetestimates-4.0.1 → fds_sdk_factsetestimates-4.2.0}/fds/sdk/FactSetEstimates/api/ratings_api.py +21 -21
  11. {fds_sdk_factsetestimates-4.0.1 → fds_sdk_factsetestimates-4.2.0}/fds/sdk/FactSetEstimates/api/segment_actuals_api.py +5 -5
  12. {fds_sdk_factsetestimates-4.0.1 → fds_sdk_factsetestimates-4.2.0}/fds/sdk/FactSetEstimates/api/segments_api.py +25 -25
  13. {fds_sdk_factsetestimates-4.0.1 → fds_sdk_factsetestimates-4.2.0}/fds/sdk/FactSetEstimates/api/surprise_api.py +13 -13
  14. {fds_sdk_factsetestimates-4.0.1 → fds_sdk_factsetestimates-4.2.0}/fds/sdk/FactSetEstimates/api_client.py +2 -2
  15. {fds_sdk_factsetestimates-4.0.1 → fds_sdk_factsetestimates-4.2.0}/fds/sdk/FactSetEstimates/configuration.py +3 -3
  16. {fds_sdk_factsetestimates-4.0.1 → fds_sdk_factsetestimates-4.2.0}/fds/sdk/FactSetEstimates/exceptions.py +1 -1
  17. {fds_sdk_factsetestimates-4.0.1 → fds_sdk_factsetestimates-4.2.0}/fds/sdk/FactSetEstimates/model/actual.py +1 -1
  18. {fds_sdk_factsetestimates-4.0.1 → fds_sdk_factsetestimates-4.2.0}/fds/sdk/FactSetEstimates/model/actuals_request.py +1 -1
  19. {fds_sdk_factsetestimates-4.0.1 → fds_sdk_factsetestimates-4.2.0}/fds/sdk/FactSetEstimates/model/actuals_response.py +1 -1
  20. {fds_sdk_factsetestimates-4.0.1 → fds_sdk_factsetestimates-4.2.0}/fds/sdk/FactSetEstimates/model/analyst_rating.py +1 -1
  21. {fds_sdk_factsetestimates-4.0.1 → fds_sdk_factsetestimates-4.2.0}/fds/sdk/FactSetEstimates/model/analyst_rating_response.py +1 -1
  22. {fds_sdk_factsetestimates-4.0.1 → fds_sdk_factsetestimates-4.2.0}/fds/sdk/FactSetEstimates/model/broker_names.py +5 -5
  23. {fds_sdk_factsetestimates-4.0.1 → fds_sdk_factsetestimates-4.2.0}/fds/sdk/FactSetEstimates/model/category.py +1 -1
  24. {fds_sdk_factsetestimates-4.0.1 → fds_sdk_factsetestimates-4.2.0}/fds/sdk/FactSetEstimates/model/company_reports_error_response.py +1 -1
  25. {fds_sdk_factsetestimates-4.0.1 → fds_sdk_factsetestimates-4.2.0}/fds/sdk/FactSetEstimates/model/consensus_estimate.py +1 -1
  26. {fds_sdk_factsetestimates-4.0.1 → fds_sdk_factsetestimates-4.2.0}/fds/sdk/FactSetEstimates/model/consensus_ratings.py +1 -1
  27. {fds_sdk_factsetestimates-4.0.1 → fds_sdk_factsetestimates-4.2.0}/fds/sdk/FactSetEstimates/model/consensus_ratings_request.py +1 -1
  28. {fds_sdk_factsetestimates-4.0.1 → fds_sdk_factsetestimates-4.2.0}/fds/sdk/FactSetEstimates/model/consensus_ratings_response.py +1 -1
  29. {fds_sdk_factsetestimates-4.0.1 → fds_sdk_factsetestimates-4.2.0}/fds/sdk/FactSetEstimates/model/consensus_response.py +1 -1
  30. {fds_sdk_factsetestimates-4.0.1 → fds_sdk_factsetestimates-4.2.0}/fds/sdk/FactSetEstimates/model/detail_estimate.py +5 -1
  31. {fds_sdk_factsetestimates-4.0.1 → fds_sdk_factsetestimates-4.2.0}/fds/sdk/FactSetEstimates/model/detail_ratings.py +13 -1
  32. {fds_sdk_factsetestimates-4.0.1 → fds_sdk_factsetestimates-4.2.0}/fds/sdk/FactSetEstimates/model/detail_ratings_request.py +1 -1
  33. {fds_sdk_factsetestimates-4.0.1 → fds_sdk_factsetestimates-4.2.0}/fds/sdk/FactSetEstimates/model/detail_ratings_response.py +1 -1
  34. {fds_sdk_factsetestimates-4.0.1 → fds_sdk_factsetestimates-4.2.0}/fds/sdk/FactSetEstimates/model/detail_response.py +1 -1
  35. {fds_sdk_factsetestimates-4.0.1 → fds_sdk_factsetestimates-4.2.0}/fds/sdk/FactSetEstimates/model/error_object.py +1 -1
  36. {fds_sdk_factsetestimates-4.0.1 → fds_sdk_factsetestimates-4.2.0}/fds/sdk/FactSetEstimates/model/error_response.py +1 -1
  37. {fds_sdk_factsetestimates-4.0.1 → fds_sdk_factsetestimates-4.2.0}/fds/sdk/FactSetEstimates/model/error_response_sub_errors.py +1 -1
  38. {fds_sdk_factsetestimates-4.0.1 → fds_sdk_factsetestimates-4.2.0}/fds/sdk/FactSetEstimates/model/estimate.py +1 -1
  39. {fds_sdk_factsetestimates-4.0.1 → fds_sdk_factsetestimates-4.2.0}/fds/sdk/FactSetEstimates/model/estimate_response.py +1 -1
  40. {fds_sdk_factsetestimates-4.0.1 → fds_sdk_factsetestimates-4.2.0}/fds/sdk/FactSetEstimates/model/estimate_response_data.py +1 -1
  41. {fds_sdk_factsetestimates-4.0.1 → fds_sdk_factsetestimates-4.2.0}/fds/sdk/FactSetEstimates/model/estimate_type.py +1 -1
  42. {fds_sdk_factsetestimates-4.0.1 → fds_sdk_factsetestimates-4.2.0}/fds/sdk/FactSetEstimates/model/estimate_types_response.py +1 -1
  43. {fds_sdk_factsetestimates-4.0.1 → fds_sdk_factsetestimates-4.2.0}/fds/sdk/FactSetEstimates/model/fixed_consensus_request.py +1 -1
  44. {fds_sdk_factsetestimates-4.0.1 → fds_sdk_factsetestimates-4.2.0}/fds/sdk/FactSetEstimates/model/fixed_detail_request.py +5 -1
  45. {fds_sdk_factsetestimates-4.0.1 → fds_sdk_factsetestimates-4.2.0}/fds/sdk/FactSetEstimates/model/frequency.py +1 -1
  46. {fds_sdk_factsetestimates-4.0.1 → fds_sdk_factsetestimates-4.2.0}/fds/sdk/FactSetEstimates/model/guidance.py +1 -1
  47. {fds_sdk_factsetestimates-4.0.1 → fds_sdk_factsetestimates-4.2.0}/fds/sdk/FactSetEstimates/model/guidance_request.py +1 -1
  48. {fds_sdk_factsetestimates-4.0.1 → fds_sdk_factsetestimates-4.2.0}/fds/sdk/FactSetEstimates/model/guidance_request_body.py +1 -1
  49. {fds_sdk_factsetestimates-4.0.1 → fds_sdk_factsetestimates-4.2.0}/fds/sdk/FactSetEstimates/model/guidance_response.py +1 -1
  50. {fds_sdk_factsetestimates-4.0.1 → fds_sdk_factsetestimates-4.2.0}/fds/sdk/FactSetEstimates/model/ids.py +1 -1
  51. fds_sdk_factsetestimates-4.2.0/fds/sdk/FactSetEstimates/model/ids_segments.py +283 -0
  52. {fds_sdk_factsetestimates-4.0.1 → fds_sdk_factsetestimates-4.2.0}/fds/sdk/FactSetEstimates/model/meta.py +1 -1
  53. {fds_sdk_factsetestimates-4.0.1 → fds_sdk_factsetestimates-4.2.0}/fds/sdk/FactSetEstimates/model/metric.py +1 -1
  54. {fds_sdk_factsetestimates-4.0.1 → fds_sdk_factsetestimates-4.2.0}/fds/sdk/FactSetEstimates/model/metric_segment_detail.py +1 -1
  55. {fds_sdk_factsetestimates-4.0.1 → fds_sdk_factsetestimates-4.2.0}/fds/sdk/FactSetEstimates/model/metric_segments.py +1 -1
  56. {fds_sdk_factsetestimates-4.0.1 → fds_sdk_factsetestimates-4.2.0}/fds/sdk/FactSetEstimates/model/metrics.py +1 -4
  57. {fds_sdk_factsetestimates-4.0.1 → fds_sdk_factsetestimates-4.2.0}/fds/sdk/FactSetEstimates/model/metrics_request.py +1 -1
  58. {fds_sdk_factsetestimates-4.0.1 → fds_sdk_factsetestimates-4.2.0}/fds/sdk/FactSetEstimates/model/metrics_response.py +1 -1
  59. {fds_sdk_factsetestimates-4.0.1 → fds_sdk_factsetestimates-4.2.0}/fds/sdk/FactSetEstimates/model/metrics_segment_detail_response.py +1 -1
  60. {fds_sdk_factsetestimates-4.0.1 → fds_sdk_factsetestimates-4.2.0}/fds/sdk/FactSetEstimates/model/pagination.py +1 -1
  61. {fds_sdk_factsetestimates-4.0.1 → fds_sdk_factsetestimates-4.2.0}/fds/sdk/FactSetEstimates/model/periodicity.py +6 -6
  62. {fds_sdk_factsetestimates-4.0.1 → fds_sdk_factsetestimates-4.2.0}/fds/sdk/FactSetEstimates/model/periodicity_detail.py +1 -1
  63. {fds_sdk_factsetestimates-4.0.1 → fds_sdk_factsetestimates-4.2.0}/fds/sdk/FactSetEstimates/model/periodicity_surprise.py +1 -1
  64. {fds_sdk_factsetestimates-4.0.1 → fds_sdk_factsetestimates-4.2.0}/fds/sdk/FactSetEstimates/model/ratings_count.py +1 -1
  65. {fds_sdk_factsetestimates-4.0.1 → fds_sdk_factsetestimates-4.2.0}/fds/sdk/FactSetEstimates/model/relative_fiscal_end.py +1 -1
  66. {fds_sdk_factsetestimates-4.0.1 → fds_sdk_factsetestimates-4.2.0}/fds/sdk/FactSetEstimates/model/relative_fiscal_end_actuals.py +1 -1
  67. {fds_sdk_factsetestimates-4.0.1 → fds_sdk_factsetestimates-4.2.0}/fds/sdk/FactSetEstimates/model/relative_fiscal_start.py +1 -1
  68. {fds_sdk_factsetestimates-4.0.1 → fds_sdk_factsetestimates-4.2.0}/fds/sdk/FactSetEstimates/model/relative_fiscal_start_actuals.py +1 -1
  69. {fds_sdk_factsetestimates-4.0.1 → fds_sdk_factsetestimates-4.2.0}/fds/sdk/FactSetEstimates/model/rolling_consensus_request.py +1 -1
  70. {fds_sdk_factsetestimates-4.0.1 → fds_sdk_factsetestimates-4.2.0}/fds/sdk/FactSetEstimates/model/rolling_detail_request.py +5 -1
  71. {fds_sdk_factsetestimates-4.0.1 → fds_sdk_factsetestimates-4.2.0}/fds/sdk/FactSetEstimates/model/segment_actuals.py +1 -1
  72. {fds_sdk_factsetestimates-4.0.1 → fds_sdk_factsetestimates-4.2.0}/fds/sdk/FactSetEstimates/model/segment_actuals_request.py +1 -1
  73. {fds_sdk_factsetestimates-4.0.1 → fds_sdk_factsetestimates-4.2.0}/fds/sdk/FactSetEstimates/model/segment_actuals_response.py +1 -1
  74. {fds_sdk_factsetestimates-4.0.1 → fds_sdk_factsetestimates-4.2.0}/fds/sdk/FactSetEstimates/model/segment_id.py +1 -1
  75. {fds_sdk_factsetestimates-4.0.1 → fds_sdk_factsetestimates-4.2.0}/fds/sdk/FactSetEstimates/model/segment_ids.py +1 -1
  76. {fds_sdk_factsetestimates-4.0.1 → fds_sdk_factsetestimates-4.2.0}/fds/sdk/FactSetEstimates/model/segment_type.py +1 -1
  77. {fds_sdk_factsetestimates-4.0.1 → fds_sdk_factsetestimates-4.2.0}/fds/sdk/FactSetEstimates/model/segments_details_estimate.py +1 -1
  78. {fds_sdk_factsetestimates-4.0.1 → fds_sdk_factsetestimates-4.2.0}/fds/sdk/FactSetEstimates/model/segments_details_request.py +1 -1
  79. {fds_sdk_factsetestimates-4.0.1 → fds_sdk_factsetestimates-4.2.0}/fds/sdk/FactSetEstimates/model/segments_details_response.py +1 -1
  80. {fds_sdk_factsetestimates-4.0.1 → fds_sdk_factsetestimates-4.2.0}/fds/sdk/FactSetEstimates/model/segments_estimate.py +1 -1
  81. {fds_sdk_factsetestimates-4.0.1 → fds_sdk_factsetestimates-4.2.0}/fds/sdk/FactSetEstimates/model/segments_metrics.py +1 -1
  82. {fds_sdk_factsetestimates-4.0.1 → fds_sdk_factsetestimates-4.2.0}/fds/sdk/FactSetEstimates/model/segments_request.py +6 -6
  83. {fds_sdk_factsetestimates-4.0.1 → fds_sdk_factsetestimates-4.2.0}/fds/sdk/FactSetEstimates/model/segments_response.py +1 -1
  84. {fds_sdk_factsetestimates-4.0.1 → fds_sdk_factsetestimates-4.2.0}/fds/sdk/FactSetEstimates/model/statistic.py +1 -1
  85. {fds_sdk_factsetestimates-4.0.1 → fds_sdk_factsetestimates-4.2.0}/fds/sdk/FactSetEstimates/model/subcategory.py +1 -1
  86. {fds_sdk_factsetestimates-4.0.1 → fds_sdk_factsetestimates-4.2.0}/fds/sdk/FactSetEstimates/model/surprise.py +1 -1
  87. {fds_sdk_factsetestimates-4.0.1 → fds_sdk_factsetestimates-4.2.0}/fds/sdk/FactSetEstimates/model/surprise_history.py +1 -1
  88. {fds_sdk_factsetestimates-4.0.1 → fds_sdk_factsetestimates-4.2.0}/fds/sdk/FactSetEstimates/model/surprise_history_response.py +1 -1
  89. {fds_sdk_factsetestimates-4.0.1 → fds_sdk_factsetestimates-4.2.0}/fds/sdk/FactSetEstimates/model/surprise_history_response_data.py +1 -1
  90. {fds_sdk_factsetestimates-4.0.1 → fds_sdk_factsetestimates-4.2.0}/fds/sdk/FactSetEstimates/model/surprise_request.py +1 -1
  91. {fds_sdk_factsetestimates-4.0.1 → fds_sdk_factsetestimates-4.2.0}/fds/sdk/FactSetEstimates/model/surprise_response.py +1 -1
  92. {fds_sdk_factsetestimates-4.0.1 → fds_sdk_factsetestimates-4.2.0}/fds/sdk/FactSetEstimates/model/target_price.py +1 -1
  93. {fds_sdk_factsetestimates-4.0.1 → fds_sdk_factsetestimates-4.2.0}/fds/sdk/FactSetEstimates/model_utils.py +1 -1
  94. {fds_sdk_factsetestimates-4.0.1 → fds_sdk_factsetestimates-4.2.0}/fds/sdk/FactSetEstimates/models/__init__.py +1 -0
  95. {fds_sdk_factsetestimates-4.0.1 → fds_sdk_factsetestimates-4.2.0}/fds/sdk/FactSetEstimates/rest.py +1 -1
  96. {fds_sdk_factsetestimates-4.0.1 → fds_sdk_factsetestimates-4.2.0}/fds.sdk.FactSetEstimates.egg-info/PKG-INFO +10 -9
  97. {fds_sdk_factsetestimates-4.0.1 → fds_sdk_factsetestimates-4.2.0}/fds.sdk.FactSetEstimates.egg-info/SOURCES.txt +1 -0
  98. {fds_sdk_factsetestimates-4.0.1 → fds_sdk_factsetestimates-4.2.0}/setup.py +2 -2
  99. {fds_sdk_factsetestimates-4.0.1 → fds_sdk_factsetestimates-4.2.0}/LICENSE +0 -0
  100. {fds_sdk_factsetestimates-4.0.1 → fds_sdk_factsetestimates-4.2.0}/fds/__init__.py +0 -0
  101. {fds_sdk_factsetestimates-4.0.1 → fds_sdk_factsetestimates-4.2.0}/fds/sdk/FactSetEstimates/api/__init__.py +0 -0
  102. {fds_sdk_factsetestimates-4.0.1 → fds_sdk_factsetestimates-4.2.0}/fds/sdk/FactSetEstimates/apis/__init__.py +0 -0
  103. {fds_sdk_factsetestimates-4.0.1 → fds_sdk_factsetestimates-4.2.0}/fds/sdk/FactSetEstimates/model/__init__.py +0 -0
  104. {fds_sdk_factsetestimates-4.0.1 → fds_sdk_factsetestimates-4.2.0}/fds/sdk/__init__.py +0 -0
  105. {fds_sdk_factsetestimates-4.0.1 → fds_sdk_factsetestimates-4.2.0}/fds.sdk.FactSetEstimates.egg-info/dependency_links.txt +0 -0
  106. {fds_sdk_factsetestimates-4.0.1 → fds_sdk_factsetestimates-4.2.0}/fds.sdk.FactSetEstimates.egg-info/requires.txt +0 -0
  107. {fds_sdk_factsetestimates-4.0.1 → fds_sdk_factsetestimates-4.2.0}/fds.sdk.FactSetEstimates.egg-info/top_level.txt +0 -0
  108. {fds_sdk_factsetestimates-4.0.1 → fds_sdk_factsetestimates-4.2.0}/setup.cfg +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: fds.sdk.FactSetEstimates
3
- Version: 4.0.1
3
+ Version: 4.2.0
4
4
  Summary: FactSet Estimates client library for Python
5
5
  Home-page: https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2
6
6
  Author: FactSet Research Systems
@@ -27,8 +27,8 @@ Dynamic: summary
27
27
 
28
28
  # FactSet Estimates client library for Python
29
29
 
30
- [![API Version](https://img.shields.io/badge/api-v2.9.1-blue)]()
31
- [![PyPi](https://img.shields.io/pypi/v/fds.sdk.FactSetEstimates/4.0.1)](https://pypi.org/project/fds.sdk.FactSetEstimates/v/4.0.1)
30
+ [![API Version](https://img.shields.io/badge/api-v2.11.1-blue)]()
31
+ [![PyPi](https://img.shields.io/pypi/v/fds.sdk.FactSetEstimates/4.2.0)](https://pypi.org/project/fds.sdk.FactSetEstimates/v/4.2.0)
32
32
  [![Apache-2 license](https://img.shields.io/badge/license-Apache2-brightgreen.svg)](https://www.apache.org/licenses/LICENSE-2.0)
33
33
 
34
34
  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:
@@ -66,8 +66,8 @@ All endpoints, except /company-reports/* and /metrics are limited to a quota of
66
66
 
67
67
  This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
68
68
 
69
- - API version: 2.9.1
70
- - SDK version: 4.0.1
69
+ - API version: 2.11.1
70
+ - SDK version: 4.2.0
71
71
  - Build package: org.openapitools.codegen.languages.PythonClientCodegen
72
72
 
73
73
  ## Requirements
@@ -79,13 +79,13 @@ This Python package is automatically generated by the [OpenAPI Generator](https:
79
79
  ### Poetry
80
80
 
81
81
  ```shell
82
- poetry add fds.sdk.utils fds.sdk.FactSetEstimates==4.0.1
82
+ poetry add fds.sdk.utils fds.sdk.FactSetEstimates==4.2.0
83
83
  ```
84
84
 
85
85
  ### pip
86
86
 
87
87
  ```shell
88
- pip install fds.sdk.utils fds.sdk.FactSetEstimates==4.0.1
88
+ pip install fds.sdk.utils fds.sdk.FactSetEstimates==4.2.0
89
89
  ```
90
90
 
91
91
  ## Usage
@@ -146,10 +146,10 @@ with fds.sdk.FactSetEstimates.ApiClient(configuration) as api_client:
146
146
  # Create an instance of the API class
147
147
  api_instance = actuals_api.ActualsApi(api_client)
148
148
  ids = ["AAPL-USA"] # [str] | Security or Entity identifiers. Accepted inputs include FactSet Identifiers, tickers, CUSIP, and SEDOL. <p><b>Performance Note:</b> Requests that increase the number of metrics or request long historical data may trigger the 30-second service timeout threshold. To ensure system stability and performance, please keep requests lightweight.</p> <p>If requesting long historical data, limit the history to <b>10 years per metric per ID</b>.</p>
149
- metrics = ["SALES"] # [str] | Requested metrics. Use the `/metrics` endpoint to return a list of available estimate items. **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).
149
+ metrics = ["SALES"] # [str] | Requested metrics. Use the `/metrics` endpoint to return a list of available estimate items. **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).
150
150
  relative_fiscal_start = -2 # int | 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). (optional)
151
151
  relative_fiscal_end = 0 # int | 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). (optional)
152
- periodicity = "ANN" # str | 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. (optional) if omitted the server will use the default value of "ANN"
152
+ periodicity = "ANN" # str | The periodicity for the estimates requested, allowing you to fetch Quarterly, Semi-Annual, Annual, Next-Twelve-Months, and Last-Twelve-Months Estimates. * **ANN** - Annual * **QTR** - Quarterly * **SEMI** - Semi-Annual * **NTMA** - Next-Twelve-Months * **LTMA** - Last-Twelve-Months (optional) if omitted the server will use the default value of "ANN"
153
153
  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)
154
154
 
155
155
  try:
@@ -358,6 +358,7 @@ Class | Method | HTTP request | Description
358
358
  - [GuidanceRequestBody](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/GuidanceRequestBody.md)
359
359
  - [GuidanceResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/GuidanceResponse.md)
360
360
  - [Ids](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/Ids.md)
361
+ - [IdsSegments](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/IdsSegments.md)
361
362
  - [Meta](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/Meta.md)
362
363
  - [Metric](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/Metric.md)
363
364
  - [MetricSegmentDetail](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/MetricSegmentDetail.md)
@@ -2,8 +2,8 @@
2
2
 
3
3
  # FactSet Estimates client library for Python
4
4
 
5
- [![API Version](https://img.shields.io/badge/api-v2.9.1-blue)]()
6
- [![PyPi](https://img.shields.io/pypi/v/fds.sdk.FactSetEstimates/4.0.1)](https://pypi.org/project/fds.sdk.FactSetEstimates/v/4.0.1)
5
+ [![API Version](https://img.shields.io/badge/api-v2.11.1-blue)]()
6
+ [![PyPi](https://img.shields.io/pypi/v/fds.sdk.FactSetEstimates/4.2.0)](https://pypi.org/project/fds.sdk.FactSetEstimates/v/4.2.0)
7
7
  [![Apache-2 license](https://img.shields.io/badge/license-Apache2-brightgreen.svg)](https://www.apache.org/licenses/LICENSE-2.0)
8
8
 
9
9
  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:
@@ -41,8 +41,8 @@ All endpoints, except /company-reports/* and /metrics are limited to a quota of
41
41
 
42
42
  This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
43
43
 
44
- - API version: 2.9.1
45
- - SDK version: 4.0.1
44
+ - API version: 2.11.1
45
+ - SDK version: 4.2.0
46
46
  - Build package: org.openapitools.codegen.languages.PythonClientCodegen
47
47
 
48
48
  ## Requirements
@@ -54,13 +54,13 @@ This Python package is automatically generated by the [OpenAPI Generator](https:
54
54
  ### Poetry
55
55
 
56
56
  ```shell
57
- poetry add fds.sdk.utils fds.sdk.FactSetEstimates==4.0.1
57
+ poetry add fds.sdk.utils fds.sdk.FactSetEstimates==4.2.0
58
58
  ```
59
59
 
60
60
  ### pip
61
61
 
62
62
  ```shell
63
- pip install fds.sdk.utils fds.sdk.FactSetEstimates==4.0.1
63
+ pip install fds.sdk.utils fds.sdk.FactSetEstimates==4.2.0
64
64
  ```
65
65
 
66
66
  ## Usage
@@ -121,10 +121,10 @@ with fds.sdk.FactSetEstimates.ApiClient(configuration) as api_client:
121
121
  # Create an instance of the API class
122
122
  api_instance = actuals_api.ActualsApi(api_client)
123
123
  ids = ["AAPL-USA"] # [str] | Security or Entity identifiers. Accepted inputs include FactSet Identifiers, tickers, CUSIP, and SEDOL. <p><b>Performance Note:</b> Requests that increase the number of metrics or request long historical data may trigger the 30-second service timeout threshold. To ensure system stability and performance, please keep requests lightweight.</p> <p>If requesting long historical data, limit the history to <b>10 years per metric per ID</b>.</p>
124
- metrics = ["SALES"] # [str] | Requested metrics. Use the `/metrics` endpoint to return a list of available estimate items. **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).
124
+ metrics = ["SALES"] # [str] | Requested metrics. Use the `/metrics` endpoint to return a list of available estimate items. **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).
125
125
  relative_fiscal_start = -2 # int | 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). (optional)
126
126
  relative_fiscal_end = 0 # int | 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). (optional)
127
- periodicity = "ANN" # str | 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. (optional) if omitted the server will use the default value of "ANN"
127
+ periodicity = "ANN" # str | The periodicity for the estimates requested, allowing you to fetch Quarterly, Semi-Annual, Annual, Next-Twelve-Months, and Last-Twelve-Months Estimates. * **ANN** - Annual * **QTR** - Quarterly * **SEMI** - Semi-Annual * **NTMA** - Next-Twelve-Months * **LTMA** - Last-Twelve-Months (optional) if omitted the server will use the default value of "ANN"
128
128
  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)
129
129
 
130
130
  try:
@@ -333,6 +333,7 @@ Class | Method | HTTP request | Description
333
333
  - [GuidanceRequestBody](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/GuidanceRequestBody.md)
334
334
  - [GuidanceResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/GuidanceResponse.md)
335
335
  - [Ids](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/Ids.md)
336
+ - [IdsSegments](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/IdsSegments.md)
336
337
  - [Meta](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/Meta.md)
337
338
  - [Metric](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/Metric.md)
338
339
  - [MetricSegmentDetail](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimates/v2/docs/MetricSegmentDetail.md)
@@ -5,13 +5,13 @@
5
5
 
6
6
  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** - **Guidance** - **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> All endpoints, except /company-reports/* and /metrics are limited to a quota of 4 million datapoints per minute. Requests exceeding this limit (greater than 4 million datapoints per minute) will receive a 429 response. **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) # noqa: E501
7
7
 
8
- The version of the OpenAPI document: 2.9.1
8
+ The version of the OpenAPI document: 2.11.1
9
9
  Contact: api@factset.com
10
10
  Generated by: https://openapi-generator.tech
11
11
  """
12
12
 
13
13
 
14
- __version__ = "4.0.1"
14
+ __version__ = "4.2.0"
15
15
 
16
16
  # import ApiClient
17
17
  from fds.sdk.FactSetEstimates.api_client import ApiClient
@@ -3,7 +3,7 @@
3
3
 
4
4
  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** - **Guidance** - **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> All endpoints, except /company-reports/* and /metrics are limited to a quota of 4 million datapoints per minute. Requests exceeding this limit (greater than 4 million datapoints per minute) will receive a 429 response. **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) # noqa: E501
5
5
 
6
- The version of the OpenAPI document: 2.9.1
6
+ The version of the OpenAPI document: 2.11.1
7
7
  Contact: api@factset.com
8
8
  Generated by: https://openapi-generator.tech
9
9
  """
@@ -243,12 +243,12 @@ class ActualsApi(object):
243
243
 
244
244
  Args:
245
245
  ids ([str]): Security or Entity identifiers. Accepted inputs include FactSet Identifiers, tickers, CUSIP, and SEDOL. <p><b>Performance Note:</b> Requests that increase the number of metrics or request long historical data may trigger the 30-second service timeout threshold. To ensure system stability and performance, please keep requests lightweight.</p> <p>If requesting long historical data, limit the history to <b>10 years per metric per ID</b>.</p>
246
- metrics ([str]): Requested metrics. Use the `/metrics` endpoint to return a list of available estimate items. **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).
246
+ metrics ([str]): Requested metrics. Use the `/metrics` endpoint to return a list of available estimate items. **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).
247
247
 
248
248
  Keyword Args:
249
249
  relative_fiscal_start (int): 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). . [optional]
250
250
  relative_fiscal_end (int): 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).. [optional]
251
- periodicity (str): 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. . [optional] if omitted the server will use the default value of "ANN"
251
+ periodicity (str): The periodicity for the estimates requested, allowing you to fetch Quarterly, Semi-Annual, Annual, Next-Twelve-Months, and Last-Twelve-Months Estimates. * **ANN** - Annual * **QTR** - Quarterly * **SEMI** - Semi-Annual * **NTMA** - Next-Twelve-Months * **LTMA** - Last-Twelve-Months . [optional] if omitted the server will use the default value of "ANN"
252
252
  currency (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]
253
253
  _preload_content (bool): if False, the urllib3.HTTPResponse object
254
254
  will be returned without reading/decoding response data.
@@ -298,12 +298,12 @@ class ActualsApi(object):
298
298
 
299
299
  Args:
300
300
  ids ([str]): Security or Entity identifiers. Accepted inputs include FactSet Identifiers, tickers, CUSIP, and SEDOL. <p><b>Performance Note:</b> Requests that increase the number of metrics or request long historical data may trigger the 30-second service timeout threshold. To ensure system stability and performance, please keep requests lightweight.</p> <p>If requesting long historical data, limit the history to <b>10 years per metric per ID</b>.</p>
301
- metrics ([str]): Requested metrics. Use the `/metrics` endpoint to return a list of available estimate items. **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).
301
+ metrics ([str]): Requested metrics. Use the `/metrics` endpoint to return a list of available estimate items. **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).
302
302
 
303
303
  Keyword Args:
304
304
  relative_fiscal_start (int): 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). . [optional]
305
305
  relative_fiscal_end (int): 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).. [optional]
306
- periodicity (str): 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. . [optional] if omitted the server will use the default value of "ANN"
306
+ periodicity (str): The periodicity for the estimates requested, allowing you to fetch Quarterly, Semi-Annual, Annual, Next-Twelve-Months, and Last-Twelve-Months Estimates. * **ANN** - Annual * **QTR** - Quarterly * **SEMI** - Semi-Annual * **NTMA** - Next-Twelve-Months * **LTMA** - Last-Twelve-Months . [optional] if omitted the server will use the default value of "ANN"
307
307
  currency (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]
308
308
  _preload_content (bool): if False, the urllib3.HTTPResponse object
309
309
  will be returned without reading/decoding response data.
@@ -357,12 +357,12 @@ class ActualsApi(object):
357
357
 
358
358
  Args:
359
359
  ids ([str]): Security or Entity identifiers. Accepted inputs include FactSet Identifiers, tickers, CUSIP, and SEDOL. <p><b>Performance Note:</b> Requests that increase the number of metrics or request long historical data may trigger the 30-second service timeout threshold. To ensure system stability and performance, please keep requests lightweight.</p> <p>If requesting long historical data, limit the history to <b>10 years per metric per ID</b>.</p>
360
- metrics ([str]): Requested metrics. Use the `/metrics` endpoint to return a list of available estimate items. **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).
360
+ metrics ([str]): Requested metrics. Use the `/metrics` endpoint to return a list of available estimate items. **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).
361
361
 
362
362
  Keyword Args:
363
363
  relative_fiscal_start (int): 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). . [optional]
364
364
  relative_fiscal_end (int): 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).. [optional]
365
- periodicity (str): 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. . [optional] if omitted the server will use the default value of "ANN"
365
+ periodicity (str): The periodicity for the estimates requested, allowing you to fetch Quarterly, Semi-Annual, Annual, Next-Twelve-Months, and Last-Twelve-Months Estimates. * **ANN** - Annual * **QTR** - Quarterly * **SEMI** - Semi-Annual * **NTMA** - Next-Twelve-Months * **LTMA** - Last-Twelve-Months . [optional] if omitted the server will use the default value of "ANN"
366
366
  currency (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]
367
367
  _preload_content (bool): if False, the urllib3.HTTPResponse object
368
368
  will be returned without reading/decoding response data.
@@ -411,12 +411,12 @@ class ActualsApi(object):
411
411
 
412
412
  Args:
413
413
  ids ([str]): Security or Entity identifiers. Accepted inputs include FactSet Identifiers, tickers, CUSIP, and SEDOL. <p><b>Performance Note:</b> Requests that increase the number of metrics or request long historical data may trigger the 30-second service timeout threshold. To ensure system stability and performance, please keep requests lightweight.</p> <p>If requesting long historical data, limit the history to <b>10 years per metric per ID</b>.</p>
414
- metrics ([str]): Requested metrics. Use the `/metrics` endpoint to return a list of available estimate items. **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).
414
+ metrics ([str]): Requested metrics. Use the `/metrics` endpoint to return a list of available estimate items. **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).
415
415
 
416
416
  Keyword Args:
417
417
  relative_fiscal_start (int): 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). . [optional]
418
418
  relative_fiscal_end (int): 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).. [optional]
419
- periodicity (str): 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. . [optional] if omitted the server will use the default value of "ANN"
419
+ periodicity (str): The periodicity for the estimates requested, allowing you to fetch Quarterly, Semi-Annual, Annual, Next-Twelve-Months, and Last-Twelve-Months Estimates. * **ANN** - Annual * **QTR** - Quarterly * **SEMI** - Semi-Annual * **NTMA** - Next-Twelve-Months * **LTMA** - Last-Twelve-Months . [optional] if omitted the server will use the default value of "ANN"
420
420
  currency (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]
421
421
  _preload_content (bool): if False, the urllib3.HTTPResponse object
422
422
  will be returned without reading/decoding response data.
@@ -3,7 +3,7 @@
3
3
 
4
4
  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** - **Guidance** - **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> All endpoints, except /company-reports/* and /metrics are limited to a quota of 4 million datapoints per minute. Requests exceeding this limit (greater than 4 million datapoints per minute) will receive a 429 response. **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) # noqa: E501
5
5
 
6
- The version of the OpenAPI document: 2.9.1
6
+ The version of the OpenAPI document: 2.11.1
7
7
  Contact: api@factset.com
8
8
  Generated by: https://openapi-generator.tech
9
9
  """
@@ -76,6 +76,7 @@ class BrokerDetailApi(object):
76
76
  'broker_names',
77
77
  'updates_only',
78
78
  'sort_by_input_date_time',
79
+ 'include_doc_id',
79
80
  ],
80
81
  'required': [
81
82
  'ids',
@@ -147,6 +148,8 @@ class BrokerDetailApi(object):
147
148
  (bool,),
148
149
  'sort_by_input_date_time':
149
150
  (bool,),
151
+ 'include_doc_id':
152
+ (bool,),
150
153
  },
151
154
  'attribute_map': {
152
155
  'ids': 'ids',
@@ -162,6 +165,7 @@ class BrokerDetailApi(object):
162
165
  'broker_names': 'brokerNames',
163
166
  'updates_only': 'updatesOnly',
164
167
  'sort_by_input_date_time': 'sortByInputDateTime',
168
+ 'include_doc_id': 'includeDocId',
165
169
  },
166
170
  'location_map': {
167
171
  'ids': 'query',
@@ -177,6 +181,7 @@ class BrokerDetailApi(object):
177
181
  'broker_names': 'query',
178
182
  'updates_only': 'query',
179
183
  'sort_by_input_date_time': 'query',
184
+ 'include_doc_id': 'query',
180
185
  },
181
186
  'collection_format_map': {
182
187
  'ids': 'csv',
@@ -280,6 +285,7 @@ class BrokerDetailApi(object):
280
285
  'broker_names',
281
286
  'updates_only',
282
287
  'sort_by_input_date_time',
288
+ 'include_doc_id',
283
289
  ],
284
290
  'required': [
285
291
  'ids',
@@ -363,6 +369,8 @@ class BrokerDetailApi(object):
363
369
  (bool,),
364
370
  'sort_by_input_date_time':
365
371
  (bool,),
372
+ 'include_doc_id':
373
+ (bool,),
366
374
  },
367
375
  'attribute_map': {
368
376
  'ids': 'ids',
@@ -378,6 +386,7 @@ class BrokerDetailApi(object):
378
386
  'broker_names': 'brokerNames',
379
387
  'updates_only': 'updatesOnly',
380
388
  'sort_by_input_date_time': 'sortByInputDateTime',
389
+ 'include_doc_id': 'includeDocId',
381
390
  },
382
391
  'location_map': {
383
392
  'ids': 'query',
@@ -393,6 +402,7 @@ class BrokerDetailApi(object):
393
402
  'broker_names': 'query',
394
403
  'updates_only': 'query',
395
404
  'sort_by_input_date_time': 'query',
405
+ 'include_doc_id': 'query',
396
406
  },
397
407
  'collection_format_map': {
398
408
  'ids': 'csv',
@@ -493,20 +503,21 @@ class BrokerDetailApi(object):
493
503
 
494
504
  Args:
495
505
  ids ([str]): Security or Entity identifiers. Accepted inputs include FactSet Identifiers, tickers, CUSIP, and SEDOL. <p><b>Performance Note:</b> Requests that increase the number of metrics or request long historical data may trigger the 30-second service timeout threshold. To ensure system stability and performance, please keep requests lightweight.</p> <p>If requesting long historical data, limit the history to <b>10 years per metric per ID</b>.</p>
496
- metrics ([str]): Requested metrics. Use the `/metrics` endpoint to return a list of available estimate items. **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).
506
+ metrics ([str]): Requested metrics. Use the `/metrics` endpoint to return a list of available estimate items. **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).
497
507
 
498
508
  Keyword Args:
499
- start_date (date): Start date for point in time of estimates expressed in YYYY-MM-DD format.. [optional]
500
- end_date (date): End date for point in time of estimates expressed in YYYY-MM-DD format.. [optional]
509
+ start_date (date): Start of the perspective date range for estimates, expressed in YYYY-MM-DD format. If left blank, the API defaults to the start of the latest company reporting period. Future dates (T+1) are not accepted.. [optional]
510
+ end_date (date): End of the perspective date range for estimates, expressed in YYYY-MM-DD format. If left blank, the API defaults to the end of the latest company reporting period. Future dates (T+1) are not accepted.. [optional]
501
511
  frequency (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"
502
512
  periodicity (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"
503
513
  include_all (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
504
514
  fiscal_period_start (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]
505
515
  fiscal_period_end (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]
506
516
  currency (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]
507
- broker_names ([str]): Filter to return estimate data from specific brokers only. Accepts broker names as input. The endpoint returns data from all available brokers if this parameter is not specified. For a list of available brokers, visit [Online Assistant Page #14706](https://oa.apps.factset.com/pages/14706).. [optional]
517
+ broker_names ([str]): Filter to return estimate data from specific brokers only. Accepts broker names as input. The endpoint returns data from all available brokers if this parameter is not specified.. [optional]
508
518
  updates_only (bool): If `true`, the endpoint returns the first reported estimates within the period plus any subsequent broker updates. If `false`, it returns data for every date in the requested range at the chosen frequency. . [optional] if omitted the server will use the default value of False
509
519
  sort_by_input_date_time (bool): When set to true, results will be sorted by `inputDateTime` in descending order (latest records first). This ensures the most recent estimate revisions are returned first in the response. . [optional] if omitted the server will use the default value of False
520
+ include_doc_id (bool): Controls whether the `docId` field is included in the response. * **TRUE** = Returns the `docId` field, a unique identifier linking the estimate to the corresponding investment report in FactSet's Investment Research API. * **FALSE** = Omits the `docId` field from the response. (default) . [optional] if omitted the server will use the default value of False
510
521
  _preload_content (bool): if False, the urllib3.HTTPResponse object
511
522
  will be returned without reading/decoding response data.
512
523
  Default is True. NOTE: if this API returns a file, it is the responsibility
@@ -555,20 +566,21 @@ class BrokerDetailApi(object):
555
566
 
556
567
  Args:
557
568
  ids ([str]): Security or Entity identifiers. Accepted inputs include FactSet Identifiers, tickers, CUSIP, and SEDOL. <p><b>Performance Note:</b> Requests that increase the number of metrics or request long historical data may trigger the 30-second service timeout threshold. To ensure system stability and performance, please keep requests lightweight.</p> <p>If requesting long historical data, limit the history to <b>10 years per metric per ID</b>.</p>
558
- metrics ([str]): Requested metrics. Use the `/metrics` endpoint to return a list of available estimate items. **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).
569
+ metrics ([str]): Requested metrics. Use the `/metrics` endpoint to return a list of available estimate items. **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).
559
570
 
560
571
  Keyword Args:
561
- start_date (date): Start date for point in time of estimates expressed in YYYY-MM-DD format.. [optional]
562
- end_date (date): End date for point in time of estimates expressed in YYYY-MM-DD format.. [optional]
572
+ start_date (date): Start of the perspective date range for estimates, expressed in YYYY-MM-DD format. If left blank, the API defaults to the start of the latest company reporting period. Future dates (T+1) are not accepted.. [optional]
573
+ end_date (date): End of the perspective date range for estimates, expressed in YYYY-MM-DD format. If left blank, the API defaults to the end of the latest company reporting period. Future dates (T+1) are not accepted.. [optional]
563
574
  frequency (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"
564
575
  periodicity (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"
565
576
  include_all (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
566
577
  fiscal_period_start (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]
567
578
  fiscal_period_end (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]
568
579
  currency (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]
569
- broker_names ([str]): Filter to return estimate data from specific brokers only. Accepts broker names as input. The endpoint returns data from all available brokers if this parameter is not specified. For a list of available brokers, visit [Online Assistant Page #14706](https://oa.apps.factset.com/pages/14706).. [optional]
580
+ broker_names ([str]): Filter to return estimate data from specific brokers only. Accepts broker names as input. The endpoint returns data from all available brokers if this parameter is not specified.. [optional]
570
581
  updates_only (bool): If `true`, the endpoint returns the first reported estimates within the period plus any subsequent broker updates. If `false`, it returns data for every date in the requested range at the chosen frequency. . [optional] if omitted the server will use the default value of False
571
582
  sort_by_input_date_time (bool): When set to true, results will be sorted by `inputDateTime` in descending order (latest records first). This ensures the most recent estimate revisions are returned first in the response. . [optional] if omitted the server will use the default value of False
583
+ include_doc_id (bool): Controls whether the `docId` field is included in the response. * **TRUE** = Returns the `docId` field, a unique identifier linking the estimate to the corresponding investment report in FactSet's Investment Research API. * **FALSE** = Omits the `docId` field from the response. (default) . [optional] if omitted the server will use the default value of False
572
584
  _preload_content (bool): if False, the urllib3.HTTPResponse object
573
585
  will be returned without reading/decoding response data.
574
586
  Default is True. NOTE: if this API returns a file, it is the responsibility
@@ -621,20 +633,21 @@ class BrokerDetailApi(object):
621
633
 
622
634
  Args:
623
635
  ids ([str]): Security or Entity identifiers. Accepted inputs include FactSet Identifiers, tickers, CUSIP, and SEDOL. <p><b>Performance Note:</b> Requests that increase the number of metrics or request long historical data may trigger the 30-second service timeout threshold. To ensure system stability and performance, please keep requests lightweight.</p> <p>If requesting long historical data, limit the history to <b>10 years per metric per ID</b>.</p>
624
- metrics ([str]): Requested metrics. Use the `/metrics` endpoint to return a list of available estimate items. **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).
636
+ metrics ([str]): Requested metrics. Use the `/metrics` endpoint to return a list of available estimate items. **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).
625
637
 
626
638
  Keyword Args:
627
- start_date (date): Start date for point in time of estimates expressed in YYYY-MM-DD format.. [optional]
628
- end_date (date): End date for point in time of estimates expressed in YYYY-MM-DD format.. [optional]
639
+ start_date (date): Start of the perspective date range for estimates, expressed in YYYY-MM-DD format. If left blank, the API defaults to the start of the latest company reporting period. Future dates (T+1) are not accepted.. [optional]
640
+ end_date (date): End of the perspective date range for estimates, expressed in YYYY-MM-DD format. If left blank, the API defaults to the end of the latest company reporting period. Future dates (T+1) are not accepted.. [optional]
629
641
  frequency (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"
630
642
  periodicity (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"
631
643
  include_all (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
632
644
  fiscal_period_start (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]
633
645
  fiscal_period_end (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]
634
646
  currency (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]
635
- broker_names ([str]): Filter to return estimate data from specific brokers only. Accepts broker names as input. The endpoint returns data from all available brokers if this parameter is not specified. For a list of available brokers, visit [Online Assistant Page #14706](https://oa.apps.factset.com/pages/14706).. [optional]
647
+ broker_names ([str]): Filter to return estimate data from specific brokers only. Accepts broker names as input. The endpoint returns data from all available brokers if this parameter is not specified.. [optional]
636
648
  updates_only (bool): If `true`, the endpoint returns the first reported estimates within the period plus any subsequent broker updates. If `false`, it returns data for every date in the requested range at the chosen frequency. . [optional] if omitted the server will use the default value of False
637
649
  sort_by_input_date_time (bool): When set to true, results will be sorted by `inputDateTime` in descending order (latest records first). This ensures the most recent estimate revisions are returned first in the response. . [optional] if omitted the server will use the default value of False
650
+ include_doc_id (bool): Controls whether the `docId` field is included in the response. * **TRUE** = Returns the `docId` field, a unique identifier linking the estimate to the corresponding investment report in FactSet's Investment Research API. * **FALSE** = Omits the `docId` field from the response. (default) . [optional] if omitted the server will use the default value of False
638
651
  _preload_content (bool): if False, the urllib3.HTTPResponse object
639
652
  will be returned without reading/decoding response data.
640
653
  Default is True. NOTE: if this API returns a file, it is the responsibility
@@ -682,20 +695,21 @@ class BrokerDetailApi(object):
682
695
 
683
696
  Args:
684
697
  ids ([str]): Security or Entity identifiers. Accepted inputs include FactSet Identifiers, tickers, CUSIP, and SEDOL. <p><b>Performance Note:</b> Requests that increase the number of metrics or request long historical data may trigger the 30-second service timeout threshold. To ensure system stability and performance, please keep requests lightweight.</p> <p>If requesting long historical data, limit the history to <b>10 years per metric per ID</b>.</p>
685
- metrics ([str]): Requested metrics. Use the `/metrics` endpoint to return a list of available estimate items. **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).
698
+ metrics ([str]): Requested metrics. Use the `/metrics` endpoint to return a list of available estimate items. **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).
686
699
 
687
700
  Keyword Args:
688
- start_date (date): Start date for point in time of estimates expressed in YYYY-MM-DD format.. [optional]
689
- end_date (date): End date for point in time of estimates expressed in YYYY-MM-DD format.. [optional]
701
+ start_date (date): Start of the perspective date range for estimates, expressed in YYYY-MM-DD format. If left blank, the API defaults to the start of the latest company reporting period. Future dates (T+1) are not accepted.. [optional]
702
+ end_date (date): End of the perspective date range for estimates, expressed in YYYY-MM-DD format. If left blank, the API defaults to the end of the latest company reporting period. Future dates (T+1) are not accepted.. [optional]
690
703
  frequency (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"
691
704
  periodicity (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"
692
705
  include_all (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
693
706
  fiscal_period_start (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]
694
707
  fiscal_period_end (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]
695
708
  currency (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]
696
- broker_names ([str]): Filter to return estimate data from specific brokers only. Accepts broker names as input. The endpoint returns data from all available brokers if this parameter is not specified. For a list of available brokers, visit [Online Assistant Page #14706](https://oa.apps.factset.com/pages/14706).. [optional]
709
+ broker_names ([str]): Filter to return estimate data from specific brokers only. Accepts broker names as input. The endpoint returns data from all available brokers if this parameter is not specified.. [optional]
697
710
  updates_only (bool): If `true`, the endpoint returns the first reported estimates within the period plus any subsequent broker updates. If `false`, it returns data for every date in the requested range at the chosen frequency. . [optional] if omitted the server will use the default value of False
698
711
  sort_by_input_date_time (bool): When set to true, results will be sorted by `inputDateTime` in descending order (latest records first). This ensures the most recent estimate revisions are returned first in the response. . [optional] if omitted the server will use the default value of False
712
+ include_doc_id (bool): Controls whether the `docId` field is included in the response. * **TRUE** = Returns the `docId` field, a unique identifier linking the estimate to the corresponding investment report in FactSet's Investment Research API. * **FALSE** = Omits the `docId` field from the response. (default) . [optional] if omitted the server will use the default value of False
699
713
  _preload_content (bool): if False, the urllib3.HTTPResponse object
700
714
  will be returned without reading/decoding response data.
701
715
  Default is True. NOTE: if this API returns a file, it is the responsibility
@@ -935,20 +949,21 @@ class BrokerDetailApi(object):
935
949
 
936
950
  Args:
937
951
  ids ([str]): Security or Entity identifiers. Accepted inputs include FactSet Identifiers, tickers, CUSIP, and SEDOL. <p><b>Performance Note:</b> Requests that increase the number of metrics or request long historical data may trigger the 30-second service timeout threshold. To ensure system stability and performance, please keep requests lightweight.</p> <p>If requesting long historical data, limit the history to <b>10 years per metric per ID</b>.</p>
938
- metrics ([str]): Requested metrics. Use the `/metrics` endpoint to return a list of available estimate items. **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).
952
+ metrics ([str]): Requested metrics. Use the `/metrics` endpoint to return a list of available estimate items. **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).
939
953
 
940
954
  Keyword Args:
941
- start_date (date): Start date for point in time of estimates expressed in YYYY-MM-DD format.. [optional]
942
- end_date (date): End date for point in time of estimates expressed in YYYY-MM-DD format.. [optional]
955
+ start_date (date): Start of the perspective date range for estimates, expressed in YYYY-MM-DD format. If left blank, the API defaults to the start of the latest company reporting period. Future dates (T+1) are not accepted.. [optional]
956
+ end_date (date): End of the perspective date range for estimates, expressed in YYYY-MM-DD format. If left blank, the API defaults to the end of the latest company reporting period. Future dates (T+1) are not accepted.. [optional]
943
957
  frequency (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"
944
958
  periodicity (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"
945
959
  include_all (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
946
960
  relative_fiscal_start (int): Relative fiscal period, expressed as an integer, used to filter results. This is combined with the periodicity parameter to specify a relative estimate period. For example, set to 1 and periodicity to ANN to ask for relative Fiscal Year 1 (FY1).. [optional]
947
961
  relative_fiscal_end (int): Relative fiscal period, expressed as an integer, used to filter results. This is combined with the periodicity parameter to specify a relative estimate period. For example, set to 2 and periodicity to ANN to ask for relative Fiscal Year 1 (FY2).. [optional]
948
962
  currency (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]
949
- broker_names ([str]): Filter to return estimate data from specific brokers only. Accepts broker names as input. The endpoint returns data from all available brokers if this parameter is not specified. For a list of available brokers, visit [Online Assistant Page #14706](https://oa.apps.factset.com/pages/14706).. [optional]
963
+ broker_names ([str]): Filter to return estimate data from specific brokers only. Accepts broker names as input. The endpoint returns data from all available brokers if this parameter is not specified.. [optional]
950
964
  updates_only (bool): If `true`, the endpoint returns the first reported estimates within the period plus any subsequent broker updates. If `false`, it returns data for every date in the requested range at the chosen frequency. . [optional] if omitted the server will use the default value of False
951
965
  sort_by_input_date_time (bool): When set to true, results will be sorted by `inputDateTime` in descending order (latest records first). This ensures the most recent estimate revisions are returned first in the response. . [optional] if omitted the server will use the default value of False
966
+ include_doc_id (bool): Controls whether the `docId` field is included in the response. * **TRUE** = Returns the `docId` field, a unique identifier linking the estimate to the corresponding investment report in FactSet's Investment Research API. * **FALSE** = Omits the `docId` field from the response. (default) . [optional] if omitted the server will use the default value of False
952
967
  _preload_content (bool): if False, the urllib3.HTTPResponse object
953
968
  will be returned without reading/decoding response data.
954
969
  Default is True. NOTE: if this API returns a file, it is the responsibility
@@ -997,20 +1012,21 @@ class BrokerDetailApi(object):
997
1012
 
998
1013
  Args:
999
1014
  ids ([str]): Security or Entity identifiers. Accepted inputs include FactSet Identifiers, tickers, CUSIP, and SEDOL. <p><b>Performance Note:</b> Requests that increase the number of metrics or request long historical data may trigger the 30-second service timeout threshold. To ensure system stability and performance, please keep requests lightweight.</p> <p>If requesting long historical data, limit the history to <b>10 years per metric per ID</b>.</p>
1000
- metrics ([str]): Requested metrics. Use the `/metrics` endpoint to return a list of available estimate items. **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).
1015
+ metrics ([str]): Requested metrics. Use the `/metrics` endpoint to return a list of available estimate items. **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).
1001
1016
 
1002
1017
  Keyword Args:
1003
- start_date (date): Start date for point in time of estimates expressed in YYYY-MM-DD format.. [optional]
1004
- end_date (date): End date for point in time of estimates expressed in YYYY-MM-DD format.. [optional]
1018
+ start_date (date): Start of the perspective date range for estimates, expressed in YYYY-MM-DD format. If left blank, the API defaults to the start of the latest company reporting period. Future dates (T+1) are not accepted.. [optional]
1019
+ end_date (date): End of the perspective date range for estimates, expressed in YYYY-MM-DD format. If left blank, the API defaults to the end of the latest company reporting period. Future dates (T+1) are not accepted.. [optional]
1005
1020
  frequency (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"
1006
1021
  periodicity (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"
1007
1022
  include_all (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
1008
1023
  relative_fiscal_start (int): Relative fiscal period, expressed as an integer, used to filter results. This is combined with the periodicity parameter to specify a relative estimate period. For example, set to 1 and periodicity to ANN to ask for relative Fiscal Year 1 (FY1).. [optional]
1009
1024
  relative_fiscal_end (int): Relative fiscal period, expressed as an integer, used to filter results. This is combined with the periodicity parameter to specify a relative estimate period. For example, set to 2 and periodicity to ANN to ask for relative Fiscal Year 1 (FY2).. [optional]
1010
1025
  currency (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]
1011
- broker_names ([str]): Filter to return estimate data from specific brokers only. Accepts broker names as input. The endpoint returns data from all available brokers if this parameter is not specified. For a list of available brokers, visit [Online Assistant Page #14706](https://oa.apps.factset.com/pages/14706).. [optional]
1026
+ broker_names ([str]): Filter to return estimate data from specific brokers only. Accepts broker names as input. The endpoint returns data from all available brokers if this parameter is not specified.. [optional]
1012
1027
  updates_only (bool): If `true`, the endpoint returns the first reported estimates within the period plus any subsequent broker updates. If `false`, it returns data for every date in the requested range at the chosen frequency. . [optional] if omitted the server will use the default value of False
1013
1028
  sort_by_input_date_time (bool): When set to true, results will be sorted by `inputDateTime` in descending order (latest records first). This ensures the most recent estimate revisions are returned first in the response. . [optional] if omitted the server will use the default value of False
1029
+ include_doc_id (bool): Controls whether the `docId` field is included in the response. * **TRUE** = Returns the `docId` field, a unique identifier linking the estimate to the corresponding investment report in FactSet's Investment Research API. * **FALSE** = Omits the `docId` field from the response. (default) . [optional] if omitted the server will use the default value of False
1014
1030
  _preload_content (bool): if False, the urllib3.HTTPResponse object
1015
1031
  will be returned without reading/decoding response data.
1016
1032
  Default is True. NOTE: if this API returns a file, it is the responsibility
@@ -1063,20 +1079,21 @@ class BrokerDetailApi(object):
1063
1079
 
1064
1080
  Args:
1065
1081
  ids ([str]): Security or Entity identifiers. Accepted inputs include FactSet Identifiers, tickers, CUSIP, and SEDOL. <p><b>Performance Note:</b> Requests that increase the number of metrics or request long historical data may trigger the 30-second service timeout threshold. To ensure system stability and performance, please keep requests lightweight.</p> <p>If requesting long historical data, limit the history to <b>10 years per metric per ID</b>.</p>
1066
- metrics ([str]): Requested metrics. Use the `/metrics` endpoint to return a list of available estimate items. **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).
1082
+ metrics ([str]): Requested metrics. Use the `/metrics` endpoint to return a list of available estimate items. **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).
1067
1083
 
1068
1084
  Keyword Args:
1069
- start_date (date): Start date for point in time of estimates expressed in YYYY-MM-DD format.. [optional]
1070
- end_date (date): End date for point in time of estimates expressed in YYYY-MM-DD format.. [optional]
1085
+ start_date (date): Start of the perspective date range for estimates, expressed in YYYY-MM-DD format. If left blank, the API defaults to the start of the latest company reporting period. Future dates (T+1) are not accepted.. [optional]
1086
+ end_date (date): End of the perspective date range for estimates, expressed in YYYY-MM-DD format. If left blank, the API defaults to the end of the latest company reporting period. Future dates (T+1) are not accepted.. [optional]
1071
1087
  frequency (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"
1072
1088
  periodicity (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"
1073
1089
  include_all (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
1074
1090
  relative_fiscal_start (int): Relative fiscal period, expressed as an integer, used to filter results. This is combined with the periodicity parameter to specify a relative estimate period. For example, set to 1 and periodicity to ANN to ask for relative Fiscal Year 1 (FY1).. [optional]
1075
1091
  relative_fiscal_end (int): Relative fiscal period, expressed as an integer, used to filter results. This is combined with the periodicity parameter to specify a relative estimate period. For example, set to 2 and periodicity to ANN to ask for relative Fiscal Year 1 (FY2).. [optional]
1076
1092
  currency (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]
1077
- broker_names ([str]): Filter to return estimate data from specific brokers only. Accepts broker names as input. The endpoint returns data from all available brokers if this parameter is not specified. For a list of available brokers, visit [Online Assistant Page #14706](https://oa.apps.factset.com/pages/14706).. [optional]
1093
+ broker_names ([str]): Filter to return estimate data from specific brokers only. Accepts broker names as input. The endpoint returns data from all available brokers if this parameter is not specified.. [optional]
1078
1094
  updates_only (bool): If `true`, the endpoint returns the first reported estimates within the period plus any subsequent broker updates. If `false`, it returns data for every date in the requested range at the chosen frequency. . [optional] if omitted the server will use the default value of False
1079
1095
  sort_by_input_date_time (bool): When set to true, results will be sorted by `inputDateTime` in descending order (latest records first). This ensures the most recent estimate revisions are returned first in the response. . [optional] if omitted the server will use the default value of False
1096
+ include_doc_id (bool): Controls whether the `docId` field is included in the response. * **TRUE** = Returns the `docId` field, a unique identifier linking the estimate to the corresponding investment report in FactSet's Investment Research API. * **FALSE** = Omits the `docId` field from the response. (default) . [optional] if omitted the server will use the default value of False
1080
1097
  _preload_content (bool): if False, the urllib3.HTTPResponse object
1081
1098
  will be returned without reading/decoding response data.
1082
1099
  Default is True. NOTE: if this API returns a file, it is the responsibility
@@ -1124,20 +1141,21 @@ class BrokerDetailApi(object):
1124
1141
 
1125
1142
  Args:
1126
1143
  ids ([str]): Security or Entity identifiers. Accepted inputs include FactSet Identifiers, tickers, CUSIP, and SEDOL. <p><b>Performance Note:</b> Requests that increase the number of metrics or request long historical data may trigger the 30-second service timeout threshold. To ensure system stability and performance, please keep requests lightweight.</p> <p>If requesting long historical data, limit the history to <b>10 years per metric per ID</b>.</p>
1127
- metrics ([str]): Requested metrics. Use the `/metrics` endpoint to return a list of available estimate items. **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).
1144
+ metrics ([str]): Requested metrics. Use the `/metrics` endpoint to return a list of available estimate items. **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).
1128
1145
 
1129
1146
  Keyword Args:
1130
- start_date (date): Start date for point in time of estimates expressed in YYYY-MM-DD format.. [optional]
1131
- end_date (date): End date for point in time of estimates expressed in YYYY-MM-DD format.. [optional]
1147
+ start_date (date): Start of the perspective date range for estimates, expressed in YYYY-MM-DD format. If left blank, the API defaults to the start of the latest company reporting period. Future dates (T+1) are not accepted.. [optional]
1148
+ end_date (date): End of the perspective date range for estimates, expressed in YYYY-MM-DD format. If left blank, the API defaults to the end of the latest company reporting period. Future dates (T+1) are not accepted.. [optional]
1132
1149
  frequency (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"
1133
1150
  periodicity (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"
1134
1151
  include_all (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
1135
1152
  relative_fiscal_start (int): Relative fiscal period, expressed as an integer, used to filter results. This is combined with the periodicity parameter to specify a relative estimate period. For example, set to 1 and periodicity to ANN to ask for relative Fiscal Year 1 (FY1).. [optional]
1136
1153
  relative_fiscal_end (int): Relative fiscal period, expressed as an integer, used to filter results. This is combined with the periodicity parameter to specify a relative estimate period. For example, set to 2 and periodicity to ANN to ask for relative Fiscal Year 1 (FY2).. [optional]
1137
1154
  currency (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]
1138
- broker_names ([str]): Filter to return estimate data from specific brokers only. Accepts broker names as input. The endpoint returns data from all available brokers if this parameter is not specified. For a list of available brokers, visit [Online Assistant Page #14706](https://oa.apps.factset.com/pages/14706).. [optional]
1155
+ broker_names ([str]): Filter to return estimate data from specific brokers only. Accepts broker names as input. The endpoint returns data from all available brokers if this parameter is not specified.. [optional]
1139
1156
  updates_only (bool): If `true`, the endpoint returns the first reported estimates within the period plus any subsequent broker updates. If `false`, it returns data for every date in the requested range at the chosen frequency. . [optional] if omitted the server will use the default value of False
1140
1157
  sort_by_input_date_time (bool): When set to true, results will be sorted by `inputDateTime` in descending order (latest records first). This ensures the most recent estimate revisions are returned first in the response. . [optional] if omitted the server will use the default value of False
1158
+ include_doc_id (bool): Controls whether the `docId` field is included in the response. * **TRUE** = Returns the `docId` field, a unique identifier linking the estimate to the corresponding investment report in FactSet's Investment Research API. * **FALSE** = Omits the `docId` field from the response. (default) . [optional] if omitted the server will use the default value of False
1141
1159
  _preload_content (bool): if False, the urllib3.HTTPResponse object
1142
1160
  will be returned without reading/decoding response data.
1143
1161
  Default is True. NOTE: if this API returns a file, it is the responsibility