Factset Time Series API

openapi: 3.2.0
info:
  version: 1.7.1
  title: FactSet Formula Time Series API
  description: "\n**FactSet Formula API**\n\nFactSet’s Formula API is a modern, flexible, formula-based API that enables users to access FactSet’s wide range of financial data and content. The API offers two endpoints, one optimized for time-series analysis and one designed for cross-sectional analysis, providing users a simplified interface into FactSet’s expansive offering. By providing two endpoints, it allows for the optimization of user workflows, while reducing complexity.\n\nLeverage the power and flexibility of the Formula API to -\n  * Pull data from across most content sets that a user has access to in a single request\n  * Include business logic and mathematical operations in request\n  * Submit a dynamic universe in both endpoints\n  * Return the fsymId to easily combine with other FactSet content / products\n  * Set the trading calendar\n  * Define custom display names\n\n**Formula API Request Builder**\n\nThe Formula API Request Builder provides users everything they need to form a Formula API request. In the Request Builder, you can select identifiers, build a universe expression, select FQL or Screening formulas, easily apply business logic and mathematical functions to the FQL or Screening formulas, specify optional parameters, and construct a GET or POST request. The Request Builder eliminates the need to have previous FQL and Screening knowledge and allows you to quickly find your desired data items and form the request.\n\nThe Formula API Request Builder can be accessed by navigating to [https://developer.factset.com/formula-api-request-builder](https://developer.factset.com/formula-api-request-builder) and logging in using your FactSet.net ID. When using the Request Builder to construct requests for the one of the Formula API's endpoints, be sure to toggle to the correct endpoint at the top of the page.\n\n**How to Check the Health and Availability of the Formula API**\n\nPlease use the below endpoint to check the health and availability of the Formula API. You must be authorized for this API to use the Health endpoint.\n\n[https://api.factset.com/formula-api/health](https://api.factset.com/formula-api/health)\n\n**How to Programmatically Download API Specification File**\n\nYou can download the FactSet Formula API Specification File in .yaml. using the \"Download Spec\" button to the right of the version number. This specification can then be used for Codegen to create your own SDKs.\n"
servers:
- description: Production
  url: https://api.factset.com/formula-api
