Factset Estimates API is one of 460 APIs that Factset publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
This API exposes 1 JSON Schema definition.
Tagged areas include Estimates. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, code examples, a changelog, and 1 JSON Schema.
This API exposes
21 operations
across 11 paths,
and defines 61 schemas.
It is described by OpenAPI 3.0.3, at version 1.0.0.
Requests are made against 2 base URLs: https://api.factset.com, https://api-sandbox.factset.com.
The identity and technical contract details declared by the specification.
surpriseRequest
object
Request object for requesting surprise estimates.
8 properties
2 required
ids
array
The requested list of security identifiers. Accepted ID types include Market Tickers, SEDOL, ISINs, CUSIPs, or FactSet Permanent Ids. Make Note - id limit of 3…
BatchStatus
object
Status information for an asynchronous batch request.
5 properties
fixedDetailRequest
object
Request object for requesting rolling detail estimates.
10 properties
2 required
segmentIds
array
The requested list of security identifiers. Accepted ID types include Market Tickers, SEDOL, ISINs, CUSIPs, or FactSet Permanent Ids. Make Note - id limit of 5…
Periodicity
string
Periodicity or frequency of the fiscal periods. ANN = Annual, QTR = Quarterly, SEMI = Semi-Annual, LTM = Last Twelve Months, YTD = Year-to-date. Suffix R inclu…
currency
string
Currency code for adjusting the data. Use input as 'ESTIMATE' for values in Estimate currency. For a list of currency ISO codes, visit [Online Assistant Page 1…
consensusRatings
object
11 properties
EstimatesRequest
object
Wrapper for consensus estimates request body.
1 property
1 required
periodicitySurprise
string
The periodicity for the estimates, reflecting Annual, Semi-Annual and Quarterly Estimates.
surprise
object
18 properties
segmentsResponse
object
1 property
metrics
array
Requested metrics. Use the metrics endpoint for a list of estimate items. Note, the number of metrics you are allowed to supply is limited to 1 for now. For mo…
detailRatingsResponse
object
1 property
StatusObject
object
The status member contains the status code of the response.
1 property
1 required
relativeFiscalStart
integer
Relative fiscal period, expressed as an integer, used to filter results.
relativeFiscalEnd
integer
Relative fiscal period, expressed as an integer, used to filter results.
includeAll
boolean
Include All filter is used to identify included and excluded broker details from the consensus By default the service would return only the brokers included in…
BatchStatusResponse
object
Wrapper for batch request status.
1 property
detailEstimate
object
25 properties
SecurityIds
array
List of security identifiers. Accepted types include Market Tickers, SEDOL, ISINs, CUSIPs, or FactSet Permanent Ids. Limit of 1,000 per non-batch request / 30,…
MetricsList
array
List of fundamental metric identifiers. Use the /metrics endpoint for a complete catalog of available items.
frequency
string
Controls the display 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 star…
consensusEstimate
object
19 properties
EstimatesRequestBody
object
Request parameters for consensus estimates data.
6 properties
2 required
EstimatesResponse
object
Response wrapper containing an array of consensus estimate data items.
1 property
endDate
string
The end date requested for a given date range in YYYY-MM-DD format. If left blank, the API will default to previous close. Future dates (T+1) are not accepted…
segmentsEstimate
object
20 properties
subcategory
string
Sub-Category Filter for the Primary Category Requested. Choose a related sub-category for the Category requested. For methodology, visit [OA 16038](https://my.…
AttributesMember
array
Limit the attributes returned in the response to the specified set.
consensusRatingsRequest
object
Request object for requesting consensus ratings estimates.
4 properties
1 required
Error
object
A single error detail object.
4 properties
periodicity
string
The periodicity for the estimates, reflecting Annual, Semi-Annual and Quarterly Estimates. Next-twelve-months (NTMA) and Last-twelve-months (LTMA) also support…
detailResponse
object
1 property
fiscalPeriodEnd
string
Fiscal period end expressed in absolute date formats. Date that will fall back to most recent completed period during resolution. Month-end - MM/YYYY (e.g., 11…
Estimate
object
A single consensus estimate data point aggregating analyst projections for a security, metric, and fiscal period.
14 properties
startDate
string
The start date requested for a given date range in YYYY-MM-DD format. If left blank, the API will default to previous close. Future dates (T+1) are not accepte…
fiscalPeriodStart
string
Fiscal period start expressed in absolute date formats. Date that will fall back to most recent completed period during resolution. Fiscal Quarter-end - YYYY/F…
BatchError
objectnull
Error information for a failed batch request.
3 properties
category
string
Filters the list of Estimate metrics by major category - FINANCIALSTATEMENT = Includes Balance Sheet, Cash Flow, and Income Statement. INDUSTRYMETRICS = Indust…
segmentsRequest
object
Request object for requesting segments estimates.
10 properties
2 required
rollingConsensusRequest
object
Request object for requesting rolling consensus estimates.
9 properties
2 required
rollingDetailRequest
object
Request object for requesting rolling detail estimates.
10 properties
2 required
consensusResponse
object
1 property
periodicityDetail
string
The periodicity for the estimates, reflecting Annual, Semi-Annual and Quarterly Estimates.
fixedConsensusRequest
object
Request object for requesting fixed consensus estimates.
9 properties
2 required
ErrorResponse
object
Standard error response wrapper.
1 property
FiscalPeriod
object
Fiscal period date range specification. Calendar dates that will fall back to the most recently completed period during resolution.
2 properties
PostCompanyEstimatesListByInstrumentRequest
object
2 properties
detailRatingsRequest
object
Request object for requesting detail ratings estimates.
4 properties
1 required
metric
object
5 properties
consensusRatingsResponse
object
1 property
errorResponse
object
5 properties
segmentType
string
Controls the type of segment selected. BUS = Business GEO = Geographic
statistic
string
Statistic for consensus calculation.
metricsResponse
object
1 property
Currency
string
ISO 4217 currency code. Use "DOC" for reporting currency. Defaults to LOCAL.
detailRatings
object
10 properties
BatchFlag
string
Enable asynchronous batch processing. Y = Enable, N = Disable.
surpriseResponse
object
1 property
metricsRequest
object
Metrics Request Body
2 properties
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Factset publishes across the network.
