Factset Factset Benchmarks API

openapi: 3.2.0
info:
  version: 1.8.0
  title: Factset Benchmarks API
  contact:
    name: FactSet Research Systems
    email: api@factset.com
  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: []
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:
  examples:
    allRatiosRequest:
      summary: Requesting all available index level ratios for S&P 500 on LTM basis as of latest calendar year end
      description: 'Requesting all available index level ratios for S&P 500 on LTM basis as of latest calendar year end

        '
      value:
        ids:
        - SP50
        periodicity: LTM
        metrics:
        - GROSS_MARGIN
        - OPER_INC_SALES
        - NET_MGN
        - EBIT_MARGIN
        - EBITDA_MARGIN
        - ROA
        - ROE
        - ROIC
        - FCF_MGN
        - PE
        - PEX
        - PSALES
        - PBK
        - PCF
        - PCFX
        - PFCF
        - EVAL_EBIT
        - EVAL_EBITDA
        - EVAL_SALES
        - NDEBT_EBITDA
        - NDEBT_EBITDA_MIN_CAPEX
        - DEBT_EBITDA
        - DEBT_EBIT
        - EBIT_INT_EXP
        - EBITDA_INT_EXP
        - OPER_CF_INT_EXP
        - LTD_EBITDA
        - NDEBT_FFO
        - LTD_FFO
        - FCF_DEBT
        - OPER_CF_DEBT
        - LTD_EQ
        - LTD_TCAP
        - LTD_ASSETS
        - DEBT_ASSETS
        - DEBT_EQ
        - NDEBT_TCAP
        - DEBT_TCAP
        frequency: CY
    unsupportedMediaType:
      summary: Unsupported Media Type
      description: This bad request occurs when the media type passed in the request is not supported. Currently the APIs only support 'application/json'.
      value:
        status: Unsupported Media Type
        timestamp: '2020-07-02 09:42:27.237'
        path: /factset-benchmarks/v1/{endpoint}
        message: text/html media type is not supported. Supported media types are application/json
        subErrors: null
    badRequestDateFormat:
      summary: Bad Request - Date Format
      description: This bad request occurs when a request doesn't use the YYYY-MM-DD in the date parameters. To resolve, convert your date to YYYY-MM-DD.
      value:
        status: Bad Request
        timestamp: '2020-07-02 11:52:36.464'
        path: /factset-benchmarks/v1/{endpoint}
        message: 'The date parameter must be in the following date format: YYYY-MM-DD'
        subErrors: null
    resultofBenchmarkIDSPY-US:
      summary: Result of Benchmark Constituent Id SPY-US (only first 10 records for example purpose).
      description: 'This is the list of all constituents that make up the SPDR S&P 500 ETF (SPY-US) as of 2020-07-01. The ETF is used as a proxy for S&P 500 Benchmark. To limit the response size of specification file, only first 10 items are shown.

        '
      value:
        data:
        - adjHolding: 0.89521
          adjMarketValue: 304.908526
          currency: USD
          date: '2021-03-08'
          fsymId: SPY-US
          fsymRegionalId: F07Q7W-R
          fsymSecurityId: TKPJVY-S
          price: 340.6
          requestId: SPY-US
          unadjHolding: 0.89521
          weightClose: 0.092687242574555
        - adjHolding: 15.456894
          adjMarketValue: 1168.69575534
          currency: USD
          date: '2021-03-08'
          fsymId: SPY-US
          fsymRegionalId: MKC1SV-R
          fsymSecurityId: K6TLGQ-S
          price: 75.61
          requestId: SPY-US
          unadjHolding: 15.456894
          weightClose: 0.355264539145919
        - adjHolding: 3.212757
          adjMarketValue: 277.35731181
          currency: USD
          date: '2021-03-08'
          fsymId: SPY-US
          fsymRegionalId: RFPMVX-R
          fsymSecurityId: C8QZP6-S
          price: 86.33
          requestId: SPY-US
          unadjHolding: 3.212757
          weightClose: 0.084312120677006
        - adjHolding: 1.164754
          adjMarketValue: 156.34492942
          currency: USD
          date: '2021-03-08'
          fsymId: SPY-US
          fsymRegionalId: JWH12W-R
          fsymSecurityId: TLPSG8-S
          price: 134.23
          requestId: SPY-US
          unadjHolding: 1.164754
          weightClose: 0.047526320724968
        - adjHolding: 6.780214
          adjMarketValue: 178.18402392
          currency: USD
          date: '2021-03-08'
          fsymId: SPY-US
          fsymRegionalId: LY653H-R
          fsymSecurityId: Q0KPX4-S
          price: 26.28
          requestId: SPY-US
          unadjHolding: 6.780214
          weightClose: 0.0541650509569
        - adjHolding: 5.847468
          adjMarketValue: 261.14792088
          currency: USD
          date: '2021-03-08'
          fsymId: SPY-US
          fsymRegionalId: FS32CR-R
          fsymSecurityId: D1QS87-S
          price: 44.66
          requestId: SPY-US
          unadjHolding: 5.847468
          weightClose: 0.079384728948003
        - adjHolding: 0.874856
          adjMarketValue: 256.8139788
          currency: USD
          date: '2021-03-08'
          fsymId: SPY-US
          fsymRegionalId: CN7T72-R
          fsymSecurityId: C0SZHB-S
          price: 293.55
          requestId: SPY-US
          unadjHolding: 0.874856
          weightClose: 0.078067280905002
        - adjHolding: 3.484578
          adjMarketValue: 242.178171
          currency: USD
          date: '2021-03-08'
          fsymId: SPY-US
          fsymRegionalId: X0N4MP-R
          fsymSecurityId: D506QF-S
          price: 69.5
          requestId: SPY-US
          unadjHolding: 3.484578
          weightClose: 0.073618232904839
        - adjHolding: 0.90688
          adjMarketValue: 539.5210496
          currency: USD
          date: '2021-03-08'
          fsymId: SPY-US
          fsymRegionalId: V9977J-R
          fsymSecurityId: JPYYTB-S
          price: 594.92
          requestId: SPY-US
          unadjHolding: 0.90688
          weightClose: 0.164005641476728
        - adjHolding: 2.505859
          adjMarketValue: 855.62555555
          currency: USD
          date: '2021-03-08'
          fsymId: SPY-US
          fsymRegionalId: KC6WDM-R
          fsymSecurityId: BV8916-S
          price: 341.45
          requestId: SPY-US
          unadjHolding: 2.505859
          weightClose: 0.260096280220945
    resultofIndexSnapshotMultiple:
      summary: Index Snapshot of Prices and Returns for Two Companies as of 2020-08-06
      description: The Price and Returns of S&P 500 and Russell 3000 as of 2020-08-06
      value:
        data:
        - constituentNumber: 505
          currency: LOCAL
          date: '2020-08-06'
          fsymId: SP50
          marketValue: 27696158.012077
          name: S&P 500
          price: 3349.15600690205
          priceReturnPercent1D: 0.642620385795123
          priceReturnPercentQTD: 8.02735451465131
          priceReturnPercentYTD: 3.66394447660916
          requestId: SP50
          returnType: GROSS
          totalReturnLevel: 6870.86168040129
          totalReturnPercent1D: 0.653957589855003
          totalReturnPercentQTD: 8.17415047623613
          totalReturnPercentYTD: 4.84152796547426
        - constituentNumber: 3000
          currency: LOCAL
          date: '2020-08-06'
          fsymId: R.3000
          marketValue: 32954409.7735481
          name: Russell 3000
          price: 3596.989378
          priceReturnPercent1D: 0.502392266457519
          priceReturnPercentQTD: 8.22378331718046
          priceReturnPercentYTD: 3.47683663855225
          requestId: R.3000
          returnType: GROSS
          totalReturnLevel: 10597.086657
          totalReturnPercent1D: 0.513265793869122
          totalReturnPercentQTD: 8.35826463942657
          totalReturnPercentYTD: 4.59191053652597
    badRequestMalformedJSON:
      summary: Bad Request - Malformed JSON Request
      description: This error may be returned when the request body is specified as JSON. But is not in proper JSON format.
      value:
        status: Bad Request
        timestamp: '2020-07-02 11:59:09.649'
        path: /factset-benchmarks/v1/{endpoint}
        message: Malformed JSON Request
        subErrors: null
    badRequestInvalidParameters:
      summary: Bad Request - Passing invalid Benchmark Identifier
      description: This error message occurs when user is passing Invalid Identifier. Please use the helper endpoint */id-list* for sample Benchmark Identifiers.
      value:
        status: Forbidden
        timestamp: '2020-07-10 15:01:43.634'
        path: /factset-benchmarks/v1/constituents
        message: User is not authorized for the id requested, please reach out to FactSet for support
        subErrors: null
    badRequestFutureDate:
      summary: Bad Request - Future Date
      description: This error message occurs when a future date is requested in the date parameters. Please revise your request to include dates as of today's current date or any prior historical date.
      value:
        status: Bad Request
        timestamp: '2020-06-30 13:38:36.528'
        path: /factset-benchmarks/v1/{endpoint}
        message: The use of future dates is not applicable in this endpoint. Please revise your request to include dates up to today's current date.
        subErrors: null
    generalException:
      summary: Internal Server Error - General Exception
      description: This is the most general error that can be returned to by the service. Please `Report Issue` to FactSet.
      value:
        status: Internal Server Error
        timestamp: '2019-11-01 10:36:01.944'
        path: /factset-benchmarks/v1/{endpoint}
        message: Unexpected error
        subErrors: null
    notWritable:
      summary: Internal Server Error - Not Writable
      description: This error may be returned when the server encounters an error writing the JSON response.
      value:
        status: Internal Server Error
        timestamp: '2019-11-05 09:48:29.18'
        path: /factset-benchmarks/v1/{endpoint}
        message: Error writing JSON output
        subErrors: null
    unauthenticated:
      summary: User Authentication Failed
      description: This occurs when a user is not properly authenticated or recognized by the service. Please double check the USERNAME-SERIAL and API-Key used to request and ensure you are within the IP range specified for the Key. Report Issue under 401 error for help with troubleshooting.
      value:
        status: User Authentication Failed
        timestamp: '2020-07-02 16:08:07.945'
        path: /factset-benchmarks/v1/{endpoint}
        message: User Authentication Failed.
        subErrors: null
    allRatiosSP50:
      summary: Result of Fetching all avialable Index Level LTM Ratios for the S&P 500
      description: 'The response of requesting all available Index Level Ratios on a Last Twelve-Month basis as of latest calendar year end.

        '
      value:
      - currency: USD
        date: '2019-12-31'
        fsymId: SP50
        metric: GROSS_MARGIN
        name: S&P 500
        periodicity: LTM
        requestId: SP50
        value: 31.9792508103446
      - currency: USD
        date: '2019-12-31'
        fsymId: SP50
        metric: OPER_INC_SALES
        name: S&P 500
        periodicity: LTM
        requestId: SP50
        value: 14.1443835805019
      - currency: USD
        date: '2019-12-31'
        fsymId: SP50
        metric: NET_MGN
        name: S&P 500
        periodicity: LTM
        requestId: SP50
        value: 10.6712678960164
      - currency: USD
        date: '2019-12-31'
        fsymId: SP50
        metric: EBIT_MARGIN
        name: S&P 500
        periodicity: LTM
        requestId: SP50
        value: 13.9233219620531
      - currency: USD
        date: '2019-12-31'
        fsymId: SP50
        metric: EBITDA_MARGIN
        name: S&P 500
        periodicity: LTM
        requestId: SP50
        value: 20.2564469882192
      - currency: USD
        date: '2019-12-31'
        fsymId: SP50
        metric: ROA
        name: S&P 500
        periodicity: LTM
        requestId: SP50
        value: 3.57523339824615
      - currency: USD
        date: '2019-12-31'
        fsymId: SP50
        metric: ROE
        name: S&P 500
        periodicity: LTM
        requestId: SP50
        value: 16.4002812973854
      - currency: USD
        date: '2019-12-31'
        fsymId: SP50
        metric: ROIC
        name: S&P 500
        periodicity: LTM
        requestId: SP50
        value: 8.89427850180667
      - currency: USD
        date: '2019-12-31'
        fsymId: SP50
        metric: FCF_MGN
        name: S&P 500
        periodicity: LTM
        requestId: SP50
        value: 11.7909348774282
      - currency: USD
        date: '2019-12-31'
        fsymId: SP50
        metric: PE
        name: S&P 500
        periodicity: LTM
        requestId: SP50
        value: 21.5977805004107
      - currency: USD
        date: '2019-12-31'
        fsymId: SP50
        metric: PEX
        name: S&P 500
        periodicity: LTM
        requestId: SP50
        value: 21.0620470124885
      - currency: USD
        date: '2019-12-31'
        fsymId: SP50
        metric: PSALES
        name: S&P 500
        periodicity: LTM
        requestId: SP50
        value: 2.30475701679242
      - currency: USD
        date: '2019-12-31'
        fsymId: SP50
        metric: PBK
        name: S&P 500
        periodicity: LTM
        requestId: SP50
        value: 3.54209675605922
      - currency: USD
        date: '2019-12-31'
        fsymId: SP50
        metric: PCF
        name: S&P 500
        periodicity: LTM
        requestId: SP50
    

# --- 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