security:
- BasicAuth: []
tags:
- name: Time Series
paths:
  /v1/time-series:
    get:
      summary: Factset Retrieve data items (FQL formulas) for a list of identifiers or defined universe.
      description: "The `/time-series` endpoint is closely aligned with FactSet’s powerful data retrieval language **FactSet Query Language (FQL)** which is optimized for time-series analysis. FQL can also perform sophisticated statistical, mathematical, logical, and other complex operations on the data.\n\n  This endpoint has a unique **TIMESERIES** data object that pairs the requested data with FactSet provided dates. This helps reduce the need for additional data requests and reduces the work required by users.\n\nThe `/time-series` endpoint supports Long Running asynchronous requests up to **20 minutes** via the `batch` parameter. *This feature is available to Individual Users subscribed to the Performance Package and Performance Package Plus Performance Tiers and all Production Users. If you are unsure which Performance Tier you are subscribed to or you would like to gain access to the batch capabilities, please contact your FactSet Account Team or \"Report Issue\" above and our support teams can assist.*\n"
      tags:
      - Time Series
      operationId: getTimeSeriesData
      parameters:
      - $ref: '#/components/parameters/ids'
      - $ref: '#/components/parameters/symbolType'
      - $ref: '#/components/parameters/universe'
      - $ref: '#/components/parameters/universeType_time_series'
      - $ref: '#/components/parameters/formulas_time_series'
      - $ref: '#/components/parameters/calendar_time_series'
      - $ref: '#/components/parameters/fsymId_time_series'
      - $ref: '#/components/parameters/displayName_time_series'
      - $ref: '#/components/parameters/flatten_time_series'
      - $ref: '#/components/parameters/dates_time_series'
      - $ref: '#/components/parameters/batch'
      responses:
        '200':
          description: Gets an array of `Response Objects` for a list of IDs and FQL formulas.
          headers:
            api-version:
              $ref: '#/components/headers/api-version'
            api-supported-versions:
              $ref: '#/components/headers/api-supported-versions'
            api-deprecated-versions:
              $ref: '#/components/headers/api-deprecated-versions'
            chain-id:
              $ref: '#/components/headers/chain-id'
            X-RateLimit-Limit-second:
              $ref: '#/components/headers/X-RateLimit-Limit-second'
            X-RateLimit-Remaining-second:
              $ref: '#/components/headers/X-RateLimit-Remaining-second'
            X-RateLimit-Limit-day:
              $ref: '#/components/headers/X-RateLimit-Limit-day'
            X-RateLimit-Remaining-day:
              $ref: '#/components/headers/X-RateLimit-Remaining-day'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/time_series_response'
              examples:
                Single Id and Single Data Item:
                  $ref: '#/components/examples/time-series-singleId-singleItem'
                Single Id and Single Data Item with fsymId=Y:
                  $ref: '#/components/examples/time-series-singleId-singleItem-fsymId'
                Multiple Ids and Multiple Data Items with SEVENDAY Calendar:
                  $ref: '#/components/examples/time-series-multipleId-multipleItem'
                Multiple Ids and Multiple Data Items with flatten=Y:
                  $ref: '#/components/examples/time-series-multipleId-multipleItem-flatten'
                Multiple Ids and Multiple Calculated Data Items:
                  $ref: '#/components/examples/time-series-multipleId-multipleCalculatedItem'
                Small Universe and Single Data Item:
                  $ref: '#/components/examples/time-series-smallUniv-singleItem'
                Debt Universe and Multiple Data Items:
                  $ref: '#/components/examples/time-series-debtUniv-multipleItem'
        '202':
          description: Batch request has been accepted.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchStatusResponse'
              examples:
                Batch Request Accepted:
                  $ref: '#/components/examples/BatchStatusAcceptedResponse'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '408':
          $ref: '#/components/responses/408'
        '415':
          $ref: '#/components/responses/415'
        '429':
          $ref: '#/components/responses/429'
        '500':
          $ref: '#/components/responses/500'
        '501':
          $ref: '#/components/responses/501'
        '503':
          $ref: '#/components/responses/503'
    post:
      summary: Factset Retrieve data items (FQL formulas) for a list of identifiers or defined universe.
      description: "The `/time-series` endpoint is closely aligned with FactSet’s powerful data retrieval language **FactSet Query Language (FQL)** which is optimized for time-series analysis. FQL can also perform sophisticated statistical, mathematical, logical, and other complex operations on the data.\n\n  This endpoint has a unique **TIMESERIES** data object that pairs the requested data with FactSet provided dates. This helps reduce the need for additional data requests and reduces the work required by users.\n\nThe `/time-series` endpoint supports Long Running asynchronous requests up to **20 minutes** via the `batch` parameter. *This feature is available to Individual Users subscribed to the Performance Package and Performance Package Plus Performance Tiers and all Production Users. If you are unsure which Performance Tier you are subscribed to or you would like to gain access to the batch capabilities, please contact your FactSet Account Team or \"Report Issue\" above and our support teams can assist.*\n"
      tags:
      - Time Series
      operationId: getTimeSeriesDataForList
      responses:
        '200':
          description: Gets an array of `Response Objects` for a list of IDs and FQL formulas.
          headers:
            api-version:
              $ref: '#/components/headers/api-version'
            api-supported-versions:
              $ref: '#/components/headers/api-supported-versions'
            api-deprecated-versions:
              $ref: '#/components/headers/api-deprecated-versions'
            chain-id:
              $ref: '#/components/headers/chain-id'
            X-RateLimit-Limit-second:
              $ref: '#/components/headers/X-RateLimit-Limit-second'
            X-RateLimit-Remaining-second:
              $ref: '#/components/headers/X-RateLimit-Remaining-second'
            X-RateLimit-Limit-day:
              $ref: '#/components/headers/X-RateLimit-Limit-day'
            X-RateLimit-Remaining-day:
              $ref: '#/components/headers/X-RateLimit-Remaining-day'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/time_series_response'
              examples:
                Single Id and Single Data Item:
                  $ref: '#/components/examples/time-series-singleId-singleItem'
                Single Id and Single Data Item with fsymId=Y:
                  $ref: '#/components/examples/time-series-singleId-singleItem-fsymId'
                Multiple Ids and Multiple Data Items with SEVENDAY Calendar:
                  $ref: '#/components/examples/time-series-multipleId-multipleItem'
                Multiple Ids and Multiple Data Items with flatten=Y:
                  $ref: '#/components/examples/time-series-multipleId-multipleItem-flatten'
                Multiple Ids and Multiple Calculated Data Items:
                  $ref: '#/components/examples/time-series-multipleId-multipleCalculatedItem'
                Small Universe and Single Data Item:
                  $ref: '#/components/examples/time-series-smallUniv-singleItem'
                Debt Universe and Multiple Data Items:
                  $ref: '#/components/examples/time-series-debtUniv-multipleItem'
        '202':
          description: Batch request has been accepted.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchStatusResponse'
              examples:
                Batch Request Accepted:
                  $ref: '#/components/examples/BatchStatusAcceptedResponse'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '408':
          $ref: '#/components/responses/408'
        '415':
          $ref: '#/components/responses/415'
        '429':
          $ref: '#/components/responses/429'
        '500':
          $ref: '#/components/responses/500'
        '501':
          $ref: '#/components/responses/501'
        '503':
          $ref: '#/components/responses/503'
      requestBody:
        $ref: '#/components/requestBodies/time-series-postBody'
