Factset Factset Benchmarks API

openapi: 3.0.3
info:
  title: Factset Analytics Datastore About Factset Benchmarks API
  description: Allow clients to fetch precalculated Analytics through predeterministic URLs.
  contact:
    name: FactSet Research Systems
    url: https://developer.factset.com/contact
    email: api@factset.com
  license:
    name: Apache License, Version 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
  version: 1.0.0
servers:
- url: https://api.factset.com
  description: Production
- url: https://api-sandbox.factset.com
  description: Sandbox
security:
- basicAuth: []
tags:
- name: Factset Benchmarks
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.  \n"
      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:
  schemas:
    indexIds:
      title: Index Ids
      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.
      example:
      - SP50
    benchmarkConstituentsResponse:
      title: Benchmark Constituents Response
      type: object
      properties:
        data:
          description: 'Array of metric objects representing the metrics that can be requested

            from the estimates APIs.

            '
          type: array
          items:
            $ref: '#/components/schemas/benchmarkConstituent'
    calendar:
      title: Calendar
      type: string
      enum:
      - FIVEDAY
      - SEVENDAY
      default: FIVEDAY
      description: Calendar of data returned. SEVENDAY includes weekends.
      example: FIVEDAY
    requestedDate:
      title: Date
      type: string
      description: Date of holding expressed in YYYY-MM-DD format.
      example: '2020-08-06'
    benchmarkIdList:
      title: Benchmark Id List Object
      type: object
      properties:
        fsymId:
          type: string
          description: Benchmark Id
          example: '990100'
          nullable: true
        name:
          type: string
          description: Name of the Benchmark ID
          example: MSCI World Index
          nullable: true
        familyName:
          type: string
          description: Name of the Benchmarks Family
          example: MSCI
          nullable: true
        market:
          type: string
          description: Market grouping related to the Benchmark Family
          example: Developed
          nullable: true
        categoryDescription:
          type: string
          description: Extended name or description of Benchmark Family & Market
          example: International Indices
          nullable: true
    benchmarkRatiosResponse:
      title: Benchmark Ratios Response
      type: object
      properties:
        data:
          description: 'Array of Index History response objects.

            '
          type: array
          items:
            $ref: '#/components/schemas/benchmarkRatios'
    endDate:
      title: End Date
      type: string
      description: Requested end date for Range expressed in YYYY-MM-DD format.
      example: '2019-12-31'
    indexSnapshotRequest:
      type: object
      title: Index Snapshot Request
      properties:
        ids:
          $ref: '#/components/schemas/indexIds'
        date:
          $ref: '#/components/schemas/requestedDate'
        returnType:
          $ref: '#/components/schemas/returnType'
        currency:
          $ref: '#/components/schemas/currency'
        calendar:
          $ref: '#/components/schemas/calendar'
      required:
      - ids
    impliedDate:
      title: Implied Date
      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.
    metrics:
      title: Metrics
      type: array
      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

        '
      items:
        type: string
      minItems: 1
      maxItems: 38
      example:
      - PE
    fixedIncomeBenchmarkConstituent:
      title: Benchmark Constituent
      type: object
      properties:
        fsymId:
          type: string
          description: Benchmark Id
          example: LHMN0001
          nullable: true
        date:
          description: Date of weight and shares.
          type: string
          format: date
          example: '2021-04-12'
          nullable: true
        fsymSecurityId:
          description: FactSet Security Identifier (-S).
          type: string
          example: FV4SC0-S
          nullable: true
        weightClose:
          description: Weight of Security in benchmark (percent).
          type: number
          format: double
          example: 0.00303380596473456
          nullable: true
        amountOutstanding:
          description: Amount Outstanding for the Fixed Income Security.
          type: number
          format: double
          example: 700000
          nullable: true
        price:
          description: Fixed Income Price of security held.
          type: number
          format: double
          example: 106.976
          nullable: true
        adjMarketValue:
          description: Market value adjusted. Market Value represented in Millions.
          type: number
          format: double
          example: 757.233375
          nullable: true
        requestId:
          type: string
          description: Identifier specified in the request
          example: LHMN0001
    constituentIds:
      title: Constituent Ids
      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.
      example:
      - SP50
    fIConstituentIds:
      title: Fixed Income Constituent Ids
      type: array
      items:
        type: string
      minItems: 1
      maxItems: 1
      description: 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` requested, otherwise you will receive an error.
      example:
      - LHMN0001
    benchmarkConstituentsRequest:
      type: object
      title: Benchmark Constituents Request
      properties:
        ids:
          $ref: '#/components/schemas/constituentIds'
        date:
          $ref: '#/components/schemas/requestedDate'
        currency:
          $ref: '#/components/schemas/currency'
        calendar:
          $ref: '#/components/schemas/regionCalendar'
      required:
      - ids
    periodicity:
      title: Periodicity
      type: string
      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

        '
      enum:
      - LTM
      - LTMA
      - STMA
      - NTMA
      - '0'
      - '1'
      - '2'
      - QTR
      default: LTM
      example: LTM
    errorResponse:
      type: object
      title: Error Response
      properties:
        status:
          description: status
          type: string
          example: Bad Request
        timestamp:
          description: timestamp in YYYY-MM-DD HH:MM:SS.SSS
          type: string
          example: '2019-11-01 11:09:41.918'
          format: date-time
        path:
          description: The Endpoint path {package}/version/{endpoint}
          type: string
          example: /factset-benchmarks/v1/{endpoint}
        message:
          description: The plain text error message
          type: string
          example: Validation Error
        subErrors:
          description: subErrors related to the error message. Null if not applicable.
          type: object
          properties:
            object:
              description: the operation ID
              type: string
            field:
              description: Parameter Field Name
              type: string
            message:
              description: Error message
              type: string
            rejectedValue:
              description: Rejected Values in an Array
              type: array
              items:
                type: string
    indexSnapshot:
      title: Index Snapshot Object
      type: object
      properties:
        fsymId:
          type: string
          description: Requested Identifier. Must be a valid Benchmark Identifier recognized by FactSet.
          example: SP50
          nullable: true
        date:
          description: The respective date for values as of the date requested in YYYY-MM-DD format.
          type: string
          format: date
          example: '2020-07-01'
          nullable: true
        name:
          description: Proper Name of Index.
          type: string
          example: S&P 500
          nullable: true
        constituentNumber:
          description: The total number of constituents as of the date requested.
          type: integer
          example: 502
          nullable: true
        currency:
          description: Currency Code used in adjustments. If no Currency was requested, the service will default to the local Calendar.
          type: string
          example: USD
          nullable: true
        marketValue:
          description: Index Level Market Capitalization as of the date requested expressed in millions.
          type: number
          format: double
          example: 27696158.012077
          nullable: true
        price:
          description: Index Level Price
          type: number
          format: double
          example: 3349.15600690205
          nullable: true
        priceReturnPercent1D:
          description: Index Level Price - 1 Day percent change
          type: number
          format: double
          example: 0.642620385795123
          nullable: true
        priceReturnPercentQTD:
          description: Index Level Price - Quarter-to-Date percent change
          type: number
          format: double
          example: 8.02735451465131
          nullable: true
        priceReturnPercentYTD:
          description: Index Level Price - Year-to-Date percent change
          type: number
          format: double
          example: 3.66394447660916
          nullable: true
        totalReturnLevel:
          description: Index Level Total Return Amount. (Gross or Net

# --- truncated at 32 KB (85 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/factset/refs/heads/main/openapi/factset-factset-benchmarks-api-openapi.yml