---
title: "Instrument"
url: "https://console.9fin.com/apis/instruments-private-credit/versions/0a7cc486-1d5a-439d-bde2-7d398e87f4ee/schemas/Instrument"
---

> Full API specification: https://console.9fin.com/apis/instruments-private-credit/versions/0a7cc486-1d5a-439d-bde2-7d398e87f4ee.md

# Instrument

## OpenAPI definition

```yaml
openapi: 3.1.0
info:
  title: 9Fin Instruments (Private Credit) API
  version: 0.1.10
servers:
  - description: Production environment
    url: https://api.9fin.com
components:
  schemas:
    CurrencyRange:
      description: >-
        A monetary value as a range, converted into each major currency.


        The same underlying amount is provided in EUR, GBP and USD for
        convenience,

        alongside the original currency and value as reported.
      properties:
        eur:
          anyOf:
            - $ref: "#/components/schemas/FloatRange"
            - type: "null"
          description: Value converted to euros, expressed as a range.
        gbp:
          anyOf:
            - $ref: "#/components/schemas/FloatRange"
            - type: "null"
          description: Value converted to pounds sterling, expressed as a range.
        original_currency:
          anyOf:
            - $ref: "#/components/schemas/Currency"
            - type: "null"
          description: Currency the value was originally reported in.
        original_value:
          anyOf:
            - $ref: "#/components/schemas/FloatRange"
            - type: "null"
          description: Value in the original reporting currency, expressed as a range.
        usd:
          anyOf:
            - $ref: "#/components/schemas/FloatRange"
            - type: "null"
          description: Value converted to US dollars, expressed as a range.
      required:
        - eur
        - gbp
        - usd
        - original_currency
        - original_value
      title: CurrencyRange
      type: object
    Advisor:
      properties:
        full_name:
          description: Full legal name of the advisory firm.
          title: Full Name
          type: string
        short_name:
          description: Abbreviated or commonly used name of the advisory firm.
          title: Short Name
          type: string
        street_name:
          description: Name commonly used to identify the advisory firm.
          title: Street Name
          type: string
      required:
        - street_name
        - full_name
        - short_name
      title: Advisor
      type: object
    LegalAdvisor:
      properties:
        full_name:
          description: Full legal name of the law firm.
          title: Full Name
          type: string
        short_name:
          description: Abbreviated or commonly used name of the law firm.
          title: Short Name
          type: string
        street_name:
          description: Name commonly used to identify the law firm.
          title: Street Name
          type: string
      required:
        - street_name
        - full_name
        - short_name
      title: LegalAdvisor
      type: object
    Company:
      properties:
        alias:
          anyOf:
            - items:
                type: string
              type: array
            - type: "null"
          description: Alternative names the company is also known by.
          title: Alias
        cik:
          anyOf:
            - type: integer
            - type: "null"
          description: SEC Central Index Key (CIK) identifying the company in SEC filings.
          title: Cik
        country_of_risk:
          description: Country to which the company's credit risk is primarily attributed.
          title: Country Of Risk
          type: string
        description:
          anyOf:
            - type: string
            - type: "null"
          description: Free-text description of the company and its business.
          title: Description
        full_name:
          description: Full legal name of the company.
          title: Full Name
          type: string
        industry:
          anyOf:
            - $ref: "#/components/schemas/Industry"
            - type: "null"
          description: Hierarchical industry classification of the company.
        nf_id:
          description: 9Fin ID for this company. Unique for all companies and across APIs.
          title: Nf Id
          type: string
        street_name:
          description: Name commonly used to identify the company.
          title: Street Name
          type: string
        website:
          anyOf:
            - format: uri
              minLength: 1
              type: string
            - type: "null"
          description: URL of the company's website.
          title: Website
      required:
        - nf_id
        - street_name
        - full_name
        - country_of_risk
        - description
        - industry
        - website
        - cik
        - alias
      title: Company
      type: object
    Currency:
      properties:
        code:
          description: ISO 4217 currency code (e.g. EUR, GBP, USD).
          title: Code
          type: string
        name:
          description: Human-readable currency name.
          title: Name
          type: string
      required:
        - code
        - name
      title: Currency
      type: object
    DebtSecurity:
      properties:
        abbreviation:
          description: Common abbreviation for the debt security type (e.g. TLB).
          title: Abbreviation
          type: string
        name:
          description: Full name of the debt security type (e.g. Term Loan B).
          title: Name
          type: string
        type:
          $ref: "#/components/schemas/DebtType"
          description: Interest-rate type of the security (fixed, floating, or N/A).
      required:
        - name
        - abbreviation
        - type
      title: DebtSecurity
      type: object
    DateRange:
      description: >-
        A date expressed as a (possibly open-ended) range.


        Used where a date is only known to fall within a window rather than on
        an

        exact day.
      properties:
        lower:
          anyOf:
            - format: date
              type: string
            - type: "null"
          description: Earliest date in the range; null if unbounded below.
          title: Lower
        lower_inclusive:
          description: Whether the lower bound is inclusive.
          title: Lower Inclusive
          type: boolean
        upper:
          anyOf:
            - format: date
              type: string
            - type: "null"
          description: Latest date in the range; null if unbounded above.
          title: Upper
        upper_inclusive:
          description: Whether the upper bound is inclusive.
          title: Upper Inclusive
          type: boolean
      required:
        - upper
        - lower
        - upper_inclusive
        - lower_inclusive
      title: DateRange
      type: object
    FloatRange:
      description: >-
        A numeric value expressed as a (possibly open-ended) range.


        Marketed metrics are frequently disclosed as ranges rather than exact

        figures, so values are represented by their bounds and whether each
        bound

        is inclusive.
      properties:
        lower:
          anyOf:
            - type: number
            - type: "null"
          description: Lower bound of the range; null if unbounded below.
          title: Lower
        lower_inclusive:
          description: Whether the lower bound is inclusive.
          title: Lower Inclusive
          type: boolean
        upper:
          anyOf:
            - type: number
            - type: "null"
          description: Upper bound of the range; null if unbounded above.
          title: Upper
        upper_inclusive:
          description: Whether the upper bound is inclusive.
          title: Upper Inclusive
          type: boolean
      required:
        - upper
        - lower
        - upper_inclusive
        - lower_inclusive
      title: FloatRange
      type: object
    IssuerEntity:
      properties:
        company:
          anyOf:
            - $ref: "#/components/schemas/Company"
            - type: "null"
          description: The parent company associated with the issuer entity.
        name:
          description: Name of the issuing/borrowing legal entity.
          title: Name
          type: string
      required:
        - name
        - company
      title: IssuerEntity
      type: object
    Sponsor:
      properties:
        full_name:
          description: Full legal name of the private equity sponsor.
          title: Full Name
          type: string
        short_name:
          description: Abbreviated or commonly used name of the sponsor.
          title: Short Name
          type: string
        street_name:
          description: Name commonly used to identify the sponsor.
          title: Street Name
          type: string
        website:
          anyOf:
            - format: uri
              minLength: 1
              type: string
            - type: "null"
          description: URL of the sponsor's website.
          title: Website
      required:
        - street_name
        - full_name
        - short_name
        - website
      title: Sponsor
      type: object
    Industry:
      properties:
        level_1:
          description: Top-level (broadest) industry classification.
          title: Level 1
          type: string
        level_2:
          description: Second-level industry classification, nested under level 1.
          title: Level 2
          type: string
        level_3:
          description: Third-level (most granular) industry classification, nested under
            level 2.
          title: Level 3
          type: string
      required:
        - level_1
        - level_2
        - level_3
      title: Industry
      type: object
    DebtType:
      enum:
        - fixed
        - floating
        - N/A
      title: DebtType
      type: string
    Instrument:
      properties:
        amount:
          anyOf:
            - $ref: "#/components/schemas/CurrencyRange"
            - type: "null"
          description: Principal amount of the instrument, with values converted across
            currencies and expressed as a range.
        benchmark:
          anyOf:
            - type: string
            - type: "null"
          description: Reference benchmark rate the margin is set over (e.g. SOFR, EURIBOR).
          title: Benchmark
        borrower_advisors:
          anyOf:
            - items:
                $ref: "#/components/schemas/Advisor"
              type: array
            - type: "null"
          description: Non-legal advisers (e.g. financial or M&A advisers) acting for the
            borrower.
          title: Borrower Advisors
        borrower_legal_advisor:
          anyOf:
            - $ref: "#/components/schemas/LegalAdvisor"
            - type: "null"
          description: Law firm advising the borrower on the financing.
        company:
          anyOf:
            - $ref: "#/components/schemas/Company"
            - type: "null"
          description: The borrowing company that the instrument finances.
        cov_lite:
          anyOf:
            - type: boolean
            - type: "null"
          description: Whether the instrument is covenant-lite (lacks maintenance
            covenants).
          title: Cov Lite
        currency:
          anyOf:
            - $ref: "#/components/schemas/Currency"
            - type: "null"
          description: Currency in which the instrument is denominated.
        debt_purpose:
          anyOf:
            - items:
                type: string
              type: array
            - type: "null"
          description: Intended use(s) of proceeds (e.g. acquisition, refinancing,
            dividend recap).
          title: Debt Purpose
        debt_security:
          anyOf:
            - $ref: "#/components/schemas/DebtSecurity"
            - type: "null"
          description: Type of debt security (e.g. term loan, senior secured notes).
        governing_law:
          anyOf:
            - type: string
            - type: "null"
          description: Jurisdiction whose law governs the instrument's documentation.
          title: Governing Law
        is_green:
          anyOf:
            - type: boolean
            - type: "null"
          description: Whether the instrument is a green financing (proceeds earmarked for
            environmental projects).
          title: Is Green
        is_sponsor_deal:
          anyOf:
            - type: boolean
            - type: "null"
          description: Whether the financing backs a private-equity-sponsored borrower.
          title: Is Sponsor Deal
        is_sustainability_linked:
          anyOf:
            - type: boolean
            - type: "null"
          description: Whether the instrument's terms are linked to sustainability
            performance targets.
          title: Is Sustainability Linked
        is_tap_deal:
          anyOf:
            - type: boolean
            - type: "null"
          description: Whether the instrument is a tap (an add-on to an existing issuance).
          title: Is Tap Deal
        issue_date:
          anyOf:
            - $ref: "#/components/schemas/DateRange"
            - type: "null"
          description: Date the instrument was issued, expressed as a range to reflect
            uncertainty or marketed windows.
        issue_price:
          anyOf:
            - $ref: "#/components/schemas/FloatRange"
            - type: "null"
          description: Issue price as a percentage of par, expressed as a range.
        issuer_entity:
          anyOf:
            - $ref: "#/components/schemas/IssuerEntity"
            - type: "null"
          description: Legal entity that issues or borrows under the instrument.
        lender_advisors:
          anyOf:
            - items:
                $ref: "#/components/schemas/Advisor"
              type: array
            - type: "null"
          description: Non-legal advisers (e.g. financial or M&A advisers) acting for the
            lender(s).
          title: Lender Advisors
        lender_legal_advisor:
          anyOf:
            - $ref: "#/components/schemas/LegalAdvisor"
            - type: "null"
          description: Law firm advising the lender(s) on the financing.
        lenders:
          anyOf:
            - items:
                type: string
              type: array
            - type: "null"
          description: Names of the lenders providing the financing.
          title: Lenders
        margin:
          anyOf:
            - $ref: "#/components/schemas/FloatRange"
            - type: "null"
          description: Interest margin (spread) over the benchmark rate, in basis points,
            expressed as a range.
        marketed_capex:
          anyOf:
            - $ref: "#/components/schemas/CurrencyRange"
            - type: "null"
          description: Capital expenditure figure marketed to lenders, with values
            converted across currencies and expressed as a range.
        marketed_capex_as_percentage_of_sales:
          anyOf:
            - $ref: "#/components/schemas/FloatRange"
            - type: "null"
          description: Marketed capital expenditure as a percentage of sales, expressed as
            a range.
        marketed_ebitda:
          anyOf:
            - $ref: "#/components/schemas/CurrencyRange"
            - type: "null"
          description: EBITDA figure marketed to lenders, with values converted across
            currencies and expressed as a range.
        marketed_ebitda_as_percentage_of_margin:
          anyOf:
            - $ref: "#/components/schemas/FloatRange"
            - type: "null"
          description: Marketed EBITDA margin (EBITDA as a percentage of sales), expressed
            as a range.
        marketed_interest_coverage:
          anyOf:
            - $ref: "#/components/schemas/FloatRange"
            - type: "null"
          description: Marketed interest coverage ratio (EBITDA / interest expense),
            expressed as a range.
        marketed_sales:
          anyOf:
            - $ref: "#/components/schemas/CurrencyRange"
            - type: "null"
          description: Sales/revenue figure marketed to lenders, with values converted
            across currencies and expressed as a range.
        marketed_senior_gross_leverage:
          anyOf:
            - $ref: "#/components/schemas/FloatRange"
            - type: "null"
          description: Marketed senior gross leverage multiple (senior debt / EBITDA),
            expressed as a range.
        marketed_senior_net_leverage:
          anyOf:
            - $ref: "#/components/schemas/FloatRange"
            - type: "null"
          description: Marketed senior net leverage multiple (senior debt net of cash /
            EBITDA), expressed as a range.
        marketed_total_gross_leverage:
          anyOf:
            - $ref: "#/components/schemas/FloatRange"
            - type: "null"
          description: Marketed total gross leverage multiple (total debt / EBITDA),
            expressed as a range.
        marketed_total_net_leverage:
          anyOf:
            - $ref: "#/components/schemas/FloatRange"
            - type: "null"
          description: Marketed total net leverage multiple (total debt net of cash /
            EBITDA), expressed as a range.
        maturity:
          anyOf:
            - $ref: "#/components/schemas/DateRange"
            - type: "null"
          description: Date the instrument matures, expressed as a range to reflect
            uncertainty or marketed windows.
        nf_id:
          description: 9Fin ID for this instrument. Unique for all instruments and across
            APIs.
          title: Nf Id
          type: string
        pik_coupon:
          anyOf:
            - $ref: "#/components/schemas/FloatRange"
            - type: "null"
          description: Payment-in-kind (PIK) coupon rate, expressed as a range.
        portability:
          anyOf:
            - type: boolean
            - type: "null"
          description: Whether the debt is portable (can survive a change of control of
            the borrower).
          title: Portability
        redeemed:
          anyOf:
            - type: boolean
            - type: "null"
          description: Whether the instrument has been redeemed/repaid.
          title: Redeemed
        reporting_period_currency:
          anyOf:
            - $ref: "#/components/schemas/Currency"
            - type: "null"
          description: Currency in which the issuer's reported financials are expressed.
        reporting_period_date:
          anyOf:
            - format: date
              type: string
            - type: "null"
          description: End date of the financial reporting period the marketed figures
            relate to.
          title: Reporting Period Date
        reporting_type:
          anyOf:
            - type: string
            - type: "null"
          description: Type of financial reporting the marketed figures are based on (e.g.
            last twelve months, annual).
          title: Reporting Type
        sources:
          anyOf:
            - items:
                type: string
              type: array
            - type: "null"
          description: Sources from which the instrument's data was obtained.
          title: Sources
        sponsors:
          anyOf:
            - items:
                $ref: "#/components/schemas/Sponsor"
              type: array
            - type: "null"
          description: Private equity sponsor(s) backing the borrower, where applicable.
          title: Sponsors
        status:
          anyOf:
            - type: string
            - type: "null"
          description: Current lifecycle status of the instrument (e.g. announced, priced,
            closed).
          title: Status
        tenor:
          anyOf:
            - $ref: "#/components/schemas/FloatRange"
            - type: "null"
          description: Tenor of the instrument in years, expressed as a range.
      required:
        - nf_id
        - borrower_legal_advisor
        - lender_legal_advisor
        - borrower_advisors
        - lender_advisors
        - company
        - currency
        - debt_security
        - governing_law
        - status
        - issuer_entity
        - reporting_period_currency
        - reporting_type
        - debt_purpose
        - sponsors
        - issue_date
        - maturity
        - amount
        - marketed_capex
        - marketed_ebitda
        - marketed_sales
        - issue_price
        - margin
        - marketed_interest_coverage
        - marketed_senior_gross_leverage
        - marketed_senior_net_leverage
        - marketed_total_gross_leverage
        - marketed_total_net_leverage
        - marketed_ebitda_as_percentage_of_margin
        - marketed_capex_as_percentage_of_sales
        - pik_coupon
        - tenor
        - benchmark
        - cov_lite
        - is_green
        - is_sustainability_linked
        - lenders
        - portability
        - redeemed
        - reporting_period_date
        - sources
        - is_sponsor_deal
        - is_tap_deal
      title: Instrument
      type: object
```