FactSet Bonds API for Digital Portals — Instrument

naftiko: 1.0.0-alpha2
info:
  label: FactSet Bonds API for Digital Portals — Instrument
  description: 'FactSet Bonds API for Digital Portals — Instrument. 5 operations. Lead operation: Factset Fundamental Data
    for a Debt Instrument.. Self-contained Naftiko capability covering one Factset business surface.'
  tags:
  - Factset
  - Instrument
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    FACTSET_API_KEY: FACTSET_API_KEY
capability:
  consumes:
  - type: http
    namespace: bonds-api-for-digital-portals-instrument
    baseUri: https://api.factset.com/wealth/v1
    description: FactSet Bonds API for Digital Portals — Instrument business capability. Self-contained, no shared references.
    resources:
    - name: debtInstrument-get
      path: /debtInstrument/get
      operations:
      - name: getdebtinstrumentget
        method: GET
        description: Factset Fundamental Data for a Debt Instrument.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: query
          type: string
          required: true
        - name: _attributes
          in: query
          type: array
          description: Limit the attributes returned in the response to the specified set.
        - name: _language
          in: query
          type: string
    - name: debtInstrument-issuer-search
      path: /debtInstrument/issuer/search
      operations:
      - name: postdebtinstrumentissuersearch
        method: POST
        description: Factset Search for Issuers of Debt Instruments.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: debtInstrument-keyFigures-notation-get
      path: /debtInstrument/keyFigures/notation/get
      operations:
      - name: getdebtinstrumentkeyfiguresnotationget
        method: GET
        description: Factset Key Figures of a Debt Instrument.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: query
          type: string
          required: true
        - name: _attributes
          in: query
          type: array
          description: Limit the attributes returned in the response to the specified set.
    - name: debtInstrument-notation-screener-search
      path: /debtInstrument/notation/screener/search
      operations:
      - name: postdebtinstrumentnotationscreenersearch
        method: POST
        description: Factset Screener for Debt Instruments' Notations Based on Debt Instrument-specific Parameters.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: debtInstrument-notation-screener-valueRanges-get
      path: /debtInstrument/notation/screener/valueRanges/get
      operations:
      - name: postdebtinstrumentnotationscreenervaluerangesget
        method: POST
        description: Factset Possible Values and Value Ranges for the Parameters Used in the Endpoint `/debtinstrument/notation/screener/search.`
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    authentication:
      type: basic
      username: '{{env.FACTSET_USER}}'
      password: '{{env.FACTSET_PASS}}'
  exposes:
  - type: rest
    namespace: bonds-api-for-digital-portals-instrument-rest
    port: 8080
    description: REST adapter for FactSet Bonds API for Digital Portals — Instrument. One Spectral-compliant resource per
      consumed operation, prefixed with /v1.
    resources:
    - path: /v1/debtinstrument/get
      name: debtinstrument-get
      description: REST surface for debtInstrument-get.
      operations:
      - method: GET
        name: getdebtinstrumentget
        description: Factset Fundamental Data for a Debt Instrument.
        call: bonds-api-for-digital-portals-instrument.getdebtinstrumentget
        with:
          id: rest.id
          _attributes: rest._attributes
          _language: rest._language
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/debtinstrument/issuer/search
      name: debtinstrument-issuer-search
      description: REST surface for debtInstrument-issuer-search.
      operations:
      - method: POST
        name: postdebtinstrumentissuersearch
        description: Factset Search for Issuers of Debt Instruments.
        call: bonds-api-for-digital-portals-instrument.postdebtinstrumentissuersearch
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/debtinstrument/keyfigures/notation/get
      name: debtinstrument-keyfigures-notation-get
      description: REST surface for debtInstrument-keyFigures-notation-get.
      operations:
      - method: GET
        name: getdebtinstrumentkeyfiguresnotationget
        description: Factset Key Figures of a Debt Instrument.
        call: bonds-api-for-digital-portals-instrument.getdebtinstrumentkeyfiguresnotationget
        with:
          id: rest.id
          _attributes: rest._attributes
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/debtinstrument/notation/screener/search
      name: debtinstrument-notation-screener-search
      description: REST surface for debtInstrument-notation-screener-search.
      operations:
      - method: POST
        name: postdebtinstrumentnotationscreenersearch
        description: Factset Screener for Debt Instruments' Notations Based on Debt Instrument-specific Parameters.
        call: bonds-api-for-digital-portals-instrument.postdebtinstrumentnotationscreenersearch
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/debtinstrument/notation/screener/valueranges/get
      name: debtinstrument-notation-screener-valueranges-get
      description: REST surface for debtInstrument-notation-screener-valueRanges-get.
      operations:
      - method: POST
        name: postdebtinstrumentnotationscreenervaluerangesget
        description: Factset Possible Values and Value Ranges for the Parameters Used in the Endpoint `/debtinstrument/notation/screener/search.`
        call: bonds-api-for-digital-portals-instrument.postdebtinstrumentnotationscreenervaluerangesget
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: bonds-api-for-digital-portals-instrument-mcp
    port: 9090
    transport: http
    description: MCP adapter for FactSet Bonds API for Digital Portals — Instrument. One tool per consumed operation, routed
      inline through this capability's consumes block.
    tools:
    - name: factset-fundamental-data-debt-instrument
      description: Factset Fundamental Data for a Debt Instrument.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: bonds-api-for-digital-portals-instrument.getdebtinstrumentget
      with:
        id: tools.id
        _attributes: tools._attributes
        _language: tools._language
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-search-issuers-debt-instruments
      description: Factset Search for Issuers of Debt Instruments.
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: bonds-api-for-digital-portals-instrument.postdebtinstrumentissuersearch
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-key-figures-debt-instrument
      description: Factset Key Figures of a Debt Instrument.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: bonds-api-for-digital-portals-instrument.getdebtinstrumentkeyfiguresnotationget
      with:
        id: tools.id
        _attributes: tools._attributes
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-screener-debt-instruments-notations
      description: Factset Screener for Debt Instruments' Notations Based on Debt Instrument-specific Parameters.
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: bonds-api-for-digital-portals-instrument.postdebtinstrumentnotationscreenersearch
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-possible-values-and-value
      description: Factset Possible Values and Value Ranges for the Parameters Used in the Endpoint `/debtinstrument/notation/screener/search.`
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: bonds-api-for-digital-portals-instrument.postdebtinstrumentnotationscreenervaluerangesget
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.