Factset Get API

openapi: 3.0.3
info:
  title: Factset Analytics Datastore About Get 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: Get
paths:
  /debtInstrument/get:
    get:
      tags:
      - Get
      operationId: get/debtInstrument/get
      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: Factset Fundamental Data for a Debt Instrument.
      description: Fundamental data for a debt instrument; any other instrument yields empty values for debt-instrument-specific attributes. Dates are interpreted in the timezone of the issuer.
      parameters:
      - name: id
        in: query
        schema:
          type: string
          format: id64
          x-positive: true
          description: Identifier of the instrument.
        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/GetDebtInstrumentGet200Response'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /debtInstrument/keyFigures/notation/get:
    get:
      tags:
      - Get
      operationId: get/debtInstrument/keyFigures/notation/get
      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: Factset Key Figures of a Debt Instrument.
      description: Key figures of a debt instrument. The key figures are calculated using delayed prices with an additional delay of 10 minutes after an  update of the debt instrument's price. Special product features such as the right to a maturity extension, an attached option, or convertibility are not considered for the key figure calculation. Further, a calculation is not performed for perpetual products and for products with variable interest rate.
      parameters:
      - name: id
        in: query
        schema:
          type: string
          format: id64
          x-positive: true
          description: Identifier of a notation.
        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.
      responses:
        '200':
          $ref: '#/components/responses/GetDebtInstrumentKeyFiguresNotationGet200Response'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /debtInstrument/notation/screener/valueRanges/get:
    post:
      tags:
      - Get
      operationId: post/debtInstrument/notation/screener/valueRanges/get
      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: Factset Possible Values and Value Ranges for the Parameters Used in the Endpoint `/debtinstrument/notation/screener/search.`
      description: The endpoint returns the possible values and value ranges for the parameters used in the endpoint `/debtInstrument/notation/screener/search`. It allows to request the values and value ranges only for a restricted set of notations that match predefined parameters. The functionality may be used to pre-fill the values and value ranges of the parameters of the `/debtInstrument/notation/screener/search` endpoint so that performing a search always leads to a non-empty set of notations. If more than one notation of an instrument matches the parameters, and no market priority has been specified, only the notation with the highest trading volume, averaged over one month, is considered.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostDebtInstrumentNotationScreenerValueRangesGetRequest'
      responses:
        '200':
          $ref: '#/components/responses/PostDebtInstrumentNotationScreenerValueRangesGet200Response'
      parameters: []
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  responses:
    GetDebtInstrumentGet200Response:
      description: Successful Response
      content:
        application/json:
          schema:
            type: object
            properties:
              data:
                description: Fundamental data for a debt instrument.
                nullable: false
                type: object
                x-property-sort:
                - isin
                - nsin
                - name
                - shortName
                - type
                - lifeCycle
                - issuer
                - issue
                - tradingVolume
                - redemption
                - nominalValue
                - debtRanking
                - germany
                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.
                  lifeCycle:
                    nullable: false
                    type: object
                    x-property-sort:
                    - issue
                    - maturity
                    description: Important dates of the instrument.
                    properties:
                      issue:
                        nullable: true
                        type: string
                        format: date
                        description: Date of the issue.
                      maturity:
                        nullable: false
                        type: object
                        x-property-sort:
                        - date
                        - isPerpetual
                        - isCallable
                        description: Maturity data.
                        properties:
                          date:
                            nullable: true
                            type: string
                            format: date
                            description: Date of the instrument's maturity. The value is empty if the instrument is perpetual.
                          isPerpetual:
                            nullable: true
                            type: boolean
                            description: If true, the instrument is perpetual, i.e. it does not mature, therefore the attribute `date` is null.
                          isCallable:
                            nullable: true
                            type: boolean
                            description: If true, the issuer may redeem the instrument prior to maturity.
                  issuer:
                    nullable: false
                    type: object
                    x-property-sort:
                    - id
                    - name
                    - lei
                    description: Issuer of the instrument. See endpoint `/legalEntity/list` for possible values.
                    properties:
                      id:
                        nullable: true
                        type: string
                        format: id64
                        x-positive: true
                        description: Identifier of the issuer.
                      name:
                        nullable: true
                        type: string
                        description: Name of the issuer.
                      lei:
                        nullable: true
                        type: string
                        description: Legal Entity Identifier of the issuer.
                  issue:
                    nullable: false
                    type: object
                    x-property-sort:
                    - price
                    - volume
                    description: Issue data of the instrument.
                    properties:
                      price:
                        nullable: false
                        type: object
                        x-property-sort:
                        - value
                        - valueUnit
                        description: Issue price data.
                        properties:
                          value:
                            nullable: true
                            type: number
                            format: real
                            description: Issue price.
                          valueUnit:
                            nullable: false
                            type: object
                            x-property-sort:
                            - id
                            - code
                            description: Value unit of the issue price such as percentages for a debt instrument quoted in percent, or a main or a fractional currency for a per-unit-quoted debt instrument (rarely). See endpoint `/basic/valueUnit/list` for possible values.
                            properties:
                              id:
                                nullable: true
                                type: number
                                format: id32
                                x-positive: true
                                description: Identifier of the value unit.
                              code:
                                nullable: true
                                type: string
                                description: Code of the value unit.
                      volume:
                        nullable: false
                        type: object
                        x-property-sort:
                        - amount
                        - currency
                        description: Issue volume data.
                        properties:
                          amount:
                            nullable: true
                            type: number
                            format: real
                            description: Issue volume.
                          currency:
                            nullable: false
                            type: object
                            x-property-sort:
                            - id
                            - code
                            - isoCode
                            description: Main currency of denomination of the issue volume. 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.'
                              isoCode:
                                nullable: true
                                type: string
                                description: ISO 4217 code of the currency.
                  tradingVolume:
                    nullable: false
                    type: object
                    x-property-sort:
                    - minimum
                    - increment
                    description: Requirements regarding the trading volume in the over-the-counter (non-exchange-based) trading. For the currency of the trading volume, see attribute `issue.volume.currency`.
                    properties:
                      minimum:
                        nullable: true
                        type: number
                        format: real
                        description: Minimum trading volume.
                      increment:
                        nullable: true
                        type: number
                        format: real
                        description: Incremental trading volume over the minimum. The trading volume over the minimum must be an integral multiple of the increment.
                  redemption:
                    nullable: false
                    type: object
                    x-property-sort:
                    - price
                    - currency
                    description: Redemption data of the instrument.
                    properties:
                      price:
                        nullable: false
                        type: object
                        x-property-sort:
                        - value
                        - valueUnit
                        description: Redemption price data.
                        properties:
                          value:
                            nullable: true
                            type: number
                            format: real
                            description: Redemption price.
                          valueUnit:
                            nullable: false
                            type: object
                            x-property-sort:
                            - id
                            - code
                            description: Value unit of the redemption price such as percentages for a debt instrument quoted in percent, or a main or a fractional currency for a per-unit-quoted debt instrument (rarely). See endpoint `/basic/valueUnit/list` for possible values.
                            properties:
                              id:
                                nullable: true
                                type: number
                                format: id32
                                x-positive: true
                                description: Identifier of the value unit.
                              code:
                                nullable: true
                                type: string
                                description: Code of the value unit.
                      currency:
                        nullable: false
                        type: object
                        x-property-sort:
                        - id
                        - code
                        - isoCode
                        description: Main currency of the redemption. 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.'
                          isoCode:
                            nullable: true
                            type: string
                            description: ISO 4217 code of the currency.
                  nominalValue:
                    nullable: true
                    type: number
                    format: real
                    description: Nominal value for per-unit quoted debt instruments. Debt instruments quoted in percent do not have a nominal value per se.
                  debtRanking:
                    nullable: false
                    type: object
                    x-property-sort:
                    - id
                    - name
                    description: Ranking data of the debt instrument. It indicates how payments related to the debt instrument are ranked  compared to payments on the issuer's other obligations.
                    properties:
                      id:
                        nullable: true
                        type: number
                        format: id32
                        x-positive: true
                        description: Identifier of the debt ranking.
                      name:
                        nullable: true
                        type: string
                        format: localizedString
                        description: Name of the debt ranking.
                  germany:
                    nullable: false
                    type: object
                    x-property-sort:
                    - isTrusteeEligible
                    description: Specific data for Germany.
                    properties:
                      isTrusteeEligible:
                        nullable: true
                        type: boolean
                        description: If true, the debt instrument is eligible for investments by trustees according to §§1806ff of the BGB (German Civil Code). The German legislative has declared it to be virtually free of the risk of loss, such as government and state bonds. Eligible are primarily German securities.
              meta:
                type: object
                description: The meta member contains the meta information of the response.
                properties:
                  status:
                    $ref: '#/components/schemas/StatusObject'
                x-property-sort:
                - status
    GetDebtInstrumentKeyFiguresNotationGet200Response:
      description: Successful Response
      content:
        application/json:
          schema:
            type: object
            properties:
              data:
                nullable: false
                type: object
                x-property-sort:
                - calculation
                - yield
                - macaulayDuration
                - sensitivities
                description: Key figures and related data.
                properties:
                  calculation:
                    nullable: false
                    type: object
                    x-property-sort:
                    - time
                    - price
                    description: Details of the calculation.
                    properties:
                      time:
                        nullable: true
                        type: string
                        format: datetime
                        description: Date and time of the calculation.
                      price:
                        nullable: false
                        type: object
                        x-property-sort:
                        - value
                        - valueUnit
                        - dirtyPricing
                        description: Price used for the calculation.
                        properties:
                          value:
                            nullable: true
                            type: number
                            format: real
                            description: Price value.
                          valueUnit:
                            nullable: false
                            type: object
                            x-property-sort:
                            - id
                            - code
                            description: Value unit of the notation of the debt instrument, such as a main currency for a per-unit-quoted debt instrument (rarely), or percentages for a debt instrument quoted in percent. See endpoint `/basic/valueUnit/list` for possible values.
                            properties:
                              id:
                                nullable: true
                                type: number
                                format: id32
                                x-positive: true
                                description: Identifier of the value unit.
                              code:
                                nullable: true
                                type: string
                                description: Code of the value unit.
                          dirtyPricing:
                            nullable: true
                            type: boolean
                            description: If true, the attribute `price.value` contains the accrued interest.
                  yield:
                    nullable: false
                    type: object
                    x-property-sort:
                    - current
                    - toMaturity
                    - spread
                    description: Yield-related key figures.
                    properties:
                      current:
                        nullable: true
                        type: number
                        format: relativeValue
                        description: Current yield, which is the next annual interest payment divided by the price. If the coupon period is different than a year, the interest payment is annualized.
                      toMaturity:
                        nullable: true
                        type: number
                        format: relativeValue
                        description: Yield to maturity, which is the annual rate of return, assuming the instrument is held until maturity.
                      spread:
                        nullable: true
                        type: number
                        format: relativeValue
                        description: Credit spread, which is the difference in yield to maturity between a highest-quality debt instrument, also called a benchmark bond, and the debt instrument. See endpoint `/instrument/benchmark/list` for the benchmark bond.
                  macaulayDuration:
                    nullable: true
                    type: number
                    format: real
                    description: Macaulay duration, which is the average period (in years) of capital commitment.
                  sensitivities:
                    nullable: false
                    type: object
                    x-property-sort:
                    - basePointValue
                    - modifiedDuration
                    - elasticity
                    - convexity
                    description: Price sensitivities of the debt instrument with respect to the prevailing market interest rate.
                    properties:
                      basePointValue:
                        nullable: true
                        type: number
                        format: real
                        description: Base point value, which is the change of the debt instrument's price for a one base point change (nominally, not relatively) of the prevailing market interest rate. One base point is equivalent to 0,01 percent (1/100 of a percent). See attribute `price/valueUnit` for its value unit.
                      modifiedDuration:
                        nullable: true
                        type: number
                        format: relativeValue
                        description: Modified duration, which is the percentage change of the debt instrument's price for a one percent change (nominally, not relatively) of the prevailing market interest rate.
                      elasticity:
                        nullable: true
                        type: number
                        format: real
                        description: Yield elasticity, which is the ratio of the percentage change of the debt instrument's price for a one percent change (relatively, not nominally) of the prevailing market interest rate.
                      convexity:
                        nullable: true
                        type: number
                        format: real
                        description: Convexity, which is a measure for the change of the modified duration as the prevailing market interest rate changes.
              meta:
                type: object
                description: The meta member contains the meta information of the response.
                properties:
                  status:
                    $ref: '#/components/schemas/StatusObject'
                x-property-sort:
                - status
    PostDebtInstrumentNotationScreenerValueRangesGet200Response:
      description: Successful Response
      content:
        application/json:
          schema:
            type: object
            properties:
              data:
                description: Possible values and value ranges of the parameters.
                nullable: false
                type: object
                x-property-sort:
                - totalCount
                - valueUnit
                - market
                - categorization
                - lifeCycle
                - subordinated
                - ratingSystem1
                - ratingSystem2
                - issuer
                - issue
                - tradingVolume
                - compliance
                - coupon
                - yield
                - macaulayDuration
                - sensitivities
                - tradedValue
                properties:
                  totalCount:
                    nullable: true
                    type: number
                    format: int32
                    description: Number of notations that satisfy the request parameters, hence have been used to retrieve the possible values and value ranges.
                  valueUnit:
                    nullable: false
                    description: List of value unit identifiers. See endpoint `/basic/valueUnit/list` for possible values.
                    type: array
                    items:
                      type: object
                      nullable: false
                      x-property-sort:
                      - id
                      - code
                      - count
                      properties:
                        id:
                          nullable: true
                          description: Identifer of a value unit.
                          type: number
                          format: id32
                          x-positive: true
                        code:
                          nullable: true
                          description: 'Code of the value unit: If assigned, a code according to ISO 4217, otherwise a local code, for a main currency; a code such as GBp (for British pence) for a fractional currency; or a code such as PT (points) for non-currency value units.'
                          type: string
                        count:
                          nullable: true
                          description: Number of notations.
                          type: number
                          format: int32
                  market:
                    nullable: false
                    description: List of market identifiers. See endpoint `/basic/market/list` for possible values.
                    type: array
                    items:
                      type: object
                      nullable: false
                      x-property-sort:
                      - id
                      - name
                      - count
                      properties:
                        id:
                          nullable: true
                          description: Identifier of a market.
                          type: number
                          format: id32
                          x-positive: true
                        name:
                          nullable: true
                          description: Name of the market.
                          type: string
                          format: localizedString
                        count:
                          nullable: true
                          description: Number of notations.
                          type: number
                          format: int32
                  categorization:
                    nullable: false
                    description: Lists of categories of the debt instruments' categorization. Starting with the most coarse level (one), for each level of the category system, the list of categories of the debt instruments, matching the parameters, is returned. See endpoint `/categ

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