Finra Bond List

---

Implementation details

Class names

Model name	Parameters class	Data class
FinraBondList	FinraBondListQueryParams	FinraBondListData

Import Statement

from openbb_core.provider.standard_models. import (
FinraBondListData,
FinraBondListQueryParams,
)

Parameters

• standard
• finra

bond_type: str | None
Default: CA
The TRACE product - CA (corporate and agency), TS (U.S. Treasury), TBA, MBS, ABS, or CMO.

include_matured: bool | None
Default: False
Include the bonds that have matured.

Data

• standard
• finra

isin: str | None
International Securities Identification Number of the bond.

lei: str | None
Legal Entity Identifier of the issuing entity.

figi: str | None
FIGI of the bond.

cusip: str | None
CUSIP of the bond.

coupon_rate: float | None
Coupon rate of the bond.

price: float | None
Price of the bond.

current_yield: float | None
Current yield of the bond.

ytm: float | None
Yield to maturity of the bond.

ytw: float | None
Yield to worst of the bond.

duration: float | None
Duration of the bond.

maturity_date: date | None
Maturity date of the bond.

call_date: date | None
The nearest call date of the bond.

isin: str | None
International Securities Identification Number of the bond.

lei: str | None
Legal Entity Identifier of the issuing entity.

figi: str | None
FIGI of the bond.

cusip: str | None
CUSIP of the bond.

coupon_rate: float | None
The coupon rate of the bond, as a percent.

price: float | None
The price of the last reported sale.

current_yield: float | None
Current yield of the bond.

ytm: float | None
Yield to maturity of the bond.

ytw: float | None
Yield to worst of the bond.

duration: float | None
Duration of the bond.

maturity_date: date | None
Maturity date of the bond.

call_date: date | None
The nearest call date of the bond.

bond_type: str
The TRACE product of the bond - Corporate & Agency, U.S. Treasury, To-Be-Announced MBS, Mortgage-Backed, Asset-Backed, or Collateralized Mortgage Obligations.

symbol: str | None
The FINRA symbol of the bond.

finra_security_id: str | None
The FINRA security identifier.

issuer_name: str | None
The name of the issuer.

issuing_agency: str | None
The issuing agency, or trust, of the security.

issue_description: str | None
The description of the issue.

security_description: str | None
The description of the security.

product_type: str | None
The product type.

product_sub_type: str | None
The product sub-type code.

sub_product_type: str | None
The sub-product type.

coupon_type: str | None
The coupon type.

interest_type: str | None
The interest type code of an asset-backed tranche.

is_perpetual: bool | None
Whether the bond has no maturity date.

is_callable: bool | None
Whether the bond is callable.

is_convertible: bool | None
Whether the bond is convertible.

is_144a: bool | None
Whether the bond is a Rule 144A security.

industry_group: str | None
The industry group of the issuer.

grade: str | None
The TRACE grade - investment grade or high yield.

moodys_rating: str | None
The Moody's rating.

moodys_rating_date: date | None
The date of the Moody's rating.

sp_rating: str | None
The S&P rating.

sp_rating_date: date | None
The date of the S&P rating.

benchmark_term: str | None
The benchmark term of a Treasury security.

price_type: str | None
How the last sale was priced - Decimal, Yield, or Negative Yield.

last_sale_yield: float | None
The yield of the last reported sale, as a percent.

last_trade_date: date | None
The date of the last reported sale.

last_trade_time: str | None
The time of the last reported sale.

price_change: float | None
The change in the last sale price.

price_change_percent: float | None
The change in the last sale price, as a percent.

settlement_month: str | None
The settlement month of a TBA contract.

pool_number: str | None
The pool number of a mortgage-backed security.

reference_data_id: str | None
The reference data identifier of the pool.

mortgage_product: str | None
The mortgage product code.

amortization_type: str | None
The amortization type code.

original_maturity_term: float | None
The original maturity term of the pool, in months.

weighted_average_coupon: float | None
The weighted average coupon of the pool, as a percent.

weighted_average_maturity: float | None
The weighted average maturity of the pool, in months.

weighted_average_loan_age: float | None
The weighted average loan age of the pool, in months.

loan_to_value: float | None
The loan-to-value ratio of the pool, as a percent.

average_loan_size: float | None
The average loan size of the pool.

deal_id: str | None
The deal identifier.

tranche_id: str | None
The tranche identifier.