FactSet Bonds API for Digital Portals

openapi: 3.0.0
info:
  title: FactSet Bonds API for Digital Portals
  description: |-
    Search for fixed income instruments, using a criteria-based screener. The
    API provides also fundamental data and key figures.
  version: '2'
servers:
- url: https://api.factset.com/wealth/v1
paths:
  /debtInstrument/get:
    get:
      tags:
      - Debt
      - Get
      - Instrument
      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/issuer/search:
    post:
      tags:
      - Debt
      - Instrument
      - Issuer
      - Search
      operationId: post/debtInstrument/issuer/search
      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 Search for Issuers of Debt Instruments.
      description: >-
        Search for issuers of debt instruments. FactSet does not consolidate the
        data provided by different suppliers, therefore the result may contain
        more than one identifier for a given issuer. The response is limited to
        100 results.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostDebtInstrumentIssuerSearchRequest'
      responses:
        '200':
          $ref: '#/components/responses/PostDebtInstrumentIssuerSearch200Response'
      parameters: []
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /debtInstrument/keyFigures/notation/get:
    get:
      tags:
      - Debt
      - Figures
      - Get
      - Instrument
      - Key
      - Notation
      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/search:
    post:
      tags:
      - Debt
      - Instrument
      - Notation
      - Screener
      - Search
      operationId: post/debtInstrument/notation/screener/search
      x-supportsOffsetBasedPaging: true
      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 Screener for Debt Instruments' Notations Based on Debt Instrument-specific Parameters.
      description: >-
        Screener for debt instruments' notations based on debt
        instrument-specific parameters. The result is limited to the notations
        that satisfy all the selected filters. 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/PostDebtInstrumentNotationScreenerSearchRequest
      responses:
        '200':
          $ref: >-
            #/components/responses/PostDebtInstrumentNotationScreenerSearch200Response
      parameters: []
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /debtInstrument/notation/screener/valueRanges/get:
    post:
      tags:
      - Debt
      - Get
      - Instrument
      - Notation
      - Ranges
      - Screener
      - Value
      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:
  schemas:
    ErrorMetaObject:
      type: object
      properties:
        status:
          $ref: '#/components/schemas/StatusObject'
    ErrorObject:
      type: array
      description: >-
        The errors member contains additional information about a failed
        request.
      items:
        type: object
        properties:
          details:
            type: string
            description: >-
              A human-readable, unstructured explanation specific to this
              occurrence of the failure.
          encryptedDetails:
            type: string
            description: >-
              Base64-encoded, internal details about the error, in addition to
              "details".
          type:
            type: number
            format: int32
            description: Internal error type of the Foundation API protocol.
          attribute:
            type: array
            description: >-
              For a validation error, a reference to the request parameter that
              failed validation; otherwise, an empty array.
            items:
              type: object
              properties:
                name:
                  type: string
                  description: Element of the path denoting the request parameter.
                index:
                  type: number
                  format: int32
                  description: >-
                    If the attribute "name" designates an array, index of the
                    array element; otherwise the special value -1.
              x-property-sort:
              - name
              - index
        x-property-sort:
        - detail
        - encryptedDetails
        - type
        - attribute
    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
    LanguageMember:
      type: string
      format: isoLanguage
      description: ISO 639-1 code of the language.
      maxLength: 2
      minLength: 2
      exclusiveMinimum: false
      exclusiveMaximum: false
    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).
          example: 42.5
      description: The status member contains the status code of the response.
      required:
      - code
    CursorBasedPaginationOutputObject:
      type: object
      description: Pagination attributes for the cursor-based pagination strategy.
      properties:
        total:
          type: number
          format: int32
          description: Total number of entries in the result set.
          example: 42.5
        isEstimatedTotal:
          type: boolean
          description: Flag indicating that the value of `total` is estimated.
          example: true
        next:
          type: string
          description: >-
            The next cursor position to use in the parameter `pagination.cursor`
            for an endpoint that supports cursor-based pagination, otherwise
            `null`.
          example: example_value
        previous:
          type: string
          description: >-
            The previous cursor position to use in the parameter
            `pagination.cursor` for an endpoint that supports cursor-based
            pagination. If a previous cursor position is not supported or
            available, `previous` is `null`.
          example: example_value
      required:
      - total
      - isEstimatedTotal
      - next
      - previous
      x-property-sort:
      - total
      - isEstimatedTotal
      - next
      - previous
    CursorBasedPaginationOutputObjectWithoutTotal:
      type: object
      description: >-
        Pagination attributes for the cursor-based pagination strategy; a total
        element count is not supported.
      properties:
        next:
          type: string
          description: >-
            The next cursor position to use in the parameter `pagination.cursor`
            for an endpoint that supports cursor-based pagination, otherwise
            `null`.
          example: example_value
        previous:
          type: string
          description: >-
            The previous cursor position to use in the parameter
            `pagination.cursor` for an endpoint that supports cursor-based
            pagination. If a previous cursor position is not supported or
            available, `previous` is `null`.
          example: example_value
      required:
      - next
      - previous
      x-property-sort:
      - next
      - previous
    OffsetBasedPaginationOutputObject:
      type: object
      description: Pagination attributes for the offset-based pagination strategy.
      properties:
        total:
          type: number
          format: int32
          description: Total number of entries in the result set.
          example: 42.5
        isEstimatedTotal:
          type: boolean
          description: Flag indicating that the value of "total" is estimated.
          example: true
      required:
      - total
      - isEstimatedTotal
      x-property-sort:
      - total
      - isEstimatedTotal
    OffsetBasedPaginationOutputObjectWithoutTotal:
      type: object
      description: >-
        Pagination attributes for the offset-based pagination strategy; a total
        element count is not supported.
      properties:
        hasNext:
          type: boolean
          description: >-
            Flag indicating that a subsequent request with the same parameters,
            except that the parameter `pagination.offset` is incremented by
            `pagination.limit`, would yield additional results.
          example: true
      required:
      - hasNext
      x-property-sort:
      - hasNext
    PartialOutputObject:
      type: object
      properties:
        isPartial:
          type: boolean
          description: >-
            Flag indicating that the response is a possibly incomplete array or
            an object containing a possibly incomplete array, due to hitting a
            processing time limit. If `true`, some matching results might be
            missing from the array, or elements for matching results might be
            incorrectly included (for example, when priority sorting would have
            removed the element). Depending on the use case, such a response may
            be unsuitable.
          example: true
      description: Object denoting that the endpoint response is possibly incomplete.
      required:
      - isPartial
      x-property-sort:
      - isPartial
    PostDebtInstrumentIssuerSearchRequest:
      type: object
      properties:
        data:
          type: object
          x-property-sort:
          - name
          - minimumRatingGrade
          - country
          - market
          description: The data member contains the request's primary data.
          properties:
            name:
              type: object
              x-property-sort:
              - searchValue
              description: Issuer name.
              properties:
                searchValue:
                  type: string
                  pattern: ^[ -!#-&(-+--/0-:=?-Za-zw"]*$
                  minLength: 3
                  exclusiveMinimum: false
                  maxLength: 100
                  exclusiveMaximum: false
                  description: Text string to be searched for.
            minimumRatingGrade:
              type: object
              x-property-sort:
              - debtInstrument
              description: >-
                Minimum rating grade requirements for the issuers or their debt
                instruments. In either case, only one identifier per rating
                system is allowed. See endpoint `/rating/grade/listBySystem` for
                valid values.
              properties:
                debtInstrument:
                  type: object
                  x-property-sort:
                  - ids
                  description: >-
                    Debt instrument rating. Only issuers whose debt instruments
                    are rated higher than or equal to the rating grades in the
                    provided list are returned.
                  properties:
                    ids:
                      type: array
                      nullable: false
                      items:
                        type: number
                        format: id32
                        x-positive: true
                      maxItems: 5
                      uniqueItems: true
                      description: List of rating grade identifiers.
            country:
              type: object
              x-property-sort:
              - ids
              description: >-
                List of countries of registration of the issuers. Only issuers
                that are registered in a country in the provided list are
                returned.
              properties:
                ids:
                  type: array
                  nullable: false
                  items:
                    type: number
                    format: id32
                    x-positive: true
                  maxItems: 20
                  uniqueItems: true
                  description: >-
                    List of country identifiers. See endpoint
                    `/basic/region/country/list` for valid values.
            market:
              type: object
              x-property-sort:
              - ids
              description: >-
                List of markets where debt instruments are traded. Only issuers
                that have issued at least one debt instrument traded on a market
                in the provided list are returned.
              properties:
                ids:
                  type: array
                  nullable: false
                  items:
                    type: number
                    format: id32
                    x-positive: true
                  maxItems: 20
                  uniqueItems: true
                  description: >-
                    List of market identifiers. See endpoint
                    `/basic/market/list` for valid values.
          example: example_value
        meta:
          type: object
          description: The meta member contains the meta information of the request.
          properties:
            attributes:
              $ref: '#/components/schemas/AttributesMember'
          x-property-sort:
          - attributes
          example: example_value
    PostDebtInstrumentNotationScreenerSearchRequest:
      type: object
      properties:
        data:
          type: object
          x-property-sort:
          - validation
          - lifeCycle
          - subordinated
          - rating
          - issuer
          - issue
          - tradingVolume
          - compliance
          - coupon
          - yield
          - macaulayDuration
          - sensitivities
          - tradedValue
          description: The data member contains the request's primary data.
          properties:
            validation:
              description: Validation parameters.
              type: object
              x-property-sort:
              - onlyActive
              - onlyNotSuspended
              - prices
              - valueUnit
              - market
              - instrumentSelectionList
              - notationSelectionList
              - categorization
              properties:
                onlyActive:
                  description: >-
                    If `true`, only active notations will be returned. The term
                    "active" reflects the fact that notations and related data
                    is not being deleted immediately after becoming irrelevant
                    (e.g. because the source does not provide a price anymore),
                    but remains in general retrievable for up to 6 months.
                  type: boolean
                  default: true
                onlyNotSuspended:
                  description: >-
                    If `true`, only notations not suspended from trading will be
                    returned.
                  type: boolean
                  default: false
                prices:
                  description: Price-related parameters.
                  type: object
                  x-property-sort:
                  - quality
                  - latest
                  - previous
                  properties:
                    quality:
                      type: string
                      description: Quality of the price.
                      default: DLY
                      x-enum-description:
                      - >-
                        Delayed: intraday prices with an exchange-imposed
                        delay of usually 15 to 30 minutes.
                      - >-
                        End-of-day: prices updated once per day after the
                        close of trading, possibly with an exchange-imposed
                        delay of several hours or days.
                      enum:
                      - DLY
                      - EOD
                    latest:
                      description: >-
                        Parameters related to the presence and age of the most
                        recent trade price.
                      type: object
                      x-property-sort:
                      - availableOnly
                      - minimumDate
                      properties:
                        availableOnly:
                          description: >-
                            If `true`, only notations for which a trade price
                            (even an outdated one) is available will be
                            returned.
                          type: boolean
                        minimumDate:
                          description: >-
                            Earliest admissible date of the most recent trade
                            price.
                          type: string
                          format: date
                    previous:
                      description: >-
                        Parameters related to the presence and age of a trade
                        price from a preceding trading day.
                      type: object
                      x-property-sort:
                      - availableOnly
                      - minimumDate
                      properties:
                        availableOnly:
                          description: >-
                            If `true`, only notations for which a trade price
                            from a preceding trading day is available will be
                            returned.
                          type: boolean
                        minimumDate:
                          description: >-
                            Earliest admissible date of the trade price from a
                            preceding trading day.
                          type: string
                          format: date
                valueUnit:
                  description: >-
                    Value unit selection. See endpoint `/basic/valueUnit/list`
                    for valid values.
                  type: object
                  x-property-sort:
                  - restrict
                  - exclude
                  x-atMostOne: true
                  properties:
                    restrict:
                      description: Specifies the value units a notation may have.
                      type: object
                      x-property-sort:
                      - ids
                      properties:
                        ids:
                          description: Set of value unit identifiers.
                          type: array
                          nullable: false
                          items:
                            type: number
                            format: id32
                            x-positive: true
                          uniqueItems: true
                          maxItems: 50
                    exclude:
                      description: Specifies the value units a notation may not have.
                      type: object
                      x-property-sort:
                      - ids
                      properties:
                        ids:
                          description: Set of value unit identifiers.
                          type: array
                          nullable: false
                          items:
                            type: number
                            format: id32
                            x-positive: true
                          uniqueItems: true
                          maxItems: 50
                market:
                  description: >-
                    Market-related notation selection. See endpoint
                    `/basic/market/list` for valid values.
                  type: object
                  x-property-sort:
                  - selection
                  - priority
                  properties:
                    selection:
                      description: Market selection.
                      type: object
                      x-property-sort:
                      - restrict
                      - exclude
                      x-atMostOne: true
                      properties:
                        restrict:
                          description: >-
                            Specifies the markets from which a notation may
                            originate.
                          type: object
                          x-property-sort:
                          - ids
                          properties:
                            ids:
                              description: Set of market identifiers.
                              type: array
                              nullable: false
                              items:
                                type: number
                                format: id32
                                x-positive: true
                              uniqueItems: true
                              maxItems: 100
                        exclude:
                          description: >-
                            Specifies the markets from which a notation may not
                            originate.
                          type: object
                          x-property-sort:
                          - ids
                          properties:
                            ids:
                              description: Set of market identifiers.
                              type: array
                              nullable: false
                              items:
                                type: number
                                format: id32
                                x-positive: true
                              uniqueItems: true
                              maxItems: 100
                    priority:
                      description: >-
                        Sequence of markets specifying the priority order of the
                        markets for the selection of one notation per
                        instrument. If for a given instrument with two matching
                        notations, A and B, the market of notation A precedes
                        the market of notation B in this list or if the market
                        of notation B is not in this list, A is selected. If
                        neither of the markets is in this list, the notation
                        with the highest trading volume, averaged over one
                        month, is selected.        
                         The list does not restrict the request to only those markets (use the parameter `market.selection` for that purpose).
                      type: object
                      x-property-sort:
                      - ids
                      properties:
                        ids:
                          description: List of market identifiers.
                          type: array
                          nullable: false
                          items:
                            type: number
                            format: id32
                            x-positive: true
                          uniqueItems: true
                          maxItems: 100
                instrumentSelectionList:
                  description: Instrument-level restriction or exclusion.
                  type: object
                  x-property-sort:
                  - restrict
                  - exclude
                  x-atMostOne: true
                  properties:
                    restrict:
                      description: >-
                        Restriction lists. If present, the result contains only
                        notations belonging to debt instruments that are a
                        member of any of the provided lists.
                      type: object
                      x-property-sort:
                      - ids
                      properties:
                        ids:
                          description: Set of identifiers of restriction lists.
                          type: array
                          nullable: false
                          items:
                            type: number
                            format: id32
                            x-positive: true
                          uniqueItems: true
                          maxItems: 3
                    exclude:
                      description: >-
                        Exclusion lists. If present, the result does not contain
                        notations belonging to debt instruments that are a
                        member of any of the provided lists.
                      type: object
                      x-property-sort:
                      - ids
                      properties:
                        ids:
                          description: Set of identifiers of exclusion lists.
                          type: array
                          nullable: false
                          items:
                            type: number
                            format: id32
                            x-positive: true
                          uniqueItems: true
                          maxItems: 3
                notationSelectionList:
                  description: Notation-level restriction or exclusion.
                  type: object
                  x-property-sort:
                  - restrict
                  - exclude
                  x-atMostOne: true
                  properties:
                    restrict:
                      description: >-
                        Restriction lists. If present, the result contains only
                        debt instrument notations that are a member of any of
                        the provided lists.
                      type: object
                      x-property-sort:
                      - ids
                      properties:
                        ids:
                          description: Set of iden

# --- truncated at 32 KB (273 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/factset/refs/heads/main/openapi/factset-bonds-api-for-digital-portals-openapi.yml