> ## Documentation Index
> Fetch the complete documentation index at: https://docs.terrapinfinance.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Reference Data

> Get full government and corporate bond reference data for a given set of ISINs.



## OpenAPI

````yaml post /api/v1/bond_reference
openapi: 3.0.0
info:
  title: Terrapin API
  version: 1.0.0
servers:
  - url: https://terrapinfinance.com
    variables: {}
security:
  - authorization: []
tags: []
paths:
  /api/v1/bond_reference:
    post:
      tags: []
      summary: Government and corporate reference data
      description: >-
        Get full government and corporate bond reference data for a given set of
        ISINs.
      operationId: post_bond_reference
      parameters: []
      requestBody:
        content:
          application/json:
            example:
              isins:
                - XS2724510792
            schema:
              additionalProperties: false
              properties:
                isins:
                  description: >-
                    International Securities Identification Number (ISIN),
                    unique 12-character code for the security.
                  items:
                    example: CH0282526133
                    maxLength: 12
                    minLength: 12
                    nullable: false
                    type: string
                    x-struct: null
                    x-validate: null
                  type: array
                  x-check: valid_check_digit
                  x-check-error: Invalid ISIN check digit
                  x-struct: null
                  x-transform: upcase
                  x-validate: null
              required:
                - isins
              type: object
              x-struct: null
              x-validate: null
        required: true
      responses:
        '200':
          content:
            application/json:
              example:
                data:
                  - asset_class: medium-term note
                    cfi_code: DTFUFB
                    composite_issue_rating: BBB+
                    composite_issuer_rating: BBB
                    country: Greece
                    coupon: 5.875
                    coupon_frequency: 1
                    currency: EUR
                    figi: BBG01K89S0G8
                    first_coupon_date: '2024-11-28'
                    handle: null
                    industry_group: banks
                    integral_multiple: 100000
                    interest_accrual_convention: act/act (ICMA)
                    interest_accrual_date: '2023-11-28'
                    interest_type: variable rate
                    is_144a: true
                    is_callable: true
                    is_covered: null
                    is_green: null
                    is_inflation_linked: null
                    is_outstanding: true
                    is_puttable: false
                    is_regs: true
                    isin: XS2724510792
                    issue_date: '2023-11-28'
                    issue_rating_group: investment_grade
                    issued_amount: 500000000
                    issuer_name: EUROBANK SA
                    issuer_rating_group: investment_grade
                    issuer_type: corporate
                    lei: 213800KGF4EFNUQKAT69
                    lei_direct_parent: JEUVK5RWVJEN8W0C9M24
                    lei_ultimate_parent: JEUVK5RWVJEN8W0C9M24
                    maturity_date: '2029-11-28'
                    maturity_type: fixed
                    minimum_denomination: 100000
                    name: EUROBANK SA FRN 2029
                    rank: senior unsecured
                    registration_type: bearer
                    sector: financials
                    ticker: EUROB V5.875 11/28/29 EMTN
                total: 1
              schema:
                additionalProperties: false
                properties:
                  data:
                    description: List of response data objects, often capped to 1000.
                    items:
                      additionalProperties: false
                      properties:
                        asset_class:
                          description: >
                            Asset class:


                            - `structured product`: Structured debt instrument.

                            - `medium-term note`: Bond with medium-term
                            maturity.

                            - `money market`: Short-term debt instrument.

                            - `bond`: Standard debt security.

                            - `asset-backed security`: Securitized debt backed
                            by assets.

                            - `mortgage-backed security`: Securitized debt
                            backed by mortgages.

                            - `convertible note`: Can be converted to equity.
                          enum:
                            - asset-backed security
                            - bond
                            - bond with warrants attached
                            - convertible note
                            - depository receipt on debt instruments
                            - medium-term note
                            - money market
                            - mortgage-backed security
                            - structured product
                          nullable: true
                          type: string
                          x-struct: null
                          x-validate: null
                        cfi_code:
                          description: >
                            Classification of Financial Instruments (CFI) code:


                            The CFI code is a six-letter code that classifies a
                            financial instrument by its type and key features
                            (e.g., fixed/floating rate, registered/bearer,
                            secured/unsecured).
                          example: DTFUFB
                          nullable: true
                          type: string
                          x-struct: null
                          x-validate: null
                        composite_issue_rating:
                          description: |
                            Composite rating of the issue.
                          enum:
                            - A
                            - A+
                            - A-
                            - AA
                            - AA+
                            - AA-
                            - AAA
                            - B
                            - B+
                            - B-
                            - BB
                            - BB+
                            - BB-
                            - BBB
                            - BBB+
                            - BBB-
                            - C
                            - CC
                            - CCC
                            - CCC+
                            - CCC-
                            - D
                          nullable: true
                          type: string
                          x-struct: null
                          x-validate: null
                        composite_issuer_rating:
                          description: |
                            Composite rating of the issuer.
                          enum:
                            - A
                            - A+
                            - A-
                            - AA
                            - AA+
                            - AA-
                            - AAA
                            - B
                            - B+
                            - B-
                            - BB
                            - BB+
                            - BB-
                            - BBB
                            - BBB+
                            - BBB-
                            - C
                            - CC
                            - CCC
                            - CCC+
                            - CCC-
                            - D
                          nullable: true
                          type: string
                          x-struct: null
                          x-validate: null
                        country:
                          description: >
                            Country of issuing entity:


                            **Examples:**

                            - `Germany`: Country of issue is Germany.

                            - `United Kingdom`: Country of issue is United
                            Kingdom.

                            - `United States of America`: Country of issue is
                            United States of America.
                          example: Germany
                          nullable: true
                          type: string
                          x-struct: null
                          x-validate: null
                        country_code:
                          description: >
                            Country code of issuing entity (ISO 3166-1 alpha-2
                            country codes):
                          example: DE
                          nullable: true
                          type: string
                          x-struct: null
                          x-validate: null
                        coupon:
                          description: Interest rate or coupon of the bond.
                          nullable: true
                          type: number
                          x-struct: null
                          x-validate: null
                        coupon_frequency:
                          description: |
                            Number of coupon payments per year.
                          minimum: 0
                          nullable: true
                          type: integer
                          x-struct: null
                          x-validate: null
                        currency:
                          description: |
                            Bond currency, 3-letter ISO 4217 code.
                          example: EUR
                          maxLength: 3
                          minLength: 3
                          nullable: true
                          type: string
                          x-struct: null
                          x-validate: null
                        figi:
                          description: >-
                            Financial Instrument Global Identifier (FIGI), a
                            unique 12-character alphanumeric code for financial
                            instruments.
                          example: BBG01K89S0G8
                          maxLength: 12
                          minLength: 12
                          nullable: true
                          type: string
                          x-struct: null
                          x-validate: null
                        first_coupon_date:
                          description: >-
                            Date in ISO-8601 format (YYYY-MM-DD) of the first
                            coupon payment.
                          format: date
                          nullable: true
                          type: string
                          x-struct: null
                          x-validate: null
                        handle:
                          description: >
                            Bond handles - predefined categories for filtering
                            bonds by type and characteristics.


                            **Available options by country:**


                            **German Bonds (DE):**

                            - `de_bund`: German long-term government bonds
                            (Bundesanleihen).

                            - `de_bobl`: German medium-term government bonds
                            (Bundesobligationen).

                            - `de_schatz`: German short-term government bonds
                            (Bundesschatzanweisungen).

                            - `de_bubill`: German short-term government bills
                            (Bundesschatzanweisungen).

                            - `de_ilb`: German inflation-linked government
                            bonds.

                            - `de_green`: German green government bonds.


                            **UK Bonds (GB):**

                            - `uk_gilt`: UK government bonds (Gilts).

                            - `uk_green_gilt`: UK green government bonds.

                            - `uk_il_gilt`: UK inflation-linked government
                            bonds.

                            - `uk_bill`: UK short-term government bills.


                            **French Bonds (FR):**

                            - `fr_oat`: French long-term government bonds
                            (Obligations Assimilables du Trésor).

                            - `fr_oatei`: French inflation-linked government
                            bonds (OATi).

                            - `fr_oati`: French inflation-linked government
                            bonds (alternative naming).

                            - `fr_btf`: French short-term government bills (Bons
                            du Trésor à taux fixe).

                            - `fr_bond`: French government bonds (general
                            category).


                            **Dutch Bonds (NL):**

                            - `nl_dsl`: Dutch government loans (Dutch State
                            Loans).

                            - `nl_dtc`: Dutch short-term government securities
                            (Dutch Treasury Certificates).


                            **Canadian Bonds (CA):**

                            - `ca_bond`: Canadian government bonds.

                            - `ca_bill`: Canadian short-term government bills.

                            - `ca_cmb`: Canadian mortgage-backed securities
                            (Canada Mortgage Bonds).

                            - `ca_ulbond`: Canadian ultra-long government bonds
                            (>30 years).

                            - `ca_rrbond`: Canadian inflation-linked bonds (Real
                            Return Bonds).

                            - `ca_green`: Canadian green government bonds.


                            **Swiss Bonds (CH):**

                            - `ch_bond`: Swiss government bonds.


                            **Czech Bonds (CZ):**

                            - `cz_bond`: Czech government bonds.

                            - `cz_bill`: Czech short-term government bills.

                            - `cz_fr_bond`: Czech floating-rate government
                            bonds.

                            - `cz_zr_bond`: Czech zero-coupon government bonds.


                            **Spanish Bonds (ES):**

                            - `es_bill`: Spanish short-term government bills.

                            - `es_bond`: Spanish government bonds.

                            - `es_ilb_bond`: Spanish inflation-linked government
                            bonds.

                            - `es_zr_bond`: Spanish zero-coupon government
                            bonds.

                            - `es_vr_bond`: Spanish variable-rate government
                            bonds.


                            **Chinese Bonds (CN):**

                            - `cn_bill`: Chinese government short-term bills.

                            - `cn_bond`: Chinese government bonds.

                            - `cn_bond_vr`: Chinese government variable-rate
                            bonds.

                            - `cn_bond_zr`: Chinese government zero-coupon
                            bonds.


                            **US Treasury Bonds (US):**

                            - `us_tips`: US Treasury Inflation-Protected
                            Securities (TIPS).

                            - `us_frn`: US Treasury Floating Rate Notes (FRN).

                            - `us_bill`: US Treasury Bills (short-term
                            securities).

                            - `us_cmb`: US Treasury Cash Management Bills (CMB).

                            - `us_note`: US Treasury Notes (medium-term
                            securities).

                            - `us_bond`: US Treasury Bonds (long-term
                            securities).


                            **Thai Bonds (TH):**

                            - `th_bill`: Thai short-term government bills.

                            - `th_bond`: Thai government bonds.

                            - `th_ilb_bond`: Thai inflation-linked government
                            bonds.

                            - `th_green_bond`: Thai green government bonds.

                            - `th_zr_bond`: Thai zero-coupon government bonds.

                            - `th_vr_bond`: Thai variable-rate government bonds.
                          enum:
                            - ca_bill
                            - ca_bond
                            - ca_cmb
                            - ca_green
                            - ca_rrbond
                            - ca_ulbond
                            - ch_bond
                            - cn_bill
                            - cn_bond
                            - cn_bond_vr
                            - cn_bond_zr
                            - cz_bill
                            - cz_bond
                            - cz_fr_bond
                            - cz_zr_bond
                            - de_bobl
                            - de_bubill
                            - de_bund
                            - de_green
                            - de_ilb
                            - de_schatz
                            - es_bill
                            - es_bond
                            - es_ilb_bond
                            - es_vr_bond
                            - es_zr_bond
                            - fr_btf
                            - fr_oat
                            - fr_oatei
                            - fr_oati
                            - nl_dsl
                            - nl_dtc
                            - uk_bill
                            - uk_gilt
                            - uk_green_gilt
                            - uk_il_gilt
                            - us_bill
                            - us_bond
                            - us_cmb
                            - us_frn
                            - us_note
                            - us_tips
                          nullable: true
                          type: string
                          x-struct: null
                          x-validate: null
                        industry_group:
                          description: Industry group of the issuer.
                          example: banks
                          nullable: true
                          type: string
                          x-struct: null
                          x-validate: null
                        integral_multiple:
                          description: Integral multiple for bond denominations.
                          nullable: true
                          type: number
                          x-struct: null
                          x-validate: null
                        interest_accrual_convention:
                          description: >
                            Day count convention for interest accrual:


                            - `act/act (ICMA)`: Uses actual number of days in
                            period and year.

                            - `30/360`: Assumes 30 days per month, 360 days per
                            year.

                            - `act/360`: Uses actual days in period, 360 days
                            per year.

                            - `act/365`: Uses actual days in period, 365 days
                            per year.

                            - `act/act`: Uses actual number of days in period
                            and year.

                            - `act/act (ISDA)`: ISDA convention for
                            actual/actual.

                            - `act/act (AFB)`: AFB convention for actual/actual.
                          enum:
                            - 30/360
                            - 30/365
                            - act/360
                            - act/365
                            - act/act
                            - act/act (AFB)
                            - act/act (ICMA)
                            - act/act (ISDA)
                          nullable: true
                          type: string
                          x-struct: null
                          x-validate: null
                        interest_accrual_date:
                          description: >-
                            Date in ISO-8601 format (YYYY-MM-DD) from which
                            interest accrues.
                          format: date
                          nullable: true
                          type: string
                          x-struct: null
                          x-validate: null
                        interest_type:
                          description: >
                            Type of interest:


                            - `zero rate / discount rate`: A bond that does not
                            pay or accrue interest.

                            - `fixed rate`: Pays a fixed coupon throughout the
                            bond's life.

                            - `variable rate`: Coupon varies with a reference
                            rate (e.g., SOFR, SONIA, Inflation indexes, etc.).

                            - `misc.`: Miscellaneous interest types.

                            - `payment in kind`: Interest paid in additional
                            securities.

                            - `dividend payments`: Interest paid as dividends.

                            - `cash payment`: Interest paid in cash.

                            - `at maturity`: Interest paid at maturity.
                          enum:
                            - at maturity
                            - cash payment
                            - dividend payments
                            - fixed interest payments
                            - fixed rate
                            - misc.
                            - no payments
                            - payment in kind
                            - variable interest payments
                            - variable rate
                            - zero rate / discount rate
                          nullable: true
                          type: string
                          x-struct: null
                          x-validate: null
                        is_144a:
                          description: >
                            Whether the bond is Rule 144A compliant,can be sold
                            to qualified US institutional buyers.
                          nullable: true
                          type: boolean
                          x-struct: null
                          x-validate: null
                        is_callable:
                          description: |
                            Whether the bond is callable before maturity.
                          nullable: true
                          type: boolean
                          x-struct: null
                          x-validate: null
                        is_covered:
                          description: |
                            Whether the bond is secured by collateral.
                          nullable: true
                          type: boolean
                          x-struct: null
                          x-validate: null
                        is_green:
                          description: |
                            Whether the bond is a green bond.
                          nullable: true
                          type: boolean
                          x-struct: null
                          x-validate: null
                        is_inflation_linked:
                          description: >
                            Whether the bond is inflation-linked, its payments
                            are linked to an inflation index.
                          nullable: true
                          type: boolean
                          x-struct: null
                          x-validate: null
                        is_outstanding:
                          description: >
                            Whether the bond is currently outstanding, has not
                            matured, been called, or otherwise redeemed.
                          nullable: true
                          type: boolean
                          x-struct: null
                          x-validate: null
                        is_puttable:
                          description: |
                            Whether the bond is puttable before maturity.
                          nullable: true
                          type: boolean
                          x-struct: null
                          x-validate: null
                        is_regs:
                          description: >
                            Whether the bond is Regulation S (RegS) compliant,
                            can be sold to non-US investors.
                          nullable: true
                          type: boolean
                          x-struct: null
                          x-validate: null
                        isin:
                          description: >-
                            International Securities Identification Number
                            (ISIN), unique 12-character code for the security.
                          example: CH0282526133
                          maxLength: 12
                          minLength: 12
                          nullable: false
                          type: string
                          x-check: valid_check_digit
                          x-check-error: Invalid ISIN check digit
                          x-struct: null
                          x-transform: upcase
                          x-validate: null
                        issue_date:
                          description: >-
                            Date the bond was issued in ISO-8601 format
                            (YYYY-MM-DD).
                          format: date
                          nullable: true
                          type: string
                          x-struct: null
                          x-validate: null
                        issue_rating_group:
                          description: >
                            Issue rating group, based on TP composite long-term
                            ratings:

                              - `investment_grade`: High credit quality (BBB- and above)
                              - `high_yield`: Lower credit quality (BB+ and below)
                          enum:
                            - high_yield
                            - investment_grade
                          nullable: true
                          type: string
                          x-struct: null
                          x-validate: null
                        issued_amount:
                          description: >-
                            Total amount issued (face value) in the bond's
                            currency.
                          nullable: true
                          type: number
                          x-struct: null
                          x-validate: null
                        issuer_name:
                          description: Name of the issuing entity.
                          example: EUROBANK SA
                          nullable: true
                          type: string
                          x-struct: null
                          x-validate: null
                        issuer_rating_group:
                          description: >
                            Issuer rating group, based on TP composite long-term
                            ratings:


                            - `investment_grade`: High credit quality (BBB- and
                            above)

                            - `high_yield`: Lower credit quality (BB+ and below)
                          enum:
                            - high_yield
                            - investment_grade
                          nullable: true
                          type: string
                          x-struct: null
                          x-validate: null
                        issuer_type:
                          enum:
                            - corporate
                            - government
                            - government_linked
                            - international_organization
                            - municipal
                            - state
                          nullable: true
                          type: string
                          x-struct: null
                          x-validate: null
                        lei:
                          description: >
                            Legal Entity Identifier (LEI) of the issuer:


                            A 20-character, alpha-numeric code based on the ISO
                            17442 standard used to uniquely identify legal
                            entities in financial transactions. Most LEIs follow
                            this structure, but there are exceptions that use
                            local national standards.
                          example: 213800KGF4EFNUQKAT69
                          maxLength: 20
                          minLength: 20
                          nullable: true
                          type: string
                          x-struct: null
                          x-validate: null
                        lei_direct_parent:
                          description: >
                            LEI of the direct parent of the issuer:


                            A 20-character, alpha-numeric code based on the ISO
                            17442 standard used to uniquely identify legal
                            entities in financial transactions. Most LEIs follow
                            this structure, but there are exceptions that use
                            local national standards.
                          example: JEUVK5RWVJEN8W0C9M24
                          maxLength: 20
                          minLength: 20
                          nullable: true
                          type: string
                          x-struct: null
                          x-validate: null
                        lei_ultimate_parent:
                          description: >
                            LEI of the ultimate parent of the issuer:


                            A 20-character, alpha-numeric code based on the ISO
                            17442 standard used to uniquely identify legal
                            entities in financial transactions. Most LEIs follow
                            this structure, but there are exceptions that use
                            local national standards.
                          example: JEUVK5RWVJEN8W0C9M24
                          maxLength: 20
                          minLength: 20
                          nullable: true
                          type: string
                          x-struct: null
                          x-validate: null
                        maturity_date:
                          description: >-
                            Date when the bond principal is due to be repaid in
                            ISO-8601 format (YYYY-MM-DD).
                          format: date
                          nullable: false
                          type: string
                          x-struct: null
                          x-validate: null
                        maturity_type:
                          description: >
                            Maturity type:


                            - `fixed`: Principal repaid at maturity.

                            - `amortized`: Principal repaid gradually before
                            maturity.

                            - `perpetual`: No maturity date; principal is never
                            repaid.

                            - `extendible`: Maturity date can be extended by
                            issuer or holder.
                          enum:
                            - amortized
                            - extendible
                            - fixed
                            - perpetual
                          nullable: true
                          type: string
                          x-struct: null
                          x-validate: null
                        minimum_denomination:
                          description: >-
                            Minimum denomination in which the bond can be
                            purchased.
                          nullable: true
                          type: number
                          x-struct: null
                          x-validate: null
                        name:
                          description: Full name of the bond.
                          example: EUROBANK SA FRN 2029
                          nullable: true
                          type: string
                          x-struct: null
                          x-validate: null
                        rank:
                          description: >+
                            Seniority or rank of the bond:


                            - `senior unsecured`: Highest priority among
                            unsecured debt.

                            - `senior`: Standard senior debt.

                            - `secured`: Backed by collateral.

                            - `government / state`: Government or state-issued
                            debt.

                            - `subordinated`: Lower priority, paid after senior
                            debt.

                            - `supranational`: Issued by supranational entities.

                            - `senior subordinated`: Senior within subordinated
                            class.

                            - `junior secured`: Junior secured debt.

                            - `junior subordinated`: Junior within subordinated
                            class.

                            - `junior`: Junior debt.

                          enum:
                            - government / state
                            - junior
                            - junior secured
                            - junior subordinated
                            - mezzanine
                            - secured
                            - senior
                            - senior subordinated
                            - senior unsecured
                            - subordinated
                            - supranational
                          nullable: true
                          type: string
                          x-struct: null
                          x-validate: null
                        registration_type:
                          description: >
                            Registration type:


                            - `bearer`: Ownership is determined by physical
                            possession.

                            - `registered`: Ownership is recorded and tracked by
                            issuer or agent.

                            - `misc.`: Miscellaneous registration types.

                            - `bearer / registered`: Hybrid registration type.
                          enum:
                            - bearer
                            - bearer / registered
                            - misc.
                            - registered
                          nullable: true
                          type: string
                          x-struct: null
                          x-validate: null
                        sector:
                          description: Sector of the issuer.
                          enum:
                            - communication services
                            - consumer discretionary
                            - consumer staples
                            - education
                            - energy
                            - financials
                            - health care
                            - industrials
                            - information technology
                            - materials
                            - real estate
                            - utilities
                          nullable: true
                          type: string
                          x-struct: null
                          x-validate: null
                        ticker:
                          description: Bond ticker symbol.
                          example: EUROB V5.875 11/28/29 EMTN
                          nullable: true
                          type: string
                          x-struct: null
                          x-validate: null
                      required:
                        - asset_class
                        - cfi_code
                        - composite_issue_rating
                        - composite_issuer_rating
                        - country
                        - country_code
                        - coupon
                        - coupon_frequency
                        - currency
                        - figi
                        - first_coupon_date
                        - handle
                        - industry_group
                        - integral_multiple
                        - interest_accrual_convention
                        - interest_accrual_date
                        - interest_type
                        - is_144a
                        - is_callable
                        - is_covered
                        - is_green
                        - is_inflation_linked
                        - is_outstanding
                        - is_puttable
                        - is_regs
                        - isin
                        - issue_date
                        - issue_rating_group
                        - issued_amount
                        - issuer_name
                        - issuer_rating_group
                        - issuer_type
                        - lei
                        - lei_direct_parent
                        - lei_ultimate_parent
                        - maturity_date
                        - maturity_type
                        - minimum_denomination
                        - name
                        - rank
                        - registration_type
                        - sector
                        - ticker
                      type: object
                      x-struct: null
                      x-validate: null
                    type: array
                    x-struct: null
                    x-validate: null
                  total:
                    description: >-
                      Total number of results in the database that match the
                      query filters.
                    type: integer
                    x-struct: null
                    x-validate: null
                required:
                  - data
                  - total
                title: BondReferenceResponse
                type: object
                x-struct: null
                x-validate: null
          description: Reference data
        '401':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  errors:
                    items:
                      additionalProperties: false
                      properties:
                        detail:
                          example: Unauthorized
                          type: string
                          x-struct: null
                          x-validate: null
                        reason:
                          example: >-
                            Your account tier does not allow this operation.
                            Contact team@terrapinfinance.com for an upgrade.
                          type: string
                          x-struct: null
                          x-validate: null
                      required:
                        - detail
                      type: object
                      x-struct: null
                      x-validate: null
                    type: array
                    x-struct: null
                    x-validate: null
                required:
                  - errors
                type: object
                x-struct: null
                x-validate: null
          description: Unauthorized
        '402':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  errors:
                    items:
                      additionalProperties: false
                      properties:
                        detail:
                          example: Payment Required
                          type: string
                          x-struct: null
                          x-validate: null
                        reason:
                          example: >-
                            You have run out of your granted quota for this
                            resource as defined by your account tier. Contact
                            team@terrapinfinance.com for an upgrade.
                          type: string
                          x-struct: null
                          x-validate: null
                      required:
                        - detail
                      type: object
                      x-struct: null
                      x-validate: null
                    type: array
                    x-struct: null
                    x-validate: null
                required:
                  - errors
                type: object
                x-struct: null
                x-validate: null
          description: Payment Required
        '403':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  errors:
                    items:
                      additionalProperties: false
                      properties:
                        detail:
                          example: Forbidden
                          type: string
                          x-struct: null
                          x-validate: null
                        reason:
                          example: >-
                            Your account tier does not allow this operation.
                            Contact team@terrapinfinance.com for an upgrade.
                          type: string
                          x-struct: null
                          x-validate: null
                      required:
                        - detail
                      type: object
                      x-struct: null
                      x-validate: null
                    type: array
                    x-struct: null
                    x-validate: null
                required:
                  - errors
                type: object
                x-struct: null
                x-validate: null
          description: Forbidden
        '422':
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          example: 'Invalid string. Got: integer'
                          type: string
                          x-struct: null
                          x-validate: null
                        source:
                          properties:
                            pointer:
                              example: /isins/0
                              type: string
                              x-struct: null
                              x-validate: null
                          required:
                            - pointer
                          type: object
                          x-struct: null
                          x-validate: null
                        title:
                          example: Invalid value
                          type: string
                          x-struct: null
                          x-validate: null
                      required:
                        - detail
                        - source
                        - title
                      type: object
                      x-struct: null
                      x-validate: null
                    type: array
                    x-struct: null
                    x-validate: null
                required:
                  - errors
                type: object
                x-struct: null
                x-validate: null
          description: Unprocessable Entity
        '429':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  errors:
                    items:
                      additionalProperties: false
                      properties:
                        detail:
                          example: Too Many Requests
                          type: string
                          x-struct: null
                          x-validate: null
                        reason:
                          type: string
                          x-struct: null
                          x-validate: null
                      required:
                        - detail
                      type: object
                      x-struct: null
                      x-validate: null
                    type: array
                    x-struct: null
                    x-validate: null
                required:
                  - errors
                type: object
                x-struct: null
                x-validate: null
          description: Too Many Requests
        '500':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  errors:
                    items:
                      additionalProperties: false
                      properties:
                        detail:
                          example: Internal Server Error
                          type: string
                          x-struct: null
                          x-validate: null
                        reason:
                          type: string
                          x-struct: null
                          x-validate: null
                      required:
                        - detail
                      type: object
                      x-struct: null
                      x-validate: null
                    type: array
                    x-struct: null
                    x-validate: null
                required:
                  - errors
                type: object
                x-struct: null
                x-validate: null
          description: Internal Server Error
      callbacks: {}
components:
  securitySchemes:
    authorization:
      scheme: bearer
      type: http

````