components:
  schemas:
    time_series_result_object_nonflattened_base:
      title: Time-Series Non-Flattened Base Response Object
      description: An object returning the results for a single identifier and formula. This is the base of the response object. The result attribute depends on the formula requested. Response objects with the various result attribute types are outlined in separate schemas.
      type: object
      properties:
        error:
          description: 'Indicates that there was an error in the execution of the FQL Formula.

            * Zero – success

            * Non-zero – failure

            '
          type: integer
          example: 0
        errorMessage:
          description: If error is non-zero, errorMessage will display the FQL formula error.
          type:
          - string
          - 'null'
          example: 'parse error, unexpected '',''

            '
        formula:
          description: FQL formula requested.
          type: string
          example: P_PRICE(0,-1,D)
        displayName:
          description: Display Name.
          type:
          - string
          - 'null'
          example: PRICE
        requestId:
          description: Identifier requested.
          type: string
          example: IBM-US
        fsymId:
          description: 'The **fsymId** field returned is the FactSet Default Permanent Identifier for the `requestId`. For all supported `requestId` symbol types, the `fsymId` parameter will return the Regional Level PermId ''-R'' which identifies the security’s best regional security data series per currency. Currently, the fsymId parameter only supports equities. Accepted `requestId` symbol types include all FactSet Permanent Identifiers types, CUSIP, SEDOL, ISIN, and Tickers. Further documentation can be found at this [Online Assistant attachment](https://oa.apps.factset.com/cms/oaAttachment/64c3213a-f415-4c27-a336-92c73a72deed/24881). Included only if the `fsymId` parameter is set to Y.

            '
          type:
          - string
          - 'null'
          example: SJY281-R
        dataType:
          description: Type of data returned in `result`
          example: STRING
          type:
          - string
          - 'null'
          enum:
          - STRING
          - INTEGER
          - DOUBLE
        objectType:
          description: Type of object returned in `result`
          type: string
          example: ARRAY
          enum:
          - SCALAR
          - ARRAY
          - MATRIX
          - TIMESERIES
      required:
      - error
      - formula
      - requestId
      - result
      - dataType
      - objectType
    error_detail:
      title: Error Object
      description: '`Error Object` is the response returned for an unsuccessful request.

        '
      type: object
      properties:
        id:
          description: Unique identifier for the request. Also known as the chain id.
          type:
          - string
          - 'null'
          example: 5EFCCA8940CAEA6B
        code:
          description: Textual error code
          type:
          - string
          - 'null'
          example: notAuthenticated
        title:
          description: A short, human-readable summary of the problem
          type:
          - string
          - 'null'
          example: There were either no, invalid, or expired credentials present in the request.
        timestamp:
          description: timestamp in YYYY-MM-DD HH:MM:SS.SSS
          type:
          - string
          - 'null'
          format: date-time
          example: '2020-08-01 11:09:41.918'
    time_series_result_object_flattened:
      title: Time-Series Flattened Response Object
      description: "\nData model returned when the parameter **flatten=Y** is used in the request. This flattened, simplified JSON output returned from **flatten=Y** can be conceptualized as a table (rows and columns) where each data object in the result is a row in the table and each field names is a column name. The response will contain at least one data object for each requestId containing the requestId, fsymId (if requested), date (if applicable) and Key-Value pairs for each data item (formula). The number of data objects (rows) per requestId is dependent the the objectTypes of the formulas requested.\n\n\n\nFormulas that have associated dates (TIMESERIES objectType in the standard **flatten=N** response model) will result in a data object for each date for each requestId.\n\n**flatten=N TIMESERIES Representation**\n```json\n[\n  {\n    \"requestId\": \"id\",\n    \"formula\": \"formulaName1\",\n    \"result\": {\n        \"values\": [a,b],\n        \"dates\": [DATE1,DATE2]\n      },\n    \"objectType\": \"TIMESERIES\",\n    \"dataType\": \"DOUBLE\"\n  },\n  {\n    \"requestId\": \"id\",\n    \"formula\": \"formulaName2\",\n    \"result\": {\n        \"values\": [c,d],\n        \"dates\": [DATE2,DATE3]\n      },\n    \"objectType\": \"TIMESERIES\",\n    \"dataType\": \"DOUBLE\"\n  }\n]\n```\n\n**flatten=Y TIMESERIES Representation**\n```json\n[\n  {\n    \"requestId\": \"id\",\n    \"formulaName1\": a,\n    \"formulaName2\": null,\n    \"date\": DATE1\n  },\n  {\n    \"requestId\": \"id\",\n    \"formulaName1\": b,\n    \"formulaName2\": c,\n    \"date\": DATE2\n  },\n  {\n    \"requestId\": \"id\",\n    \"formulaName1\": null,\n    \"formulaName2\": d,\n    \"date\": DATE3\n  }\n]\n```\n\n\n\nFormulas that result in an array (no associated dates, ARRAY objectType in the standard **flatten=N** response model) can be thought of as a column in a table. Each element in the array will be in a separate data object. The first element of the array starts in the first data object for that requestId and then then the second element of the array in the second data object for that requestId and so on (regardless of dates from other formulas).\n\n**flatten=N ARRAY Representation**\n```json\n[\n  {\n    \"requestId\": \"id\",\n    \"formula\": \"formulaName\",\n    \"result\": [a,b,c],\n    \"objectType\": \"ARRAY\",\n    \"dataType\": \"DOUBLE\"\n  }\n]\n```\n\n**flatten=Y ARRAY Representation**\n```json\n[\n  {\n    \"requestId\": \"id\",\n    \"formulaName\": a,\n  },\n  {\n    \"requestId\": \"id\",\n    \"formulaName\": b,\n  },\n  {\n    \"requestId\": \"id\",\n    \"formulaName\": c,\n  }\n]\n```\n\n\nScalar data items (SCALAR objectType in the standard **flatten=N** response model) will be repeated in each data object for the requestId.\n\n**flatten=N SCALAR Representation**\n```json\n[\n  {\n    \"requestId\": \"id\",\n    \"formula\": \"formulaName\",\n    \"result\": a,\n    \"objectType\": \"ARRAY\",\n    \"dataType\": \"DOUBLE\"\n  }\n]\n```\n\n**flatten=Y SCALAR Representation**\n```json\n[\n  {\n    \"requestId\": \"id\",\n    \"formulaName\": a,\n  }\n]\n```\n\n\nFormulas that result in a matrix (2 dimensional array, MATRIX objectType in the standard **flatten=N** response model) can be thought of as returning a table where each array in the array of arrays is a row in the table. This can be extended to the flattened result structure where each data object is a row in a table.  The formula will have as many attributes (appended by [n]) as number of columns in the matrix result.\n\n**flatten=N MATRIX Representation**\n```json\n[\n  {\n    \"requestId\": \"id\"\n    \"formula\": \"formulaName\",\n    \"result\": [\n        [a,b,c],\n        [d,e,f]\n      ],\n    \"objectType\": \"MATRIX\",\n    \"dataType\": \"DOUBLE\"\n  }\n]\n```\n\n**flatten=Y MATRIX Representation**\n```json\n[\n  {\n    \"requestId\": \"id\"\n    \"formulaName[0]\": a,\n    \"formulaName[1]\": b,\n    \"formulaName[2]\": c\n  },\n  {\n    \"requestId\": \"id\"\n    \"formulaName[0]\": d,\n    \"formulaName[1]\": e,\n    \"formulaName[2]\": f\n  }\n]\n```\n"
      type: object
      properties:
        requestId:
          description: Identifier requested.
          type: string
          example: IBM-US
        fsymId:
          description: 'The **fsymId** field returned is the FactSet Default Permanent Identifier for the `requestId`. For all supported `requestId` symbol types, the `fsymId` parameter will return the Regional Level PermId ''-R'' which identifies the security’s best regional security data series per currency. Currently, the fsymId parameter only supports equities. Accepted `requestId` symbol types include all FactSet Permanent Identifiers types, CUSIP, SEDOL, ISIN, and Tickers. Further documentation can be found at this [Online Assistant attachment](https://oa.apps.factset.com/cms/oaAttachment/64c3213a-f415-4c27-a336-92c73a72deed/24881). Included only if the `fsymId` parameter is set to Y.

            '
          type:
          - string
          - 'null'
          example: SJY281-R
        date:
          description: Date associated with FQL formula.
          type:
          - string
          - 'null'
          format: date
          example: '2021-10-18'
      additionalProperties:
        $ref: '#/components/schemas/time_series_result_object_flattened_addl'
      required:
      - requestId
    time_series_result_object_nonflattened_array:
      title: Time-Series Non-Flattened Response Object with ARRAY Result Attribute
      description: The `result` attribute in the Time-Series Non-Flattened Response Object will be an ARRAY.
      type: object
      properties:
        result:
          type: array
          items:
            $ref: '#/components/schemas/time_series_scalar_value'
      allOf:
      - $ref: '#/components/schemas/time_series_result_object_nonflattened_base'
    time_series_response:
      title: Time-Series Response
      type: object
      properties:
        data:
          description: Array of Time-Series `Response Objects`
          type: array
          items:
            $ref: '#/components/schemas/time_series_response_object_items'
    time_series_response_object_items:
      title: Time-Series Response Object
      anyOf:
      - $ref: '#/components/schemas/time_series_result_object_nonflattened'
      - $ref: '#/components/schemas/time_series_result_object_flattened'
    BatchStatusResponse:
      title: Batch Status Response
      type: object
      properties:
        data:
          $ref: '#/components/schemas/BatchStatus'
    time_series_result_object_nonflattened:
      title: Time-Series Non-Flattened Response Object
      oneOf:
      - $ref: '#/components/schemas/time_series_result_object_nonflattened_scalar'
      - $ref: '#/components/schemas/time_series_result_object_nonflattened_array'
      - $ref: '#/components/schemas/time_series_result_object_nonflattened_matrix'
      - $ref: '#/components/schemas/time_series_result_object_nonflattened_timeseries_object'
      discriminator:
        propertyName: objectType
        mapping:
          SCALAR: '#/components/schemas/time_series_result_object_nonflattened_scalar'
          ARRAY: '#/components/schemas/time_series_result_object_nonflattened_array'
          MATRIX: '#/components/schemas/time_series_result_object_nonflattened_matrix'
          TIMESERIES: '#/components/schemas/time_series_result_object_nonflattened_timeseries_object'
    time_series_result_object_nonflattened_matrix:
      title: Time-Series Non-Flattened Response Object with MATRIX Result Attribute
      description: The `result` attribute in the Time-Series Non-Flattened Response Object will be a MATRIX, which will be represented as an array of arrays. Each array can be thought of as a row in the matrix.
      type: object
      properties:
        result:
          type: array
          items:
            type: array
            items:
              $ref: '#/components/schemas/time_series_scalar_value'
      allOf:
      - $ref: '#/components/schemas/time_series_result_object_nonflattened_base'
    BatchStatus:
      title: Batch Status
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: the id of batch request.
        startTime:
          type:
          - string
          - 'null'
          format: date-time
          description: Time when the batch request is started. This is in Eastern Time Zone. The date-time format is expressed as [YYYY-MM-DD]T[HH:MM:SSS], following ISO 8601.
        endTime:
          type:
          - string
          - 'null'
          format: date-time
          description: Time when the batch request is ended. This is in Eastern Time Zone. The date-time format is expressed as [YYYY-MM-DD]T[HH:MM:SSS], following ISO 8601.
        status:
          type: string
          enum:
          - QUEUED
          - EXECUTING
          - DONE
          - FAILED
        error:
          type:
          - string
          - 'null'
          example: The parameter 'formulas' is required and may not be empty.
          description: Error message.
    time_series_request:
      title: Time-Series Request Body
      description: '`/time-series` Request Body'
      type: object
      properties:
        data:
          type: object
          properties:
            ids:
              title: ids
              description: 'Array of entity identifiers.


                The `ids` and `universe` parameters provide two different ways to specify the identifiers for which you want data retrieved. Please enter either the `ids` or `universe` parameter.

                '
              type: array
              items:
                type: string
              example:
              - FDS-US
              - IBM-US
              - XOM-US
            symbolType:
              title: symbolType
              type: string
              description: "Specify the type of symbols submitted in the `ids` parameter. This is only required when submitting ids that are not supported by default. \n\nAvailable symbol types -\n* DEFAULT - Accepted symbol types include Market Tickers, SEDOLs, ISINs, CUSIPs, or FactSet Permanent Ids.\n\n* BLOOMBERG - Accepted symbol types include Bloomberg Tickers and Bloomberg FIGIs. \n  * When submitting Bloomberg symbols, the Bloomberg symbol is translated to a FactSet Permanent Identifier which is then used to retrieve the requested FQL and Screening formulas. The Bloomberg symbol submitted will be returned in the response in the field *requestId*. To see the FactSet Permanent Identifer that the Bloomberg symbol resolved to, use the `fsymId` parameter in addition to the `\n  ` parameter.\n  * Bloomberg symbols can not be submitted with other symbol types. \n  * Bloomberg Symbol Resolution is not available via Batch Requests.\n\nBloomberg Symbol Resolution is included with the Individual User subscription. Users with a Production User subscription require additional access to submit Bloomberg symbols. If you would like to gain access to Bloomberg Symbol Resolution, please contact your FactSet Account Team or \"Report Issue\" above and our support teams can assist.\n"
            universe:
              title: universe
              description: 'Screening expression to limit the universe


                Please enter either the `ids` or `universe` parameter.

                '
              type: string
              example: FG_CONSTITUENTS(SP50,0,CLOSE)
            universeType:
              title: universeType
              description: 'Specify the universe type to calculate the `universe` in.


                Find documentation below on how to build a screen for each universe type -

                * Equity Screen - [Online Assistant Page 20606](https://my.apps.factset.com/oa/pages/20606)


                * Debt Screen - [Online Assistant Page 20888](https://my.apps.factset.com/oa/pages/20888)


                * Fund Screen - [Online Assistant Page 21384](https://my.apps.factset.com/oa/pages/21384)


                This parameter may only be used in conjunction with the `universe` parameter.

                '
              type: string
              example: DEBT
              default: EQUITY
              enum:
              - EQUITY
              - DEBT
              - FUND
            formulas:
              title: FQL formulas
              description: Array of FQL formulas
              type: array
              items:
                type: string
              example:
              - P_PRICE(0,-2,D)
              - FG_COMPANY_NAME
            calendar:
              title: Calendar Setting
              description: Calendar of data returned. The default value is FIVEDAY which displays Monday through Friday, regardless of whether there were trading holidays.
              type: string
              example: SEVENDAY
              default: FIVEDAY
            fsymId:
              title: fsymId
              description: 'Specify **Y** for the `fsymId` parameter to return the **fsymId** (FactSet Default Permanent Identifier) of the `requestId`, in addition to the **requestId** field, in each response object. The default value for the `fsymId` parameter is **N**.


                The **fsymId** field returned is the FactSet Default Permanent Identifier for the `requestId`. For all supported `requestId` symbol types, the `fsymId` parameter will return the Regional Level PermId ''-R'' which identifies the security’s best regional security data series per currency. Currently, the fsymId parameter only supports equities. Accepted `requestId` symbol types include all FactSet Permanent Identifiers types, CUSIP, SEDOL, ISIN, and Tickers. Further documentation can be found at this [Online Assistant attachment](https://oa.apps.factset.com/cms/oaAttachment/64c3213a-f415-4c27-a336-92c73a72deed/24881).

                '
              type: string
              example: Y
              default: N
              enum:
              - Y
              - N
            displayName:
              title: displayName
              description: 'Define display names for the formulas inputted. Enter the list of display names in the same order as the formulas inputted. An additional field **displayName** will be returned in the data object for a formula.


                If the number of display names does not match the number of formulas provided, an error will be returned.


                To define the display name for a subset of the formulas, leave a blank in the position of the formula that won''t be renamed. For example - If three formulas are inputted, to define display names only for the first and third formula, enter *displayName=FORMULA_1,,FORMULA_3*. The **displayName** field will still be included in that formula, but will contain the formula as inputted.

                '
              type: array
              items:
                type: string
              example:
              - PRICE
              - COMPANY_NAME
            flatten:
              title: flatten
              description: 'Specify **Y** for `flatten` to return a flat, table-like JSON response model instead of the standard nested JSON response model. This option is provided for easier data processing and visualization. The default value for `flatten` is **N**.


                See the **Time-Series Result Object Flattened** schema for more detail on the response structure for flattened output.

                '
              type: string
              example: Y
              default: N
              enum:
              - Y
              - N
            dates:
              title: dates
              description: 'Specify **N** for the `dates` parameter to suppress the **dates** of the response. The default value for the `dates` parameter is **Y**.


                In the non-flattened response model, setting dates to **N** will remove the "dates" array from the TIMESERIES objectType, meaning that the results will be returned as an ARRAY objectType.


                In the flattened response mode, setting dates to **N** will remove the "dates" attribute from the response objects. The flatten parameter first attempts to flatten the response by dates. Removing the dates can make it easier to align multiple data items when the date definition differs from the desired alignment.

                '
              type: string
              example: N
              default: Y
              enum:
              - Y
              - N
            batch:
              title: batch
              description: 'Enables the ability to asynchronously "batch" the request, supporting a long-running request up to **20 minutes**. Upon requesting "batch": "Y", the service will

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