Factset Instruments API

openapi: 3.0.3
info:
  title: Factset Analytics Datastore About Instruments 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: Instruments
paths:
  /company/keyItems/current/getByInstrument:
    post:
      tags:
      - Instruments
      operationId: post/company/keyItems/current/getByInstrument
      x-supportsOffsetBasedPaging: false
      x-supportsOffsetBasedPagingWithoutTotal: false
      x-supportsCursorBasedPaging: false
      x-supportsCursorBasedPagingWithoutTotal: false
      x-supportsPush: false
      x-requiresUser: false
      x-requiresInternalClient: false
      x-disallowUser: false
      x-no-merge: false
      x-maxSortParameterCount: 10
      x-supportsPermissionDeniedResponse: false
      summary: Fundamentals for a stock with potentially daily updates.
      description: Fundamentals for a stock with potentially daily updates; any other instrument yields empty values for stock-specific attributes. The price used to calculate the various price-dependent figures is unspecified and the exchange for that price is not identified. Dates are interpreted in the timezone of the data provider. For reported company fundamentals of the previous fiscal years (only closed fiscal years) see endpoint `/company/keyItems/fiscalYear/listByInstrument.`
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostCompanyKeyItemsCurrentGetByInstrumentRequest'
      responses:
        '200':
          $ref: '#/components/responses/PostCompanyKeyItemsCurrentGetByInstrument200Response'
      parameters: []
  /company/keyItems/fiscalYear/listByInstrument:
    post:
      tags:
      - Instruments
      operationId: post/company/keyItems/fiscalYear/listByInstrument
      x-supportsOffsetBasedPaging: false
      x-supportsOffsetBasedPagingWithoutTotal: false
      x-supportsCursorBasedPaging: false
      x-supportsCursorBasedPagingWithoutTotal: false
      x-supportsPush: false
      x-requiresUser: false
      x-requiresInternalClient: false
      x-disallowUser: false
      x-no-merge: false
      x-maxSortParameterCount: 10
      x-supportsPermissionDeniedResponse: false
      summary: Selected fundamentals for a stock with values as of the end of a fiscal year.
      description: Selected fundamentals for a stock with values as of the end of a fiscal year; any other instrument yields empty values for stock-specific attributes. The endpoint allows the retrieval of data only for specified fiscal years by using the start and end properties. Since a fiscal year and a calendar year do not necessarily match with regard to their start and end dates, the year is derived as the calendar year occupied to a larger extent by the fiscal year, using a June through May fiscal year assignment. That means, fiscal years ending from the 1st of June onwards are assigned to the same calendar year. Dates are interpreted in the timezone of the location of the head office of the company.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostCompanyKeyItemsFiscalYearListByInstrumentRequest'
      responses:
        '200':
          $ref: '#/components/responses/PostCompanyKeyItemsFiscalYearListByInstrument200Response'
      parameters: []
  /company/estimates/listByInstrument:
    post:
      tags:
      - Instruments
      operationId: post/company/estimates/listByInstrument
      x-supportsOffsetBasedPaging: false
      x-supportsOffsetBasedPagingWithoutTotal: false
      x-supportsCursorBasedPaging: false
      x-supportsCursorBasedPagingWithoutTotal: false
      x-supportsPush: false
      x-requiresUser: false
      x-requiresInternalClient: false
      x-disallowUser: false
      x-no-merge: false
      x-maxSortParameterCount: 10
      x-supportsPermissionDeniedResponse: false
      description: Fiscal year estimates for selected figures of a stock. Data is available only for common shares; instruments such as preferred shares or depository receipts yield an empty result. For the share type, see endpoint `/instrument/category/list` using dataset 23. Data can be retrieved only for the current, the past, and three future fiscal years. For past fiscal years, the estimates are not being replaced by the reported figures. Since a fiscal year and a calendar year do not necessarily match with regard to their start and end dates, the year is derived as the calendar year occupied to a larger extent by the fiscal year, using a June through May fiscal year assignment. That means, fiscal years ending from the 1st of June onwards are assigned to the same calendar year. Dates are interpreted in the timezone of the location of the head office of the company.
      summary: Estimates for selected figures for a stock.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostCompanyEstimatesListByInstrumentRequest'
      responses:
        '200':
          $ref: '#/components/responses/PostCompanyEstimatesListByInstrument200Response'
      parameters: []
  /company/board/listByInstrument:
    get:
      tags:
      - Instruments
      operationId: get/company/board/listByInstrument
      x-supportsOffsetBasedPaging: false
      x-supportsOffsetBasedPagingWithoutTotal: false
      x-supportsCursorBasedPaging: false
      x-supportsCursorBasedPagingWithoutTotal: false
      x-supportsPush: false
      x-requiresUser: false
      x-requiresInternalClient: false
      x-disallowUser: false
      x-no-merge: false
      x-maxSortParameterCount: 10
      x-supportsPermissionDeniedResponse: false
      summary: List of boards for a company, with their officers.
      description: List of boards for a company, with their officers. A given person may be a member ofdifferent boards of the same company but also a member of boards of different companies.
      parameters:
      - name: id
        in: query
        schema:
          type: string
          format: id64
          x-positive: true
          description: Identifier of the instrument representing company shares.Any other instrument yields empty values.
        required: true
      - name: _attributes
        in: query
        schema:
          type: array
          items:
            type: string
            maxLength: 100
            exclusiveMaximum: false
          uniqueItems: true
          maxItems: 50
        style: form
        explode: false
        description: Limit the attributes returned in the response to the specified set.
      - name: _language
        in: query
        schema:
          type: string
          format: isoLanguage
          description: ISO 639-1 code of the language.
          maxLength: 2
          minLength: 2
          exclusiveMinimum: false
          exclusiveMaximum: false
      responses:
        '200':
          $ref: '#/components/responses/GetCompanyBoardListByInstrument200Response'
