bond_prices
Corporate Bond Prices.
Examples
from openbb import obb
obb.fixedincome.corporate.bond_prices(provider='tmx')
Parameters
- standard
- tmx
country: str
The country to get data. Matches partial name.
issuer_name: str
Name of the issuer. Returns partial matches and is case insensitive.
isin: Union[Union[list, str], list[Union[list, str]]]
International Securities Identification Number(s) of the bond(s). Multiple items allowed for provider(s): tmx.
lei: str
Legal Entity Identifier of the issuing entity.
currency: Union[list, str]
Currency of the bond. Formatted as the 3-letter ISO 4217 code (e.g. GBP, EUR, USD).
coupon_min: float
Minimum coupon rate of the bond.
coupon_max: float
Maximum coupon rate of the bond.
issued_amount_min: int
Minimum issued amount of the bond.
issued_amount_max: str
Maximum issued amount of the bond.
maturity_date_min: date
Minimum maturity date of the bond.
maturity_date_max: date
Maximum maturity date of the bond.
country: str
The country to get data. Matches partial name.
issuer_name: str
Name of the issuer. Returns partial matches and is case insensitive.
isin: Union[Union[list, str], list[Union[list, str]]]
International Securities Identification Number(s) of the bond(s). Multiple items allowed for provider(s): tmx.
lei: str
Legal Entity Identifier of the issuing entity.
currency: Union[list, str]
Currency of the bond. Formatted as the 3-letter ISO 4217 code (e.g. GBP, EUR, USD).
coupon_min: float
Minimum coupon rate of the bond.
coupon_max: float
Maximum coupon rate of the bond.
issued_amount_min: int
Minimum issued amount of the bond.
issued_amount_max: str
Maximum issued amount of the bond.
maturity_date_min: date
Minimum maturity date of the bond.
maturity_date_max: date
Maximum maturity date of the bond.
issue_date_min: date
Filter by the minimum original issue date.
issue_date_max: date
Filter by the maximum original issue date.
last_traded_min: date
Filter by the minimum last trade date.
use_cache: bool
Default: True
All bond data is sourced from a single JSON file that is updated daily. The file is cached for one day to eliminate downloading more than once. Caching will significantly speed up subsequent queries. To bypass, set to False.
Returns
results: list[BondPrices]
Serializable results.
provider: Optional[Literal['tmx']]
Provider name.
warnings: Optional[list[Warning_]]
list of warnings.
chart: Optional[Chart]
Chart object.
extra: dict[str, Any]
Extra info.
Data
- standard
- tmx
isin: str
International Securities Identification Number of the bond.
lei: str
Legal Entity Identifier of the issuing entity.
figi: str
FIGI of the bond.
cusip: str
CUSIP of the bond.
coupon_rate: float
Coupon rate of the bond.
isin: str
International Securities Identification Number of the bond.
lei: str
Legal Entity Identifier of the issuing entity.
figi: str
FIGI of the bond.
cusip: str
CUSIP of the bond.
coupon_rate: float
Coupon rate of the bond.
ytm: float
Yield to maturity (YTM) is the rate of return anticipated on a bond if it is held until the maturity date. It takes into account the current market price, par value, coupon rate and time to maturity. It is assumed that all coupons are reinvested at the same rate. Values are returned as a normalized percent.
price: float
The last price for the bond.
highest_price: float
The highest price for the bond on the last traded date.
lowest_price: float
The lowest price for the bond on the last traded date.
total_trades: int
Total number of trades on the last traded date.
last_traded_date: date
Last traded date of the bond.
maturity_date: date
Maturity date of the bond.
issue_date: date
Issue date of the bond. This is the date when the bond first accrues interest.
issuer_name: str
Name of the issuing entity.