> ## 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 US municipal bond reference data for given ISINs. ## OpenAPI ````yaml post /api/v1/muni_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/muni_reference: post: tags: [] summary: US municipal bond reference description: Get full US municipal bond reference data for given ISINs. operationId: post_muni_reference parameters: [] requestBody: content: application/json: example: isins: - US005824LP01 schema: additionalProperties: false properties: isins: description: >- International Securities Identification Number (ISIN), unique 12-character code for the security. items: example: US64966HW301 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: - advisors: - PMA Securities, LLC award_date: '2024-01-30' award_time: '14:57:00' bond_counsel: - Chapman and Cutler LLP capital_purpose: new money closing_date: '2024-02-20' counties: - Adams country: United States of America country_code: US coupon_frequency: 2 coupon_payment_day: 1 coupon_payment_months: - 2 - 8 credit_enhancement_type: - bond_insurance currency: USD dated_date: '2024-02-20' disclosure_counsel: - Chapman and Cutler LLP extraordinary_optional_redemption: null figi: BBG01L7LZSL5 first_call_date: '2032-02-01' first_execution_date: '2024-01-31' first_execution_time: '10:30:00' first_interest_payment_date: '2024-08-01' first_trade_date: '2024-01-31' gas_prepay_guarantor: null guarantee: unsecured has_mandatory_redemption: false has_official_statement: true insurers: - Assured Guaranty Municipal Corp. integral_multiple: 5000 interest_accrual_convention: 30/360 interest_accrual_date: '2024-02-20' interest_maximum_rate: null interest_minimum_rate: null interest_payment_schedule: - interest_type: regular payment_date: day: 1 month: 8 year: 2024 periodic_schedule: period_amount: 6 period_type: month until: null interest_rate: 5 interest_rate_schedule: - determination_period: null from_date: null interest_rate: 5 interest_type: fixed rate_mode_name: null until_date: null interest_type: fixed rate is_amt: false is_bab: false is_bank_qualified: true is_callable: true is_credit_enhanced: true is_federally_taxable: false is_green: false is_insured: true is_outstanding: true is_pac: false is_social: false is_state_enhanced: false is_state_taxable: true is_sustainable: false isin: US005824LP01 issue_date: '2024-01-30' issue_price: 111.945 issue_yield: 3.28 issued_amount: 240000 issuer_canonical_id: 50926 issuer_name: School District Number 172 liquidity_facility: null mandatory_redemption_schedule: [] maturity_amount: 240000 maturity_date: '2035-02-01' minimum_denomination: 5000 next_call_date: '2032-02-01' next_coupon_date: '2025-08-01' obligor: School District Number 172 obligor_canonical_id: 50926 optional_redemption_max_notice: 60 optional_redemption_min_notice: 30 optional_redemption_schedule: - call_date: '2032-02-01' call_price: spread_in_bps: 0 type: principal includes_accrued_interest: true is_periodic: true period_amount: 1 period_type: day until: null outstanding_amount: 240000 parent_isin: null previous_coupon_date: '2025-02-01' rating_group: investment_grade remarketing_agents: [] reserve_fund: false sale_type: competitive_sale sector: education seniority: senior series: General Obligation School Bonds, Series 2024 series_issued_amount: 6770000 source_of_repayment: General Obligation state: IL ticker: IL ADASCD 5 02/01/2035 trustees: [] underwriters: - Stifel, Nicolaus & Company, Incorporated use_categories: - primary and secondary education use_sectors: - education uses_of_proceeds: - public school district validation_errors: [] variable_rate_mode: null total: 1 schema: additionalProperties: false properties: data: description: List of response data objects, often capped to 1000. items: additionalProperties: false properties: advisors: description: >- Financial advisors who provide advice on bond issuance and investment. items: nullable: false type: string x-struct: null x-validate: null type: array x-struct: null x-validate: null award_date: description: >- Date the bond was awarded to the underwriter in ISO-8601 format (YYYY-MM-DD). format: date nullable: true type: string x-struct: null x-validate: null award_time: description: >- Time the bond was awarded to the underwriter, in US Eastern Time, in ISO-8601 format (HH:MM:SS). nullable: true type: string x-struct: null x-validate: null bond_counsel: description: >- Legal representatives retained by the issuer that provide tax opinions, ensure compliance with federal tax law, and verify the legal validity of the bond issuance. items: nullable: false type: string x-struct: null x-validate: null type: array x-struct: null x-validate: null capital_purpose: description: >- Indicates the capital purpose depending on whether the bond proceeds are used for new projects, to pay off prior bonds, or both. enum: - mixed - new money - refunding nullable: true type: string x-struct: null x-validate: null closing_date: description: >- Date the bond transaction closed in ISO-8601 format (YYYY-MM-DD). format: date nullable: false type: string x-struct: null x-validate: null composite_rating: description: Composite rating of the bond. nullable: true type: string x-struct: null x-validate: null counties: description: Counties of issuing entity, if applicable. example: - Adams items: nullable: false type: string x-struct: null x-validate: null nullable: true type: array x-struct: null x-validate: null country: description: > Country of issuing entity: - `United States of America`: Country of issue is United States of America. enum: - United States of America nullable: false type: string x-struct: null x-validate: null country_code: description: >- ISO 3166-1 alpha-2 country code (2-letter code) of the country of issue. maxLength: 2 minLength: 2 nullable: false type: string 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 coupon_payment_day: description: Day of the month when coupon payments are made. nullable: true type: integer x-struct: null x-validate: null coupon_payment_months: description: > Months when coupon payments are made (1-12). **Examples:** - `[2, 8]`: Coupon payments are made on February and August. items: maximum: 12 minimum: 1 nullable: true type: integer x-struct: null x-validate: null type: array x-struct: null x-validate: null credit_enhancement_type: description: >- Types of credit enhancement that provide additional security for the bond. items: description: >- Specifies the specific type of the credit enhancement. Set to `[]` if is_credit_enhanced is false enum: - appropriations_program - bond_insurance - capital_reserve_fund - debt_service_reserve_fund - federal_agency_guarantee - federal_guarantee - federal_mortgage_insurance - letter_of_credit - liquidity_facility - moral_obligation - pledged_assets - pledged_revenues - private_mortgage_insurance - state_aid_intercept_program - state_guarantee_program - state_mortgage_insurance - state_permanent_fund_program - surety_bond - third_party_guarantee nullable: false type: string x-struct: null x-validate: null type: array x-struct: null x-validate: null currency: description: > Currency in which the bond is denominated (3-letter ISO 4217 code). example: USD nullable: false type: string x-struct: null x-validate: null dated_date: description: >- Date from which interest starts accruing in ISO-8601 format (YYYY-MM-DD). format: date nullable: false type: string x-struct: null x-validate: null disclosure_counsel: description: >- Legal representatives retained by the issuer to provide advice on issuer disclosure obligations. items: nullable: false type: string x-struct: null x-validate: null type: array x-struct: null x-validate: null extraordinary_optional_redemption: additionalProperties: false description: >- Extraordinary optional redemption terms and conditions. nullable: false properties: circumstances_for_extraordinary_redemption: nullable: true type: string x-struct: null x-validate: null is_subject_to_extraordinary_redemption: type: boolean x-struct: null x-validate: null required: - circumstances_for_extraordinary_redemption - is_subject_to_extraordinary_redemption type: object x-struct: null x-validate: null figi: description: >- Financial Instrument Global Identifier (FIGI), a unique 12-character alphanumeric code for financial instruments. example: BBG01L7LZSL5 maxLength: 12 minLength: 12 nullable: true type: string x-struct: null x-validate: null figi_name: description: >- Name associated with the FIGI (Financial Instrument Global Identifier). nullable: true type: string x-struct: null x-validate: null first_call_date: description: >- Date of the first call option in ISO-8601 format (YYYY-MM-DD). format: date nullable: true type: string x-struct: null x-validate: null first_execution_date: description: >- Date of the first execution/trade for the bond in ISO-8601 format (YYYY-MM-DD). format: date nullable: true type: string x-struct: null x-validate: null first_execution_time: description: >- Time of the first execution/trade for the bond, in US Eastern Time, in ISO-8601 format (HH:MM:SS). nullable: true type: string x-struct: null x-validate: null first_interest_payment_date: description: >- Date of the first interest payment in ISO-8601 format (YYYY-MM-DD). format: date nullable: false type: string x-struct: null x-validate: null first_trade_date: description: >- Date of the first trade in the secondary market in ISO-8601 format (YYYY-MM-DD). format: date nullable: true type: string x-struct: null x-validate: null gas_prepay_guarantor: description: > Entity whose credit backstops return of prepayment proceeds on a prepaid gas or electricity municipal bond — the party obligated to return proceeds via scheduled payments or on early termination. `null` if not a prepaid energy structure. nullable: true type: string x-struct: null x-validate: null guarantee: description: >- Indicates the security classification of the bond. Secured bonds are backed by specific collateral (pledged assets, revenues, or reserve funds), while unsecured bonds lack such backing. enum: - secured - unsecured nullable: false type: string x-struct: null x-validate: null has_mandatory_redemption: description: | Whether the bond has mandatory redemption features. nullable: false type: boolean x-struct: null x-validate: null has_official_statement: description: > Whether the bond has an official statement published. Pre official statement bonds only have a limited set of fields available that are provided on a best-effort basis. nullable: false type: boolean x-struct: null x-validate: null insurers: description: >- Financial institutions that issue an insurance policy for bonds, guaranteeing timely payment of principal and interest. items: nullable: false type: string x-struct: null x-validate: null type: array x-struct: null x-validate: null integral_multiple: description: Integral multiple for bond denominations. nullable: false type: number x-struct: null x-validate: null interest_accrual_convention: description: > Day count convention for interest accrual: - `30/360`: 30 days per month, 360 days per year. - `ACTUAL/ACTUAL`: Uses actual number of days in period and year. - `ACTUAL/360`: Uses actual days in period, 360 days per year. - `ACTUAL/365`: Uses actual days in period, 365 days per year. - `30/365`: 30 days per month, 365 days per year. enum: - 30/360 - 30/365 - act/360 - act/365 - act/act - act/act (AFB) - act/act (ICMA) - act/act (ISDA) nullable: false 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: false type: string x-struct: null x-validate: null interest_maximum_rate: description: >- Maximum interest rate for variable rate bonds; the highest rate the bond's coupon can reach during its life, often set as a cap relative to the reference rate it is adjusted for. nullable: true type: number x-struct: null x-validate: null interest_minimum_rate: description: >- Minimum interest rate for variable rate bonds; the lowest rate the bond's coupon can fall to during its life, often set as a floor relative to the reference rate it is adjusted for. nullable: true type: number x-struct: null x-validate: null interest_payment_schedule: description: > The interest payment schedule specifies the schedule of interest payments, which may be periodic or deferred until maturity (for CABs, notes or deferred interest bonds). It is represented as an array of objects with the following schema: items: additionalProperties: false description: >- Schema for each interest payment date or period in the interest payment schedule. properties: interest_type: enum: - accreting - regular nullable: false type: string x-struct: null x-validate: null payment_date: nullable: false oneOf: - additionalProperties: false nullable: false properties: day: maximum: 31 minimum: -1 type: integer x-struct: null x-validate: null month: maximum: 12 minimum: 1 type: integer x-struct: null x-validate: null year: maximum: 2100 minimum: 1900 nullable: true type: integer x-struct: null x-validate: null required: - day - month - year type: object x-struct: null x-validate: null - additionalProperties: false properties: business_day: maximum: 23 minimum: 1 type: integer x-struct: null x-validate: null month: maximum: 12 minimum: 1 type: integer x-struct: null x-validate: null year: maximum: 2100 minimum: 1900 nullable: true type: integer x-struct: null x-validate: null required: - business_day - month - year type: object x-struct: null x-validate: null - additionalProperties: false properties: day_of_week: maximum: 7 minimum: 1 type: integer x-struct: null x-validate: null month: maximum: 12 minimum: 1 type: integer x-struct: null x-validate: null week_of_month: maximum: 5 minimum: 1 type: integer x-struct: null x-validate: null year: maximum: 2100 minimum: 1900 nullable: true type: integer x-struct: null x-validate: null required: - day_of_week - month - week_of_month - year type: object x-struct: null x-validate: null x-struct: null x-validate: null periodic_schedule: additionalProperties: false nullable: true properties: period_amount: type: integer x-struct: null x-validate: null period_type: enum: - month - week type: string x-struct: null x-validate: null until: format: date nullable: true type: string x-struct: null x-validate: null required: - period_amount - period_type - until type: object x-struct: null x-validate: null required: - interest_type - payment_date - periodic_schedule type: object x-struct: null x-validate: null maxItems: 20 nullable: true type: array x-struct: null x-validate: null interest_rate: description: > Interest rate or coupon of the bond, expressed as a percentage of the bond's face value. nullable: true oneOf: - nullable: true type: number x-struct: null x-validate: null - properties: benchmark: type: string x-struct: null x-validate: null pct_of_benchmark: nullable: true type: number x-struct: null x-validate: null spread_in_bps: nullable: true type: number x-struct: null x-validate: null type: object x-struct: null x-validate: null x-struct: null x-validate: null interest_rate_schedule: description: > The interest rate structure specifies the applicable interest rate for a given period and defines how it is set and adjusted over the bond’s term, including periodic adjustments for variable rate bonds. It is represented as an array of objects with the following schema: items: additionalProperties: false properties: determination_period: nullable: true properties: period_length: minimum: 1 type: integer x-struct: null x-validate: null period_type: enum: - day - month - week type: string x-struct: null x-validate: null required: - period_length - period_type type: object x-struct: null x-validate: null from_date: description: Can be null if it applies from issue format: date nullable: true type: string x-struct: null x-validate: null interest_rate: nullable: false oneOf: - description: >- Interest rate/accretion rate when it is a fixed or known number. The rate for capital appreciation bonds is sometimes cited as the yield to maturity. minimum: 0 type: number x-struct: null x-validate: null - description: >- Interest properties when it is a spread over a benchmark or determined by a calculation agent properties: benchmark: enum: - auction - cpi - federal-funds-rate - libor - mmd - remarketing-agent - sifma - sofr - treasury nullable: false type: string x-struct: null x-validate: null pct_of_benchmark: maximum: 300 minimum: 0 nullable: true type: number x-struct: null x-validate: null spread_in_bps: nullable: true type: number x-struct: null x-validate: null required: - benchmark - pct_of_benchmark - spread_in_bps type: object x-struct: null x-validate: null x-struct: null x-validate: null interest_type: enum: - compounding - fixed - variable - zero nullable: false type: string x-struct: null x-validate: null rate_mode_name: description: The name of the rate mode. enum: - 15-day - adjustable - auction - bank-purchase - bi-weekly - cpi - daily - fixed - flexible - floating - frn - index - libor - long-term - medium-term - monthly - multiannual - pass-through - permanent - quarterly - r-floats - remarketing-agent - reset - short-term - sifma - sofr - term - term-floater - two-day - unit_price - weekly - window nullable: true type: string x-struct: null x-validate: null until_date: description: >- Can be null if it applies until maturity. Range is exclusive, i.e. means until but not including. format: date nullable: true type: string x-struct: null x-validate: null required: - determination_period - from_date - interest_rate - interest_type - rate_mode_name - until_date type: object x-struct: null x-validate: >- Elixir.TpData.DocX.Fields.InterestRateSchedule.ItemLevelValidators nullable: true type: array x-struct: null x-validate: >- Elixir.TpData.DocX.Fields.InterestRateSchedule.ArrayLevelValidators interest_type: description: > The Type of interest: - `fixed rate`: The bond pays a fixed interest rate throughout its life. - `cab`: Capital Appreciation Bond (CAB), interest accrues and is paid at maturity rather than periodically. - `variable rate`: The bond's interest rate can change over time, typically based on a reference rate or formula (e.g., SOFR, CPI). - `term rate`: The bond pays interest at a rate set for a specific term or period. - `cab-to-fixed`: The bond starts as a capital appreciation bond and converts to a fixed rate bond. - `step rate`: The bond's interest rate increases ("steps up") at predetermined intervals. - `zero rate / discount rate`: A bond that does not pay or accrue interest. enum: - cab - cab-to-fixed - fixed rate - step rate - term rate - 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. nullable: false type: boolean x-struct: null x-validate: null is_amt: description: > Whether the bond is an Alternative Minimum Tax (AMT) bond. nullable: false type: boolean x-struct: null x-validate: null is_bab: description: | Whether the bond is a Build America Bond. nullable: false type: boolean x-struct: null x-validate: null is_bank_qualified: description: | Whether the bond is bank qualified. nullable: false type: boolean x-struct: null x-validate: null is_callable: description: | Whether the bond is callable before maturity. nullable: false type: boolean x-struct: null x-validate: null is_credit_enhanced: description: >- Indicates whether the bond is backed by any form of credit enhancement. nullable: false type: boolean x-struct: null x-validate: null is_defeased: description: > Whether the bond is defeased. A defeased bond has funds set aside in an escrow account to pay off the remaining principal and interest, effectively removing the debt obligation from the issuer's balance sheet. nullable: true type: boolean x-struct: null x-validate: null is_federally_taxable: description: | Whether the bond is federally taxable. nullable: false type: boolean x-struct: null x-validate: null is_green: description: | Whether the bond is a green bond. nullable: false type: boolean x-struct: null x-validate: null is_insured: description: > Whether the bond is insured by a bond insurance company. nullable: true type: boolean x-struct: null x-validate: null is_outstanding: description: | Whether the bond is currently outstanding. nullable: false type: boolean x-struct: null x-validate: null is_pac: description: > Whether the bond is a Planned Amortization Class (PAC) bond. nullable: false type: boolean x-struct: null x-validate: null is_regs: description: | Whether the bond is Regulation S (RegS) compliant. nullable: false type: boolean x-struct: null x-validate: null is_social: description: | Whether the bond is a social bond. nullable: false type: boolean x-struct: null x-validate: null is_state_enhanced: description: >- Indicates whether the bond is backed by any form of state credit enhancement (state guarantee program, state aid intercept program, appropriations program or state permanent fund program). nullable: false type: boolean x-struct: null x-validate: null is_state_taxable: description: | Whether the bond is state taxable. nullable: false type: boolean x-struct: null x-validate: null is_sustainable: description: | Whether the bond is a sustainable bond. nullable: false type: boolean x-struct: null x-validate: null isin: description: >- International Securities Identification Number (ISIN), unique 12-character code for the security. example: US64966HW301 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: false type: string x-struct: null x-validate: null issue_price: description: > Price at which the bond was issued (percentage of par), the price is expressed as a percentage of the bond's face value. nullable: true type: number x-struct: null x-validate: null issue_yield: description: > Yield at issuance, the yield is expressed as a percentage of the bond's face value. nullable: true type: number x-struct: null x-validate: null issued_amount: description: >- Total amount issued (face value) in the bond's currency. nullable: false type: number x-struct: null x-validate: null issuer_canonical_id: description: The internal unique identifier of the issuer. nullable: true type: integer x-struct: null x-validate: null issuer_name: description: >- Name of the issuing entity (municipality, district, etc.). example: School District Number 172 nullable: false type: string x-struct: null x-validate: null liquidity_facility: description: | Liquidity facility provider for the bond: - `LOC`: Letter of Credit - `SBPA`: Standby Bond Purchase Agreement - `Self`: Self-liquidity enum: - LOC - SBPA - Self nullable: true type: string x-struct: null x-validate: null mandatory_redemption_schedule: description: > The mandatory redemption schedule specifies the sinking fund redemptions, including the dates, amounts, and redemption prices based on principal or accreted value (for CABs). ```json [ { "date": "", "price": { "type": "principal | accreted-value", "spread_in_bps": "" }, "amount": "" }, ... ] ``` items: nullable: false properties: {} type: object x-struct: null x-validate: null type: array x-struct: null x-validate: null maturity_amount: description: > Amount due at maturity: The principal amount that will be repaid when the bond matures. nullable: true type: number 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 minimum_denomination: description: >- Minimum denomination in which the bond can be purchased. nullable: false type: number x-struct: null x-validate: null next_call_date: description: >- Date of the next call option in ISO-8601 format (YYYY-MM-DD). format: date nullable: true type: string x-struct: null x-validate: null next_call_price: description: >- Price at the nearest call date from today, if exists. nullable: true type: number x-struct: null x-validate: null next_coupon_date: description: >- Date of the next coupon payment in ISO-8601 format (YYYY-MM-DD). format: date nullable: true type: string x-struct: null x-validate: null next_sink_amount: description: >- Indicates the nearest sinking fund amount, if exists. nullable: true type: number x-struct: null x-validate: null next_sink_date: description: >- Date of the next sinking fund payment in ISO-8601 format (YYYY-MM-DD). format: date nullable: true type: string x-struct: null x-validate: null next_sink_price: description: Indicates the nearest sinking fund price, if exists. nullable: true type: number x-struct: null x-validate: null obligor: description: >- The obligated entity, when it is not the same as the issuer nullable: true type: string x-struct: null x-validate: null obligor_canonical_id: description: The internal unique identifier of the obligor. nullable: true type: integer x-struct: null x-validate: null odd_first_coupon: description: > Indicates whether the first coupon payment is odd: - `regular`: First coupon payment follows the standard interval. - `short`: First coupon period is shorter than the typical payment interval. - `long`: First coupon period is longer than the typical payment interval. enum: - long - regular - short nullable: true type: string x-struct: null x-validate: null odd_last_coupon: description: > Indicates whether the last coupon payment is odd: - `regular`: Last coupon payment follows the standard interval. - `short`: Last coupon period is shorter than the typical payment interval. - `long`: Last coupon period is longer than the typical payment interval. enum: - long - regular - short nullable: true type: string x-struct: null x-validate: null optional_redemption_max_notice: description: >- Maximum notice period for optional redemptions (in days). nullable: true type: integer x-struct: null x-validate: null optional_redemption_min_notice: description: >- Minimum notice period for optional redemptions (in days). nullable: true type: integer x-struct: null x-validate: null optional_redemption_schedule: description: > The optional redemption schedule defines the periods for which a bond is callable with a fixed, accreted value (for CABs) and make-whole price. It is represented as an array of objects with the following schema: ```json [ { "until": "", "call_date": "", "call_price": { "type": "principal | accreted-value | make-whole", "spread_in_bps": "", // spread above par for principal or accreted-value; spread above benchmark for make-whole "benchmark": "mmd | treasury" // benchmark only applies when it's make-whole }, "is_periodic": "true | false", "period_type": "day | month", "period_amount": "", // period_amount=1 and period_type="day" means continuously callable "includes_accrued_interest": "true | false" }, ... ] ``` items: nullable: false properties: {} type: object x-struct: null x-validate: null type: array x-struct: null x-validate: null outstanding_amount: description: Current outstanding amount of the bond. nullable: true type: number x-struct: null x-validate: null parent_isin: description: > ISIN of the parent bond, if this bond was created from a split or refunding. When bonds are split into multiple series or tranches, the parent_isin identifies the original bond from which this bond was derived. example: US64966HW302 maxLength: 12 minLength: 12 nullable: true type: string x-check: valid_check_digit x-check-error: Invalid ISIN check digit x-struct: null x-transform: upcase x-validate: null previous_coupon_date: description: >- Date of the previous coupon payment in ISO-8601 format (YYYY-MM-DD). format: date nullable: true type: string x-struct: null x-validate: null provider_expiration_date: description: >- Date when the provider's commitment expires in ISO-8601 format (YYYY-MM-DD). format: date nullable: true type: string x-struct: null x-validate: null provider_identity: description: > Name of the provider, typically for liquidity facilities or credit enhancements. nullable: true type: string x-struct: null x-validate: null rating_group: description: > Credit rating group: - `investment_grade`: Bonds with high credit quality, typically considered safe and low risk. - `high_yield`: Bonds with lower credit quality, typically considered riskier and higher yield. enum: - high_yield - investment_grade nullable: true type: string x-struct: null x-validate: null remarketing_agents: description: > A municipal securities dealer responsible for reselling to investors securities (such as variable rate demand obligations and other tender option bonds) that have been tendered for purchase by their owner. items: type: string x-struct: null x-validate: null nullable: false type: array x-struct: null x-validate: null reserve_fund: description: >- Indicates whether the bond is backed by a reserve fund (debt service reserve fund or capital reserve fund). nullable: false type: boolean x-struct: null x-validate: null sale_type: additionalProperties: false description: >- Indicates the method used by the issuer to sell the municipal bond to investors. enum: - competitive_sale - negotiated_sale - private_placement nullable: true type: string x-struct: null x-validate: null sector: description: > Sector of the municipal bond: - `education`: Educational institutions (schools, universities, colleges). - `local`: Local government entities (cities, counties, towns). - `utilities`: Utility companies and infrastructure. - `transportation`: Transportation and transit systems. - `state`: State government entities. - `healthcare`: Healthcare facilities and medical institutions. - `housing`: Housing and residential development. - `industrial`: Industrial and economic development. - `tobacco`: Tobacco settlement bonds. enum: - education - healthcare - housing - industrial - local - state - tobacco - transportation - utilities nullable: true type: string x-struct: null x-validate: null seniority: description: > Seniority of the bond derived from the series name, ordered from most senior to most junior. It's worth noting that senior is considered on par with first line, and subordinate is considered on par with junior. enum: - first_lien - junior - second_lien - senior - subordinate nullable: false type: string x-struct: null x-validate: null series: description: | Bond series name or description. example: General Obligation School Bonds, Series 2024 nullable: false type: string x-struct: null x-validate: null series_issued_amount: description: Amount issued in this specific series. nullable: true type: number x-struct: null x-validate: null source_of_repayment: description: > Source of repayment: - `General Obligation`: The bond is backed by the full faith and credit of the issuer. - `Revenue`: The bond is backed by the revenue generated from the project or service it funds. - `Double Barrel`: A combination of General Obligation and Revenue sources. enum: - Double Barrel - General Obligation - Revenue nullable: true type: string x-struct: null x-validate: null state: description: > US state or territory where the bond is issued (ANSI 2-letter code). example: IL maxLength: 2 minLength: 2 nullable: false type: string x-struct: null x-validate: null tender_agents: description: >- Financial institutions that facilitate the tender of bonds to the issuer, typically in variable rate demand obligations or other bonds with put features. items: nullable: false type: string x-struct: null x-validate: null type: array x-struct: null x-validate: null tender_schedule: description: > The schedule of tender for a bond, including the tender date, tender type, tender period, tender price, and circumstance for tender items: additionalProperties: false properties: circumstance_for_tender: enum: - credit or liquidity facility default - >- credit or liquidity facility expiration or substitution - extraordinary event - failed remarketing - in lieu of redemption - issuer or provider directed - optional tender - rate mode conversion - scheduled mandatory tender - unscheduled mandatory tender nullable: false type: string x-struct: null x-validate: null periodic_schedule: additionalProperties: false nullable: true properties: period_amount: type: integer x-struct: null x-validate: null period_type: enum: - day - month - week - year type: string x-struct: null x-validate: null until: format: date nullable: true type: string x-struct: null x-validate: null required: - period_amount - period_type - until type: object x-struct: null x-validate: null tender_date: format: date nullable: true type: string x-struct: null x-validate: null tender_price: additionalProperties: false nullable: true properties: spread_in_bps: maximum: 1000 minimum: 0 nullable: true type: number x-struct: null x-validate: null type: enum: - accreted-value - principal nullable: true type: string x-struct: null x-validate: null required: - spread_in_bps - type type: object x-struct: null x-validate: null tender_type: enum: - mandatory - optional nullable: false type: string x-struct: null x-validate: null required: - circumstance_for_tender - periodic_schedule - tender_date - tender_price - tender_type type: object x-struct: null x-validate: null maxItems: 20 nullable: true type: array x-struct: null x-validate: null ticker: description: Bond ticker symbol. example: IL ADASCD 5 02/01/2035 nullable: true type: string x-struct: null x-validate: null trustees: description: >- Financial institutions acting as intermediaries between bond issuers and bondholders, appointed by the issuer to represent bondholders' interests and enforce the terms of the bond's governing contract. items: nullable: false type: string x-struct: null x-validate: null type: array x-struct: null x-validate: null underwriters: description: >- Financial institutions that facilitate the issuance and sale of bonds by purchasing them from the issuer and reselling them to investors. items: nullable: false type: string x-struct: null x-validate: null type: array x-struct: null x-validate: null upcoming_corporate_action: description: > The next anticipated corporate action event for the bond. nullable: true properties: date: format: date nullable: false type: string x-struct: null x-validate: null type: enum: - bond_call - defeasance - redemption - refunding nullable: false type: string x-struct: null x-validate: null type: object x-struct: null x-validate: null use_categories: description: > Broad functional categories for bond proceeds (middle level). This is the middle level in the use of funds hierarchy: **Use Sector > Use Category > Uses of Proceeds** Categories group related uses of proceeds together. There are 31 categories across 10 sectors. For the complete taxonomy, see the [Use of Funds Taxonomy](https://docs.terrapinfinance.com/use_of_funds_taxonomy) reference page. items: enum: - airport - bridges - communication - culture - economic development - electrical - essential services - gas - gas prepay - general purpose - health system - higher education - hospitals - industrial development - military housing - miscellaneous - multi-family housing - parking - port - power - pre-school - primary and secondary education - public housing - public transit - recreational - roads - senior living - single family housing - student loan - waste removal - water and sewer nullable: false type: string x-struct: null x-validate: null maxItems: 5 minItems: 1 nullable: true type: array x-struct: null x-validate: null use_sectors: description: > High-level sectors for bond proceeds (top level). This is the top level in the use of funds hierarchy: **Use Sector > Use Category > Uses of Proceeds** Sectors are the broadest classification, grouping multiple categories. There are 10 sectors in total. For the complete taxonomy, see the [Use of Funds Taxonomy](https://docs.terrapinfinance.com/use_of_funds_taxonomy) reference page. items: enum: - development - education - government - healthcare - housing - miscellaneous - recreation - securitized - transportation - utility nullable: false type: string x-struct: null x-validate: null minItems: 1 nullable: true type: array x-struct: null x-validate: null uses_of_proceeds: description: > Specific intended purposes for bond proceeds (most granular level). This is the most detailed level in the use of funds hierarchy: **Use Sector > Use Category > Uses of Proceeds** For the complete taxonomy with all 90 uses of proceeds, see the [Use of Funds Taxonomy](https://docs.terrapinfinance.com/use_of_funds_taxonomy) reference page. items: enum: - airport - alternative source power - assisted living - broadband - buses - charter school - coal power - combined port authority - community centre - community college - continuing care retirement community - correctional facilities - courts - critical access hospital - development district - electrical infrastructure - ferries - fire - flood control - gas infrastructure - gas power - gas prepay - health system - hospitality - independent living - industrial development - irrigation - library - local hfa multi-family housing - local hfa single family housing - local standalone multi-family housing - local standalone single family housing - military housing - miscellaneous - museum - non-toll bridges - non-toll roads - nuclear power - nursing home - office buildings - parking facilities - parks - police - pollution control - pre-school and daycare - private college - public buildings - public college - public housing - public school district - regional toll bridges - regional toll roads - sewer - shopping centres - solar power - specialty hospital - stadium - standalone hospital - standalone port - standalone public school - state hfa multi-family housing - state hfa single family housing - state toll bridges - state toll roads - storm water - student housing - student loan - telephone - trains - tribal - waste removal - water - wind power maxItems: 5 minItems: 1 nullable: false type: string x-struct: null x-validate: null nullable: true type: array x-struct: null x-validate: null validation_errors: description: > A list of known data issues for the bond where validation rules have failed. ```json [ { "details": "null_coupon_frequency", "field_names": ["coupon_frequency"] }, ... ] ``` items: additionalProperties: false nullable: false properties: details: nullable: false type: string x-struct: null x-validate: null field_names: items: nullable: false type: string x-struct: null x-validate: null nullable: false type: array x-struct: null x-validate: null required: - details type: object x-struct: null x-validate: null nullable: false type: array x-struct: null x-validate: null variable_rate_adjustment_schedule: description: > Schedule for when variable interest rates are adjusted. Specifies the frequency at which the bond's variable interest rate is reset or recalculated based on a reference rate or index. nullable: true properties: period_length: minimum: 1 type: integer x-struct: null x-validate: null period_type: enum: - day - month - week type: string x-struct: null x-validate: null type: object x-struct: null x-validate: null variable_rate_mode: description: | Variable rate mode for the bond, if applicable. enum: - 15-day - adjustable - auction - bank-purchase - bi-weekly - cpi - daily - fixed - flexible - floating - frn - index - libor - long-term - medium-term - monthly - multiannual - pass-through - permanent - quarterly - r-floats - remarketing-agent - reset - short-term - sifma - sofr - term - term-floater - two-day - unit_price - weekly - window nullable: true type: string x-struct: null x-validate: null required: - advisors - award_date - award_time - bond_counsel - capital_purpose - closing_date - composite_rating - counties - country - country_code - coupon_frequency - coupon_payment_day - coupon_payment_months - credit_enhancement_type - currency - dated_date - disclosure_counsel - extraordinary_optional_redemption - figi - figi_name - first_call_date - first_execution_date - first_execution_time - first_interest_payment_date - first_trade_date - gas_prepay_guarantor - guarantee - has_mandatory_redemption - has_official_statement - insurers - integral_multiple - interest_accrual_convention - interest_accrual_date - interest_maximum_rate - interest_minimum_rate - interest_payment_schedule - interest_rate - interest_rate_schedule - interest_type - is_144a - is_amt - is_bab - is_bank_qualified - is_callable - is_credit_enhanced - is_defeased - is_federally_taxable - is_green - is_insured - is_outstanding - is_pac - is_regs - is_social - is_state_enhanced - is_state_taxable - is_sustainable - isin - issue_date - issue_price - issue_yield - issued_amount - issuer_canonical_id - issuer_name - liquidity_facility - mandatory_redemption_schedule - maturity_amount - maturity_date - minimum_denomination - next_call_date - next_call_price - next_coupon_date - next_sink_amount - next_sink_date - next_sink_price - obligor - obligor_canonical_id - odd_first_coupon - odd_last_coupon - optional_redemption_max_notice - optional_redemption_min_notice - optional_redemption_schedule - outstanding_amount - parent_isin - previous_coupon_date - provider_expiration_date - provider_identity - rating_group - remarketing_agents - reserve_fund - sale_type - sector - seniority - series - series_issued_amount - source_of_repayment - state - tender_agents - tender_schedule - ticker - trustees - underwriters - upcoming_corporate_action - use_categories - use_sectors - uses_of_proceeds - validation_errors - variable_rate_adjustment_schedule - variable_rate_mode 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: MuniReferenceResponse 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 ````