components:
  schemas:
    AttributesMember:
      type: array
      description: Limit the attributes returned in the response to the specified set.
      items:
        type: string
        maxLength: 100
        exclusiveMaximum: false
      maxItems: 50
      uniqueItems: true
    PostCompanyEstimatesListByInstrumentRequest:
      type: object
      properties:
        data:
          type: object
          x-property-sort:
          - id
          - fiscalYears
          - currency
          description: The data member contains the request's primary data.
          properties:
            id:
              type: string
              format: id64
              x-positive: true
              description: Identifier of the instrument
            fiscalYears:
              type: object
              x-property-sort:
              - start
              - end
              description: The response includes data items from the fiscal year specified as start (inclusive) up to the fiscal year specified as end (inclusive). The attribute `start` must be less than or equal to the attribute `end`.
              properties:
                start:
                  type: number
                  format: int32
                  description: Only include data items for a fiscal year greater than or equal to the one specified. Must be greater than or equal to one year in the past. If omitted, the response includes data from one year in the past up to the year specified as `end`.
                end:
                  type: number
                  format: int32
                  description: Only include data items for a fiscal year earlier than or equal to the one specified. Must be less than or equal to three years in the future. If omitted, the response includes data from the year specified as `start` up to three years in the future.
            currency:
              type: object
              x-property-sort:
              - isoCode
              description: Main currency into which the estimated figures representing a monetary value are converted.
              properties:
                isoCode:
                  type: string
                  description: ISO 4217 code of the currency.
                  x-enum-description:
                  - Euro
                  - US Dollar
                  - British Pound Sterling
                  - Swiss Franc
                  enum:
                  - EUR
                  - USD
                  - GBP
                  - CHF
              required:
              - isoCode
          required:
          - id
          - currency
        meta:
          type: object
          description: The meta member contains the meta information of the request.
          properties:
            attributes:
              $ref: '#/components/schemas/AttributesMember'
          x-property-sort:
          - attributes
    PostCompanyKeyItemsCurrentGetByInstrumentRequest:
      type: object
      properties:
        data:
          type: object
          x-property-sort:
          - id
          - currency
          description: The data member contains the request's primary data.
          properties:
            id:
              type: string
              format: id64
              x-positive: true
              description: Identifier of an instrument.
            currency:
              type: object
              x-property-sort:
              - isoCode
              description: Main currency of the currency-dependent attributes.
              properties:
                isoCode:
                  type: string
                  description: ISO code of the currency.
                  x-enum-description:
                  - Euro
                  - US Dollar
                  - British Pound Sterling
                  - Swiss Franc
                  enum:
                  - EUR
                  - USD
                  - GBP
                  - CHF
              required:
              - isoCode
          required:
          - id
          - currency
        meta:
          type: object
          description: The meta member contains the meta information of the request.
          properties:
            attributes:
              $ref: '#/components/schemas/AttributesMember'
            language:
              $ref: '#/components/schemas/LanguageMember'
          x-property-sort:
          - attributes
          - language
    LanguageMember:
      type: string
      format: isoLanguage
      description: ISO 639-1 code of the language.
      maxLength: 2
      minLength: 2
      exclusiveMinimum: false
      exclusiveMaximum: false
    PostCompanyKeyItemsFiscalYearListByInstrumentRequest:
      type: object
      properties:
        data:
          type: object
          x-property-sort:
          - id
          - fiscalYears
          - currency
          description: The data member contains the request's primary data.
          properties:
            id:
              type: string
              format: id64
              x-positive: true
              description: Identifier of the instrument.
            fiscalYears:
              type: object
              x-property-sort:
              - start
              - end
              description: Response will include data items from the fiscal year specified as start (inclusive) up to the fiscal year specified as end (inclusive). If either is omitted the response will include data items from the earliest or up to the most recent fiscal year available respectively. Alternatively, if both are specified start must be less than end. Either must be at most ten years in the past. Note that earliest data availability varies for each stock.
              properties:
                start:
                  type: number
                  format: int32
                  description: Only include data items for a fiscal year greater than or equal to the one specified. Must be greater than or equal to ten years in the past.
                end:
                  type: number
                  format: int32
                  description: Only include data items for a fiscal year earlier than or equal to the one specified. Must be less than or equal to the current year.
            currency:
              type: object
              x-property-sort:
              - isoCode
              description: Currency in which the attributes representing a monetary value are returned. If none is selected, the reporting currency of the company is used.
              properties:
                isoCode:
                  type: string
                  description: ISO code of the currency.
                  x-enum-description:
                  - Euro
                  - US Dollar
                  - British Pound Sterling
                  - Swiss Franc
                  enum:
                  - EUR
                  - USD
                  - GBP
                  - CHF
          required:
          - id
        meta:
          type: object
          description: The meta member contains the meta information of the request.
          properties:
            attributes:
              $ref: '#/components/schemas/AttributesMember'
            language:
              $ref: '#/components/schemas/LanguageMember'
          x-property-sort:
          - attributes
          - language
    StatusObject:
      type: object
      properties:
        code:
          type: number
          format: int32
          description: The HTTP status code of the response, mirroring the code from the Status-Line of the HTTP response message (see [RFC2616] section 6.1).
      description: The status member contains the status code of the response.
      required:
      - code
  responses:
    PostCompanyKeyItemsFiscalYearListByInstrument200Response:
      description: Successful Response
      content:
        application/json:
          schema:
            type: object
            properties:
              data:
                description: Selected fundamentals for a stock with values as of the end of a fiscal year.
                nullable: false
                type: object
                x-property-sort:
                - isin
                - nsin
                - name
                - shortName
                - type
                - company
                - fiscalYearData
                properties:
                  isin:
                    nullable: true
                    type: string
                    format: isin
                    description: The International Securities Identification Number (ISIN) of the instrument. The ISIN is a 12-character code of digits and upper-case letters that uniquely identifies an instrument.
                  nsin:
                    nullable: false
                    type: object
                    x-property-sort:
                    - wkn
                    - valor
                    description: NSIN data of the instrument.
                    properties:
                      wkn:
                        nullable: true
                        type: string
                        description: The WKN (Wertpapierkennnummer, German for Securities Identification Number) of the instrument. The WKN is a 6-character code of digits and upper-case letters that uniquely identifies an instrument.
                      valor:
                        nullable: true
                        type: string
                        description: 'The Valor number (German: Valorennummer) of the instrument. The Valor number is an integer number that uniquely identifies an instrument.'
                  name:
                    nullable: true
                    type: string
                    format: localizedString
                    description: Name of the instrument.
                  shortName:
                    nullable: true
                    type: string
                    format: localizedString
                    description: Short name of the instrument.
                  type:
                    nullable: false
                    description: Instrument type as defined by FactSet Digital Solutions. Instrument types are arranged in a hierarchy, with the first level representing the most coarse granularity and further levels successively refining the granularity (see MDG category system 18). See endpoint `/category/get` for possible values.
                    type: array
                    items:
                      type: object
                      nullable: false
                      x-property-sort:
                      - id
                      - name
                      properties:
                        id:
                          nullable: true
                          type: number
                          format: id32
                          x-positive: true
                          description: Identifier of the instrument type.
                        name:
                          nullable: true
                          type: string
                          format: localizedString
                          description: Name of the instrument type.
                  company:
                    nullable: false
                    type: object
                    x-property-sort:
                    - id
                    - name
                    - country
                    description: Details of the company.
                    properties:
                      id:
                        nullable: true
                        type: number
                        format: id32
                        x-positive: true
                        description: Identifier of the company.
                      name:
                        nullable: true
                        type: string
                        description: Name of the company.
                      country:
                        nullable: false
                        type: object
                        x-property-sort:
                        - id
                        - name
                        description: Country where the head office of the company is located. See endpoint `/basic/region/country/list` for possible values.
                        properties:
                          id:
                            nullable: true
                            type: number
                            format: id32
                            x-positive: true
                            description: Identifier of the country.
                          name:
                            nullable: true
                            type: string
                            format: localizedString
                            description: Name of the country.
                  fiscalYearData:
                    nullable: false
                    description: Values as of the end of a fiscal year for the set of selected figures. The figures are clustered based on their specifics but do not exhaust all potentially available data from that cluster. The default sorting is from the most recent fiscal year requested to the most distant in time.
                    type: array
                    items:
                      type: object
                      nullable: false
                      x-property-sort:
                      - fiscalYear
                      - currency
                      - price
                      - freeFloat
                      - sharesOutstanding
                      - marketCapitalization
                      - incomeStatement
                      - balanceSheet
                      - cashFlow
                      - ratios
                      - perShare
                      properties:
                        fiscalYear:
                          nullable: false
                          type: object
                          x-property-sort:
                          - start
                          - end
                          - year
                          description: Details of a fiscal year.
                          properties:
                            start:
                              nullable: true
                              type: string
                              format: date
                              description: Starting date of the fiscal year.
                            end:
                              nullable: true
                              type: string
                              format: date
                              description: Ending date of the fiscal year. All data items as of the end of a fiscal year correspond to this date.
                            year:
                              nullable: true
                              type: number
                              format: int32
                              description: Fiscal year.
                        currency:
                          nullable: false
                          type: object
                          x-property-sort:
                          - id
                          - code
                          description: Currency of the attributes representing a monetary value. See endpoint `/basic/valueUnit/currency/main/list` for possible values.
                          properties:
                            id:
                              nullable: true
                              type: number
                              format: id32
                              x-positive: true
                              description: Identifier of the currency.
                            code:
                              nullable: true
                              type: string
                              description: 'Code of the currency: if assigned, a code according to ISO 4217, otherwise a local code.'
                        price:
                          nullable: true
                          type: number
                          format: real
                          description: End-of-day price as of the end of the fiscal year. It is used for calculation of all price-related data items corresponding to the end of the fiscal year.
                        freeFloat:
                          nullable: true
                          type: number
                          format: real
                          description: Free float, which is the number of shares outstanding available for trading to the public. Closely-held shares (e.g. held by a majority investor) and temporarily restricted shares (e.g. due to insider lock-up periods) are not part of the free float.
                        sharesOutstanding:
                          nullable: false
                          type: object
                          x-property-sort:
                          - reported
                          - average
                          description: Shares outstanding, which is the number of shares not in possession by the company itself (treasury shares) thus generally available for trading.
                          properties:
                            reported:
                              nullable: true
                              type: number
                              format: real
                              description: Number of shares outstanding as reported by the company. This represents the basic (actual) shares outstanding.
                            average:
                              nullable: false
                              type: object
                              x-property-sort:
                              - basic
                              - diluted
                              properties:
                                basic:
                                  nullable: true
                                  type: number
                                  format: real
                                  description: Twelve-month average of the basic shares outstanding, which is the fiscal-year average of the actual number of shares outstanding.
                                diluted:
                                  nullable: true
                                  type: number
                                  format: real
                                  description: Twelve-month average of the diluted shares outstanding, which is the fiscal-year average of the potential number of shares outstanding, if all convertible instruments, such as convertible bonds or employee stock options, were exercised.
                        marketCapitalization:
                          nullable: true
                          type: number
                          format: real
                          description: Market capitalization, which is the market value of the shares outstanding over all types of shares of the company.
                        incomeStatement:
                          nullable: false
                          type: object
                          x-property-sort:
                          - sales
                          - grossIncome
                          - ebit
                          - ebitda
                          - interestIncome
                          - interestExpense
                          - loanLossProvision
                          - netInterestIncome
                          - netIncome
                          - operatingIncome
                          - operatingExpense
                          - claimLossExpense
                          - longTermInsuranceReserves
                          description: Income statement data.
                          properties:
                            sales:
                              nullable: false
                              type: object
                              x-property-sort:
                              - value
                              - growth
                              description: Total amount of sales revenue received for the normal operation of the business.
                              properties:
                                value:
                                  nullable: true
                                  type: number
                                  format: real
                                  description: Value of the total sales revenue.
                                growth:
                                  nullable: true
                                  type: number
                                  format: relativeValue
                                  description: Annual growth rate of the total amount of sales revenue.
                            grossIncome:
                              nullable: false
                              type: object
                              x-property-sort:
                              - value
                              - growth
                              - margin
                              description: Gross income, which is the profit before extraordinary items and preferred and common dividends, but after operating and non-operating income and expenses, reserves, income taxes, minority interest and equity in earnings. Discontinued operations are included only if they result from a purely operating gain or loss on the discontinued business segment.
                              properties:
                                value:
                                  nullable: true
                                  type: number
                                  format: real
                                  description: Value of the gross income.
                                growth:
                                  nullable: true
                                  type: number
                                  format: relativeValue
                                  description: Annual growth rate of the gross income.
                                margin:
                                  nullable: true
                                  type: number
                                  format: relativeValue
                                  description: Gross income margin, which is the ratio of the gross income, divided by the total sales revenue.
                            ebit:
                              nullable: false
                              type: object
                              x-property-sort:
                              - value
                              - growth
                              - margin
                              description: EBIT (earnings before interest and taxes).
                              properties:
                                value:
                                  nullable: true
                                  type: number
                                  format: real
                                  description: Value of the EBIT.
                                growth:
                                  nullable: true
                                  type: number
                                  format: relativeValue
                                  description: Annual growth rate of the EBIT.
                                margin:
                                  nullable: true
                                  type: number
                                  format: relativeValue
                                  description: EBIT margin, which is the ratio of the EBIT, divided by the total sales revenue.
                            ebitda:
                              nullable: false
                              type: object
                              x-property-sort:
                              - value
                              - growth
                              - margin
                              description: EBITDA (earnings before interest, taxes, depreciation, and amortization).
                              properties:
                                value:
                                  nullable: true
                                  type: number
                                  format: real
                                  description: Value of the EBITDA.
                                growth:
                                  nullable: true
                                  type: number
                                  format: relativeValue
                                  description: Annual growth rate of the EBITDA.
                                margin:
                                  nullable: true
                                  type: number
                                  format: relativeValue
                                  description: EBITDA margin, which is the ratio of the EBITDA, divided by the total sales revenue.
                            interestIncome:
                              nullable: false
                              type: object
                              x-property-sort:
                              - value
                              - growth
                              description: Total interest income, which is the income received from all earning assets such as loans and investment securities. Relevant for financial companies.
                              properties:


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