openapi: 3.0.0
info:
version: 1.8.0
title: FactSet Benchmarks API
contact:
name: FactSet Research Systems
email: [email protected]
description: >
FactSet Benchmarks API gives access to Index Constituents, Prices, Returns,
and Ratios. For a sample list of identifiers, use the /metrics endpoint.
Equity Only - Fixed Income Benchmark support coming soon.
servers:
- url: https://api.factset.com/content
description: Production
security:
- BasicAuth: []
paths:
/factset-benchmarks/v1/constituents:
get:
tags:
- Factset Benchmarks
summary: >-
Factset Returns the requested Benchmark Constituents and respective Weights, Price and Market Value.
operationId: getBenchmarkConstituents
description: >
Returns the requested Benchmark Constituents and respective Weights,
Price and Market Value. You must be authorized for the `ids` requested.
Use the helper endpoint **/id-list** for valid identifiers.
parameters:
- $ref: '#/components/parameters/constituentIds'
- $ref: '#/components/parameters/requestedDate'
- $ref: '#/components/parameters/currency'
- $ref: '#/components/parameters/regionCalendar'
responses:
'200':
description: Benchmark data items
content:
application/json:
schema:
$ref: '#/components/schemas/benchmarkConstituentsResponse'
examples:
Result of Benchmark Constituent id SPY-US:
$ref: '#/components/examples/resultofBenchmarkIDSPY-US'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'415':
$ref: '#/components/responses/415'
'500':
$ref: '#/components/responses/500'
post:
tags:
- Factset Benchmarks
summary: >-
Factset Returns the requested Benchmark Constituents and respective Weights, Price and Market Value.
description: >
Returns the requested Benchmark Constituents and respective Weights,
Price and Market Value. You must be authorized for the `ids` requested.
Use the helper endpoint **/id-list** for valid identifiers.
operationId: getBenchmarkConstituentsForList
requestBody:
required: true
description: Requests Benchmark Constituents for the given identifier and date.
content:
application/json:
schema:
$ref: '#/components/schemas/benchmarkConstituentsRequest'
responses:
'200':
description: Benchmark data items
content:
application/json:
schema:
$ref: '#/components/schemas/benchmarkConstituentsResponse'
examples:
Result of Benchmark Constituent SPY-US:
$ref: '#/components/examples/resultofBenchmarkIDSPY-US'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'415':
$ref: '#/components/responses/415'
'500':
$ref: '#/components/responses/500'
/factset-benchmarks/v1/fixed-income-constituents:
get:
tags:
- Factset Benchmarks
summary: >-
Factset Returns the requested Fixed Income Benchmark Constituents and respective Weights, Price and Market Value.
operationId: getFIBenchmarkConstituents
description: >
Returns the requested Fixed Income Benchmark Constituents and respective
Weights, Price and Market Value. You must be authorized for the `ids`
requested.
parameters:
- $ref: '#/components/parameters/fIConstituentIds'
- $ref: '#/components/parameters/requestedDate'
- $ref: '#/components/parameters/currency'
responses:
'200':
description: Fixed Income Constituent data items
content:
application/json:
schema:
$ref: '#/components/schemas/fixedIncomeBenchmarkConstituentsResponse'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'415':
$ref: '#/components/responses/415'
'500':
$ref: '#/components/responses/500'
post:
tags:
- Factset Benchmarks
summary: >-
Factset Returns the requested Benchmark Constituents and respective Weights, Price and Market Value.
description: >
Returns the requested Fixed Income Benchmark Constituents and respective
Weights, Price and Market Value. You must be authorized for the `ids`
requested.
operationId: getFIBenchmarkConstituentsForList
requestBody:
required: true
description: >-
Requests Fixed Income Benchmark Constituents for the given identifier
and date.
content:
application/json:
schema:
$ref: '#/components/schemas/fixedIncomeBenchmarkConstituentsRequest'
responses:
'200':
description: Fixed Income Constituent data items
content:
application/json:
schema:
$ref: '#/components/schemas/fixedIncomeBenchmarkConstituentsResponse'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'415':
$ref: '#/components/responses/415'
'500':
$ref: '#/components/responses/500'
/factset-benchmarks/v1/index-snapshot:
get:
summary: >-
Factset Index Level Prices, Returns, and related information as of a single date.
operationId: getIndexSnapshot
tags:
- Factset Benchmarks
description: >
Retrieves Index Level Prices and Returns information as of a specific
date. Simply submit a valid Benchmark ID (you can use the /id-list
endpoint for a sample list of ids), and date and retrieve Index Level
Prices, Returns, and related information.
parameters:
- $ref: '#/components/parameters/indexIds'
- $ref: '#/components/parameters/requestedDate'
- $ref: '#/components/parameters/returnType'
- $ref: '#/components/parameters/currency'
- $ref: '#/components/parameters/calendar'
responses:
'200':
description: >-
An array of Index Level Prices and Returns information as of a
single date
content:
application/json:
schema:
$ref: '#/components/schemas/indexSnapshotResponse'
examples:
Index Level Prices and Returns snapshot for S&P 500 and Russell 3000 as of 2020-08-06:
$ref: '#/components/examples/resultofIndexSnapshotMultiple'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'415':
$ref: '#/components/responses/415'
'500':
$ref: '#/components/responses/500'
post:
summary: >-
Factset Retrieves the Index Level Snapshot of Prices and Returns information for a given identifier and single date.
operationId: getIndexSnapshotForList
tags:
- Factset Benchmarks
description: >
Retrieves Index Level Prices and Returns information as aligned with
FactSet's Benchmark Data Feed solution. Simply submit a valid Benchmark
ID (you can use the /id-list endpoint for a sample list of ids), and
date and retrieve Index Level Prices, Returns, and related information.
requestBody:
required: true
description: >-
Requests the Index Level Snapshot for a requested list of identifiers
and specified date.
content:
application/json:
schema:
$ref: '#/components/schemas/indexSnapshotRequest'
responses:
'200':
description: >-
An array of Index Level Prices and Returns information as of a
single date.
content:
application/json:
schema:
$ref: '#/components/schemas/indexSnapshotResponse'
examples:
Index Level Prices and Returns snapshot for S&P 500 and Russell 3000 as of 2020-08-06:
$ref: '#/components/examples/resultofIndexSnapshotMultiple'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'415':
$ref: '#/components/responses/415'
'500':
$ref: '#/components/responses/500'
/factset-benchmarks/v1/index-history:
get:
summary: >-
Factset Retrieves Index Level Prices and Returns information for a list of identifiers and historical date range.
operationId: getIndexHistory
tags:
- Factset Benchmarks
description: >
Retrieves Index Level Prices and Returns information as of a date range
requested. Simply submit a valid Benchmark ID (you can use the /id-list
endpoint for a sample list of ids), and date range to retrieve Index
Level Prices, Returns, and related information.
parameters:
- $ref: '#/components/parameters/indexIds'
- $ref: '#/components/parameters/startDate'
- $ref: '#/components/parameters/endDate'
- $ref: '#/components/parameters/frequency'
- $ref: '#/components/parameters/returnType'
- $ref: '#/components/parameters/hedgeType'
- $ref: '#/components/parameters/currency'
- $ref: '#/components/parameters/calendar'
- $ref: '#/components/parameters/impliedDate'
responses:
'200':
description: >-
An array of Index Level Prices and Returns information for a
requested date range.
content:
application/json:
schema:
$ref: '#/components/schemas/indexHistoryResponse'
examples:
Index Level Prices and Returns snapshot for S&P 500 and Russell 3000 from 2020-08-05 to 2020-08-06:
$ref: '#/components/examples/resultofIndexHistoryMultiple'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'415':
$ref: '#/components/responses/415'
'500':
$ref: '#/components/responses/500'
post:
summary: >-
Factset Retrieves Index Level Prices and Returns information for a list of identifiers and historical date range.
operationId: getIndexHistoryForList
tags:
- Factset Benchmarks
description: >
Retrieves Index Level Prices and Returns information as aligned with
FactSet's Benchmark Data Feed solution. Simply submit a valid Benchmark
ID (you can use the /id-list endpoint for a sample list of ids), and
date and retrieve Index Level Prices, Returns, and related information.
requestBody:
required: true
description: >-
Requests Index Level History Prices and Returns for a list of
identifiers and specified date range.
content:
application/json:
schema:
$ref: '#/components/schemas/indexHistoryRequest'
responses:
'200':
description: >-
An array of Index Level Prices and Returns information for a
requested date range.
content:
application/json:
schema:
$ref: '#/components/schemas/indexHistoryResponse'
examples:
Index Level Prices and Returns snapshot for S&P 500 and Russell 3000 from 2020-08-05 to 2020-08-06:
$ref: '#/components/examples/resultofIndexHistoryMultiple'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'415':
$ref: '#/components/responses/415'
'500':
$ref: '#/components/responses/500'
/factset-benchmarks/v1/ratios:
get:
tags:
- Factset Benchmarks
summary: Factset Returns the aggregated ratios of a requested benchmark
operationId: getBenchmarkRatios
description: >
Retrieves the index level ratios for a requested benchmark. Ratios
supported are expressed through metrics parameter, and include
Categories of Profitability, Valuation, Coverage, and Leverage. <p>
Using FactSet Market Aggregates, the service combines fundamental,
estimates, and pricing content to derive ratios and per share values for
global equity market indexes and commercial benchmark vendors. The
constituents of the index are fetched on rolling basis over time period
requested, and then the metric requested is aggregated up to the index
level. To learn more about FMA, visit [OA
15778](https://my.apps.factset.com/oa/pages/15778).</p>
parameters:
- $ref: '#/components/parameters/indexIds'
- $ref: '#/components/parameters/metrics'
- $ref: '#/components/parameters/startDate'
- $ref: '#/components/parameters/endDate'
- $ref: '#/components/parameters/frequency'
- $ref: '#/components/parameters/periodicity'
- $ref: '#/components/parameters/currency'
responses:
'200':
description: Benchmark Ratio data items
content:
application/json:
schema:
$ref: '#/components/schemas/benchmarkRatiosResponse'
examples:
All Index Level Ratios for S&P 500 as of latest year end:
$ref: '#/components/examples/allRatiosSP50'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'415':
$ref: '#/components/responses/415'
'500':
$ref: '#/components/responses/500'
post:
tags:
- Factset Benchmarks
summary: Factset Returns the aggregated ratios of a requested benchmark
description: >
Retrieves the index level ratios for a requested benchmark. Ratios
supported are expressed through metrics parameter, and include
Categories of Profitability, Valuation, Coverage, and Leverage. <p>
Using FactSet Market Aggregates, the service combines FactSet
Fundamental, FactSet Estimates, and FactSet Pricing content to derive
ratios and per share values for global equity market indexes and
commercial benchmark vendors. The constituents of the index are fetched
on rolling basis over time period requested, and then the metric
requested is aggregated up to the index level. To learn more about FMA,
visit [OA 15778](https://my.apps.factset.com/oa/pages/15778).</p>
operationId: getBenchmarkRatiosForList
requestBody:
required: true
description: Requests benchmark ratios for a given id
content:
application/json:
schema:
$ref: '#/components/schemas/benchmarkRatiosRequest'
examples:
Requesting all Index Level Ratios:
$ref: '#/components/examples/allRatiosRequest'
responses:
'200':
description: Benchmark Ratio Response Items
content:
application/json:
schema:
$ref: '#/components/schemas/benchmarkRatiosResponse'
examples:
All Index Level Ratios for S&P 500 as of latest year end:
$ref: '#/components/examples/allRatiosSP50'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'415':
$ref: '#/components/responses/415'
'500':
$ref: '#/components/responses/500'
/factset-benchmarks/v1/id-list:
get:
summary: >-
Factset Returns a sample list of Benchmark Identifiers and the benchmark categorization to use in other Benchmark API endpoints.
operationId: getBenchmarkIds
tags:
- Factset Benchmarks
description: >-
Returns a **sample** list of Benchmark Identifiers to use in other
Benchmark API endpoints. This is a supporting API to be use alongside
the other Benchmark API endpoints. For example, use the fsymID value
returned in this response as the input to your `ids` parameter in the
/constituents endpoint to return constituents for that id.<p> *This is
not the full list of benchmark ids allowed in this service, but rather a
representation of the most commonly requested. For complete assistance
with ID lookup or concordance services, please reach out to FactSet
Support. *</p>
parameters:
- $ref: '#/components/parameters/familyFilter'
responses:
'200':
description: List of sample Benchmark Ids
content:
application/json:
schema:
$ref: '#/components/schemas/benchmarkIdListResponse'
examples:
Result of Benchmark Constituent SPY-US:
$ref: '#/components/examples/resultofBenchmarkID-TOPIX'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'415':
$ref: '#/components/responses/415'
'500':
$ref: '#/components/responses/500'
post:
summary: >-
Factset Returns a sample list of Benchmark Identifiers and the benchmark categorization to use in other Benchmark API endpoints.
operationId: getBenchmarkIdsForList
tags:
- Factset Benchmarks
description: >-
Returns a **sample** list of Benchmark Identifiers to use in other
Benchmark API endpoints. This is a supporting API to be use alongside
the other Benchmark API endpoints. For example, use the fsymID value
returned in this response as the input to your `ids` parameter in the
/constituents endpoint to return constituents for that id.<p> *This is
not the full list of benchmark ids allowed in this service, but rather a
representation of the most commonly requested. For complete assistance
with ID lookup or concordance services, please reach out to FactSet
Support.*</p>
requestBody:
required: true
description: >-
Requests a sample list of identifiers that can be used in other
Benchmarks API endpoints.
content:
application/json:
schema:
$ref: '#/components/schemas/benchmarkIdListRequest'
responses:
'200':
description: List of sample Benchmark Ids
content:
application/json:
schema:
$ref: '#/components/schemas/benchmarkIdListResponse'
examples:
Result of Benchmark Constituent SPY-US:
$ref: '#/components/examples/resultofBenchmarkID-TOPIX'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'415':
$ref: '#/components/responses/415'
'500':
$ref: '#/components/responses/500'
components:
securitySchemes:
BasicAuth:
type: http
scheme: basic
parameters:
constituentIds:
name: ids
in: query
required: true
explode: false
schema:
type: array
items:
type: string
minItems: 1
maxItems: 1
description: >-
Benchmark Identifiers. Reference the helper endpoint **/id-list** to get
a sample list of valid identifiers. You must be authorized for the
`ids` requested, otherwise you will receive an error. <p>***ids limit**
= 1 per request*</p>
fIConstituentIds:
name: ids
in: query
required: true
explode: false
schema:
type: array
items:
type: string
minItems: 1
maxItems: 1
example: LHMN0001
description: >-
Fixed Income Benchmark Identifiers. You must be authorized for the `ids`
requested, otherwise you will receive an error. <p>***ids limit** = 1
per request*</p>
indexIds:
name: ids
in: query
required: true
explode: false
schema:
type: array
items:
type: string
minItems: 1
maxItems: 500
description: >-
Benchmark Identifiers. Reference the helper endpoint **/id-list** to get
a sample list of valid identifiers. <p>***ids limit** = 500 per
request*</p> *<p>Make note, GET Method URL request lines are also
limited to a total length of 8192 bytes (8KB). In cases where the
service allows for thousands of ids, which may lead to exceeding this
request line limit of 8KB, its advised for any requests with large
request lines to be requested through the respective "POST" method.</p>*
requestedDate:
name: date
in: query
required: false
schema:
type: string
description: Date of holding expressed in YYYY-MM-DD format.
startDate:
name: startDate
in: query
required: false
schema:
type: string
description: Requested start date expressed in YYYY-MM-DD format.
endDate:
name: endDate
in: query
required: false
schema:
type: string
description: Requested End Date for Range expressed in YYYY-MM-DD format.
returnType:
name: returnType
in: query
required: false
schema:
type: string
enum:
- GROSS
- NET
default: GROSS
description: >-
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. The service will default to GROSS.
hedgeType:
name: hedgeType
in: query
required: false
schema:
type: string
enum:
- UNHEDGED
- HEDGED
default: UNHEDGED
description: >-
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. The service will default to UNHEDGED.
impliedDate:
name: impliedDate
in: query
required: false
schema:
type: string
enum:
- 'Y'
- 'N'
default: 'N'
description: >-
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. This means it will repeat values for weekends
and holidays. If set to **Y**, the date field will return the implied
date of the observation, making all the dates unique.
calendar:
name: calendar
in: query
schema:
type: string
enum:
- FIVEDAY
- SEVENDAY
default: FIVEDAY
description: Calendar of data returned. SEVENDAY includes weekends.
example: FIVEDAY
regionCalendar:
name: calendar
in: query
schema:
type: string
description: >-
Calendar of data returned. The default value is FIVEDAY which displays
Monday through Friday, regardless of whether there were trading
holidays.
required: false
examples:
fiveday:
summary: FIVEDAY
description: >-
Displays Monday through Friday, regardless of whether there were
trading holidays. This is the default for `calendar`.
value: FIVEDAY
sevenday:
summary: SEVENDAY
description: Displays Monday through Sunday.
value: SEVENDAY
region:
summary: Region Specific
description: >-
The calendar of a specific region. The example shown here 'NAY' is
for the UNITED STATES calendar. You can find the calendar codes for
regions on [Online Assistant Page
16610](https://my.apps.factset.com/oa/pages/16610#country).
value: NAY
currency:
name: currency
in: query
required: false
schema:
type: string
description: Currency for response.
frequency:
name: frequency
in: query
schema:
type: string
enum:
- D
- W
- M
- AM
- CQ
- AY
- CY
default: D
description: |
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 trading day of the month.
* **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.).
* **CQ** = Quarterly based on the last trading day of the calendar quarter (March, June, September, or December).
* **AY** = Actual Annual, based on the start date.
* **CY** = Calendar Annual, based on the last trading day of the calendar year.
examples:
Daily:
summary: D - Daily frequency display based on trading calendar
value: D
Weekly:
summary: W - Weekly - based on the last day of the week of the start date
value: W
Monthly:
summary: M - Monthly - based on the last trading day of the month.
value: M
Actual Month:
summary: >-
AM - Actual Month - based on the startDate (e.g., if the start date
is June 16, data is displayed for June 16, May 16, April 16 etc.).
value: AM
Calendar Quarterly:
summary: >-
CQ - Calendar Quarterly - based on the last day of the week of the
startDate
value: CQ
Actual Annual:
summary: AY - Actual Annual - based on the startDate
value: AY
Calendar Annual:
summary: >-
CY - Calendar Annual - based on the last trading day of the calendar
year.
value: CY
periodicity:
name: periodicity
in: query
schema:
type: string
enum:
- LTM
- LTMA
- STMA
- NTMA
- '0'
- '1'
- '2'
- QTR
default: LTM
required: false
description: >
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 as default and supported for all metrics. See
Metrics Parameter for additional detail on which periodicities are
available per metric.
|Periodicity| Description|
|:|:|
|LTM| Last Twelve Months
|LTMA| Last Twelve Months using Broker Actuals for Estimated Items
|STMA| Second Twelve Month Forward
|NTMA| 12 Month Forward
|0| Latest Reported Calendar Year
|1| Current Unreported Year
|2| Following Year
|QTR| Quarterly - Reported by companies
metrics:
name: metrics
in: query
required: true
explode: false
description: >
Requested List of FactSet Market Aggregates (FMA) or ratios. provided
the below complete metrics list.
|metric item|Description|category|periodicity
|:|:|:|:|
|GROSS_MARGIN|Gross Margin|Profitability (%)|NTMA, LTMA, STMA, LTM, QTR,
0, 1, 2
|OPER_INC_SALES|Operating Margin|Profitability (%)|LTM, QTR
|NET_MGN|Net Margin|Profitability (%)|NTMA, LTMA, STMA, LTM, QTR, 0, 1,
2
|EBIT_MARGIN|EBIT Margin|Profitability (%)| NTMA, LTMA, STMA, LTM, QTR,
0, 1, 2
|EBITDA_MARGIN|EBITDA Margin|Profitability (%)|NTMA, LTMA, STMA, LTM,
QTR, 0, 1, 2
|ROA|Return on Assets|Profitability (%)|LTM
|ROE|Return on Equity|Profitability (%)|NTMA, LTMA, LTM, 0, 1, 2
|ROIC|Return on Invested Capital|Profitability (%)| LTM
|FCF_MGN|Free Cash Flow Margin|Profitability (%)|LTM, QTR
|PE|Price/Earnings|Valuation|NTMA, LTMA, STMA, LTM, QTR, 0, 1, 2
|PEX|Price/Earnings (excl negatives)|Valuation|LTM
|PSALES|Price/Sales|Valuation|NTMA, LTMA, STMA, LTM, QTR, 0, 1, 2
|PBK|Price/Book Value|Valuation|NTMA, LTMA, LTM, 0, 1, 2
|PCF|Price/Cash Flow|Valuation|NTMA, LTMA, LTM, 0, 1, 2
|PCFX|Price/Cash Flow (excl negatives)|Valuation|LTM
|PFCF|Price/Free Cash Flow|Valuation|NTMA, LTMA, LTM, 0, 1, 2
|EVAL_EBIT|Enterprise Value/EBIT|Valuation|NTMA, LTMA, LTM, 0, 1, 2
|EVAL_EBITDA|Enterprise Value/EBITDA|Valuation|NTMA, LTMA, LTM, 0, 1, 2
|EVAL_SALES|Enterprise Value/Sales|Valuation|NTMA, LTMA, LTM, 0, 1, 2
|NDEBT_EBITDA|Net Debt/EBITDA|Coverage|NTMA, LTMA, LTM, 0, 1, 2
|NDEBT_EBITDA_MIN_CAPEX|Net Debt/(EBITDA-Capex)|Coverage|LTM
|DEBT_EBITDA|Total Debt/EBITDA|Coverage|LTM
|DEBT_EBIT|Total Debt/EBIT|Coverage|LTM
|EBIT_INT_EXP|EBIT/Interest Expense (Int. Coverage)|Coverage|LTM
|EBITDA_INT_EXP|EBITDA/Interest Expense|Coverage|LTM
|OPER_CF_INT_EXP|CFO/Interest Expense|Coverage|LTM
|LTD_EBITDA|LT Debt/EBITDA|Coverage|LTM
|NDEBT_FFO|Net Debt/FFO|Coverage|LTM
|LTD_FFO|LT Debt/FFO|Coverage|LTM
|FCF_DEBT|FCF/Total Debt|Coverage|LTM
|OPER_CF_DEBT|CFO/Total Debt|Coverage|LTM
|LTD_EQ|LT Debt/Total Equity|Leverage(%)|LTM
|LTD_TCAP|LT Debt/Total Capital|Leverage(%)|LTM
|LTD_ASSETS|LT Debt/Total Assets|Leverage(%)|LTM
|DEBT_ASSETS|Total Debt/Total Assets|Leverage(%)|LTM
|DEBT_EQ|Total Debt/Total Equity|Leverage(%)|LTM
|NDEBT_TCAP|Net Debt/Total Capital|Leverage(%)|LTM
|DEBT_TCAP|Total Debt/Total Capital|Leverage(%)|LTM
|<p>***metrics limit** = 38 per request*</p>
*<p>Make note, GET Method URL request lines are also limited to a total
length of 8192 bytes (8KB). In cases where the service allows for
thousands
of ids, which may lead to exceeding this request line limit of 8KB, its
advised for any requests with large request lines to be requested
through
the respective "POST" method.</p>*
schema:
type: array
items:
type: string
example:
- PEX
- LTD_EQ
- DEBT_EQ
minItems: 1
maxItems: 38
examples:
Single Metric:
summary: LTD_EQ
value:
- LTD_EQ
Multiple Metrics:
summary: PEX, LTD_EQ, DEBT_EQ
value:
- PEX
- LTD_EQ
- DEBT_EQ
familyFilter:
name: familyFilter
in: query
required: false
description: >
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, use the response items such as the
categoryDescription field. Leave blank if you wish to see a full sample
list of ids. requested-
* **CHINA & HK INDICES** - Major Hong Kong and China Indices, such as
Hang Seng Index (HSI-HK
# --- truncated at 32 KB (89 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/factset/refs/heads/main/openapi/benchmarks-openapi-original.yml