---
title: "InstrumentListSchema"
url: "https://console.9fin.com/apis/instruments-bonds-and-loans/versions/b44d153f-c159-4311-9d98-5a5ab2608aa6/schemas/InstrumentListSchema"
---

> Full API specification: https://console.9fin.com/apis/instruments-bonds-and-loans/versions/b44d153f-c159-4311-9d98-5a5ab2608aa6.md

# InstrumentListSchema

Public-facing list of instruments.

## OpenAPI definition

```yaml
openapi: 3.1.0
info:
  title: 9fin Instruments (Bonds & Loans) API
  version: 0.8.0
servers:
  - description: Production environment
    url: https://api.9fin.com
components:
  schemas:
    InstrumentSchema:
      description: Public-facing subset of an instrument.
      properties:
        amount:
          anyOf:
            - pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
              type: string
            - type: "null"
          title: Amount
        benchmark:
          anyOf:
            - type: string
            - type: "null"
          title: Benchmark
        bookrunner_legal_advisor_id:
          anyOf:
            - type: integer
            - type: "null"
          title: Bookrunner Legal Advisor Id
        company_id:
          anyOf:
            - type: integer
            - type: "null"
          title: Company Id
        country_ref_name:
          anyOf:
            - type: string
            - type: "null"
          title: Country Ref Name
        coupon:
          anyOf:
            - pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
              type: string
            - type: "null"
          title: Coupon
        currency_ref_code:
          anyOf:
            - type: string
            - type: "null"
          title: Currency Ref Code
        deal_id:
          anyOf:
            - type: string
            - type: "null"
          title: Deal Id
        debt_security_ref_name:
          anyOf:
            - type: string
            - type: "null"
          title: Debt Security Ref Name
        entity_nf_id:
          anyOf:
            - type: string
            - type: "null"
          title: Entity Nf Id
        grade:
          items:
            type: string
          title: Grade
          type: array
        instrument_status_name:
          anyOf:
            - type: string
            - type: "null"
          title: Instrument Status Name
        instrument_type:
          anyOf:
            - type: string
            - type: "null"
          title: Instrument Type
        issue_date:
          anyOf:
            - format: date
              type: string
            - type: "null"
          title: Issue Date
        issuer_entity_id:
          anyOf:
            - type: integer
            - type: "null"
          title: Issuer Entity Id
        maturity:
          anyOf:
            - format: date
              type: string
            - type: "null"
          title: Maturity
        nf_id:
          title: Nf Id
          type: string
        other_figi:
          anyOf:
            - type: string
            - type: "null"
          title: Other Figi
        other_isin:
          anyOf:
            - type: string
            - type: "null"
          title: Other Isin
        price_date:
          anyOf:
            - format: date
              type: string
            - type: "null"
          title: Price Date
        purpose:
          items:
            type: string
          title: Purpose
          type: array
        redeemed:
          anyOf:
            - type: boolean
            - type: "null"
          title: Redeemed
        reg_144a_figi:
          anyOf:
            - type: string
            - type: "null"
          title: Reg 144A Figi
        reg_144a_isin:
          anyOf:
            - type: string
            - type: "null"
          title: Reg 144A Isin
        reg_s_figi:
          anyOf:
            - type: string
            - type: "null"
          title: Reg S Figi
        reg_s_isin:
          anyOf:
            - type: string
            - type: "null"
          title: Reg S Isin
        tap_deal:
          anyOf:
            - type: boolean
            - type: "null"
          title: Tap Deal
        tranche_seq:
          anyOf:
            - type: integer
            - type: "null"
          title: Tranche Seq
      required:
        - nf_id
        - instrument_type
        - amount
        - entity_nf_id
        - company_id
        - country_ref_name
        - coupon
        - currency_ref_code
        - deal_id
        - tranche_seq
        - debt_security_ref_name
        - reg_144a_isin
        - reg_s_isin
        - other_isin
        - reg_144a_figi
        - reg_s_figi
        - other_figi
        - instrument_status_name
        - price_date
        - issue_date
        - issuer_entity_id
        - maturity
        - redeemed
        - grade
        - tap_deal
        - purpose
        - bookrunner_legal_advisor_id
        - benchmark
      title: InstrumentSchema
      type: object
    InstrumentListSchema:
      description: Public-facing list of instruments.
      properties:
        items:
          items:
            $ref: "#/components/schemas/InstrumentSchema"
          title: Items
          type: array
        next_cursor:
          anyOf:
            - type: string
            - type: "null"
          title: Next Cursor
      required:
        - items
        - next_cursor
      title: InstrumentListSchema
      type: object
```