The identity and technical contract details declared by the specification.
surpriseRequest
object
Request object for requesting surprise estimates.
8 properties
2 required
articlesFields
array
Request available Articles data fields to be included in the response. Default is all fields. fsymId and articleId are always included. Common Fields |field|de…
benchmarkConstituentsResponse
object
1 property
ids
array
Security or Entity identifiers. FactSet Identifiers, tickers, CUSIP and SEDOL are accepted input. ids limit = 1000 per request Make note, GET Method URL reques…
benchmarkConstituent
object
11 properties
requestedDate
string
Date of holding expressed in YYYY-MM-DD format.
sasbScoresAll
object
32 properties
sasbArticlesRequest
object
SASB Articles Request Body
6 properties
3 required
sasbSpotlightsRequest
object
SASB Spotlights Request Body
7 properties
1 required
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…
primaryOnly
boolean
Return only primary spotlights when set to true
benchmarkIdListRequest
object
1 property
indicators
array
The indicators are the Principal Adverse Impact (PAI) metrics which consists of General, Mandatory and Additional indicators which supports the SFDR reporting.…
endDate_3
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…
currency
string
Currency for response.
benchmarkRatiosRequest
object
7 properties
2 required
indexHistoryResponse
object
1 property
sdgStartDate
string
The start date requested for a given date range in YYYY-MM-DD format. The input start date must be before the input end date. Future dates (T+1) are not accept…
consensusRatings
object
11 properties
sasbScoresAllRequest
object
SASB Scores All Request Body
6 properties
1 required
sdgSpotlightCategories
array
The SDG Categories specified for the Truvalue Scores being requested. To specify select categories returned in the response, provide a comma-separated list of…
sasbSpotlightsCategories
array
The SASB Categories requested for the respective scoreType(s). The default value is ALLCATEGORIES, which represents all 26 categories in a single overall score…
periodicitySurprise
string
The periodicity for the estimates, reflecting Annual, Semi-Annual and Quarterly Estimates.
tvlIds
array
Security or Entity identifiers. FactSet Identifiers, tickers, CUSIP and SEDOL are accepted input. ids limit = 1500 per request Make note, GET Method URL reques…
indexHistoryRequest
object
9 properties
1 required
spotlightsResponse
object
1 property
surprise
object
18 properties
periodicity_2
string
The periodicity for the estimates, reflecting Annual, Semi-Annual and Quarterly Estimates. Next-twelve-months (NTMA) and Last-twelve-months (LTMA) also support…
sasbScores
object
6 properties
sdgCategories
array
The SDG Categories specified for the Truvalue Scores being requested. To specify select categories returned in the response, provide a comma-separated list of…
segmentsResponse
object
1 property
calendar
string
Calendar of data returned. SEVENDAY includes weekends.
benchmarkIdList
object
5 properties
startDate_2
string
The start date requested for a given date range in YYYY-MM-DD format. Data is available on a Fiscal Annual periodicity, but updated Daily. If left blank, the A…
impliedDate
string
This parameter controls the date returned in the date field. The default value is N. By default, the date field returns the actual date of the observation. Thi…
isRemoved
boolean
This parameter would return the spotlights removed in the response(i.e. Spotlight is marked as Rejected but has a firstApprovedOnDate))when set to true Only Sp…
metrics
array
Requested List of FactSet Market Aggregates (FMA) or ratios. provided the below complete metrics list. |metric item|Description|category|periodicity |:|:|:|:|…
detailRatingsResponse
object
1 property
startDate_3
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_2
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…
metrics_2
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…
fixedIncomeBenchmarkConstituentsRequest
object
3 properties
1 required
relativeFiscalStart
integer
Relative fiscal period, expressed as an integer, used to filter results.
fiscalPeriodEnd_2
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…
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…
detailEstimate
object
25 properties
dateOf
string
Date of Publication or Ingestion Publication: use for startDate and endDate the articles publication date Ingestion: use for startDate and endDate the articles…
benchmarkRatios
object
8 properties
sdgArticle
object
3 properties
3 required
returnType
string
The return type adjustment used in returns response items. Adjustment can be made for GROSS and NET dividends that will be included in the return calculation.…
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. M = Monthly, based on the last…
indexHistory
object
14 properties
familyFilter
string
Highest Level Filter to search by common Benchmark Families, such as S&P, MSCI, or Russell. This will retrieve all related benchmark ids. For further filtering…
endDate_2
string
The end date requested for a given date range in YYYY-MM-DD format. Data is available on a Fiscal Annual periodicity, but updated Daily. If left blank, the API…
sdgScores
object
4 properties
4 required
sasbScoresResponse
object
1 property
sdgArticlesCategories
array
The SDG Categories specified for the Truvalue Scores being requested. To specify select categories returned in the response, provide a comma-separated list of…
sfdrPai
object
9 properties
sdgEndDate
string
The end date requested for a given date range in YYYY-MM-DD format. The input end date must be after the input start date. Future dates (T+1) are not accepted…
consensusEstimate
object
19 properties
frequency_3
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…
sasbArticlesCategories
array
Comma seperated list of one or more SASB category names as described below. The default value is ALLCATEGORIES. SASB Categories |SASB Category Inputs|Descripti…
indexSnapshotRequest
object
5 properties
1 required
benchmarkRatiosResponse
object
1 property
endDate
string
Requested end date for Range expressed in YYYY-MM-DD format.
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.…
sdgScoresResponse
object
1 property
sasbRanks
object
5 properties
fixedIncomeBenchmarkConstituent
object
8 properties
sdgScoreTypes
array
The FactSet Truvalue Score types being requested. Score Types include the Pulse, Insight, Momentum, Article Volume, Category Volume, Dynamic Materiality Score,…
constituentIds
array
Benchmark Identifiers. Reference the helper endpoint /id-list to get a sample list of valid identifiers. You must be authorized for the ids requested, otherwis…
calculation
boolean
This parameter would return the PAI data based on the input provided. All the data for indicators or subtopics requested are returned when the input is true an…
consensusRatingsRequest
object
Request object for requesting consensus ratings estimates.
4 properties
1 required
benchmarkConstituentsRequest
object
4 properties
1 required
periodicity
string
The calculation periodicity for the aggregated period. Note - Not all periodicities are supported for each metric, depending on the type of ratio. LTM is set a…
indexSnapshot
object
16 properties
currency_2
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…
fiscalPeriodEnd
string
Fiscal period end is expressed in YYYY formats. The input start date must be before the input end date. Future dates (T+1) are not accepted in this endpoint.
sasbArticle
object
3 properties
3 required
sdgSpotlightsRequest
object
SDG Spotlights Request Body
7 properties
1 required
detailResponse
object
1 property
sfdrPaiRequest
object
SFDR PAI Indicators Request Body
6 properties
1 required
startDate
string
Requested start date expressed in YYYY-MM-DD format.
sdgArticlesResponse
object
1 property
feelback
boolean
This parameter would return the latest PAI data based on the indicators or subtopics requested. The parameter should not be used in conjuction fiscalPeriodStar…
fiscalPeriodStart
string
Fiscal period start is expressed in YYYY formats. The input start date must be before the input end date. Future dates (T+1) are not accepted in this endpoint.
sasbRanksRequest
object
SASB Scores Request Body
6 properties
1 required
regionCalendar
string
Calendar of data returned.
benchmarkIdListResponse
object
1 property
sasbScoresAllResponse
object
1 property
category
string
Filters the list of Estimate metrics by major category - FINANCIALSTATEMENT = Includes Balance Sheet, Cash Flow, and Income Statement. INDUSTRYMETRICS = Indust…
sasbArticlesResponse
object
1 property
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
calendar_2
string
Calendar of data returned. SEVENDAY includes weekends. LOCAL calendar will default to the securities' trading calendar which excludes date records for respecti…
consensusResponse
object
1 property
periodicityDetail
string
The periodicity for the estimates, reflecting Annual, Semi-Annual and Quarterly Estimates.
ids_2
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…
indexIds
array
Benchmark Identifiers. Reference the helper endpoint /id-list to get a sample list of valid identifiers.
fixedConsensusRequest
object
Request object for requesting fixed consensus estimates.
9 properties
2 required
sdgFrequency
string
Controls the display frequency of the data returned. D = Daily data (to receive most recent day's values, you must use daily frequency). W = Weekly, End of wee…
sdgScoresRequest
object
SDG Scores Request Body
6 properties
1 required
Spotlights
object
3 properties
3 required
sasbRanksResponse
object
1 property
fieldsSasbSpotlights
array
Request available SASB Spotlights data fields to be included in the response. Default is all fields. fsymId,orgId, date, spotlightId, groupId and requestId are…
sdgArticlesRequest
object
SDG Articles Request Body
6 properties
3 required
detailRatingsRequest
object
Request object for requesting detail ratings estimates.
4 properties
1 required
sasbScoresRequest
object
SASB Scores Request Body
7 properties
1 required
metric
object
5 properties
fIConstituentIds
array
Fixed Income Benchmark Identifiers. Reference the helper endpoint /id-list to get a sample list of valid identifiers. You must be authorized for the ids reques…
consensusRatingsResponse
object
1 property
sfdrPaiResponse
object
1 property
errorResponse
object
5 properties
frequency_2
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. M = Monthly, based on the last…
segmentType
string
Controls the type of segment selected. BUS = Business GEO = Geographic
hedgeType
string
The hedge type adjustment used in returns response items. Adjustment can be made for HEDGED and UNHEDGED values that will be included in the return calculation…
sasbScoreTypes
array
The FactSet Truvalue Score types being requested. Score Types include the Pulse, Insight, Momentum, Article Volume, Category Volume, Dynamic Materiality Score,…
statistic
string
Statistic for consensus calculation.
errorResponse_2
object
5 properties
rankCategories
array
The Categories representing overall or composite rankings from all underlying 26 SASB Categories. SASB Categories |SASB Category Inputs|Description| ||| |ALLCA…
metricsResponse
object
1 property
fixedIncomeBenchmarkConstituentsResponse
object
1 property
categories
array
The SASB Categories requested for the respective scoreType(s). The default value is ALLCATEGORIES, which represents all 26 categories in a single overall score…
detailRatings
object
10 properties
indexSnapshotResponse
object
1 property
surpriseResponse
object
1 property
metricsRequest
object
Metrics Request Body
2 properties
paiIds
array
Security or Entity identifiers. FactSet Identifiers, tickers, CUSIP and SEDOL are accepted input. Make note, GET Method URL request lines are also limited to a…
errorResponse_3
object
5 properties
fieldsSdgSpotlights
array
Request available SDG Spotlights data fields to be included in the response. Default is all fields. fsymId,orgId, date, spotlightId, groupId and requestId are…
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Factset publishes across the network.