Tmx Bond Prices
Implementation details
Class names
| Model name | Parameters class | Data class |
|---|---|---|
TmxBondPrices | TmxBondPricesQueryParams | TmxBondPricesData |
Import Statement
from openbb_core.provider.standard_models. import (
TmxBondPricesData,
TmxBondPricesQueryParams,
)
Parameters
- standard
- tmx
country: str | None
The country to get data. Matches partial name.
issuer_name: str | None
Name of the issuer. Returns partial matches and is case insensitive.
isin: list | str | None | list[list | str | None]
International Securities Identification Number(s) of the bond(s). Multiple items allowed for provider(s): tmx.
lei: str | None
Legal Entity Identifier of the issuing entity.
currency: list | str | None
Currency of the bond. Formatted as the 3-letter ISO 4217 code (e.g. GBP, EUR, USD).
coupon_min: float | None
Minimum coupon rate of the bond.
coupon_max: float | None
Maximum coupon rate of the bond.
issued_amount_min: int | None
Minimum issued amount of the bond.
issued_amount_max: str | None
Maximum issued amount of the bond.
maturity_date_min: date | None
Minimum maturity date of the bond.
maturity_date_max: date | None
Maximum maturity date of the bond.
country: str | None
The country to get data. Matches partial name.
issuer_name: str | None
Name of the issuer. Returns partial matches and is case insensitive.
isin: list | str | None | list[list | str | None]
International Securities Identification Number(s) of the bond(s). Multiple items allowed for provider(s): tmx.
lei: str | None
Legal Entity Identifier of the issuing entity.
currency: list | str | None
Currency of the bond. Formatted as the 3-letter ISO 4217 code (e.g. GBP, EUR, USD).
coupon_min: float | None
Minimum coupon rate of the bond.
coupon_max: float | None
Maximum coupon rate of the bond.
issued_amount_min: int | None
Minimum issued amount of the bond.
issued_amount_max: str | None
Maximum issued amount of the bond.
maturity_date_min: date | None
Minimum maturity date of the bond.
maturity_date_max: date | None
Maximum maturity date of the bond.
issue_date_min: date | None
Filter by the minimum original issue date.
issue_date_max: date | None
Filter by the maximum original issue date.
last_traded_min: date | None
Filter by the minimum last trade date.
use_cache: bool | None
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.
Data
- standard
- tmx
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.
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.
ytm: float | None
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 | None
The last price for the bond.
highest_price: float | None
The highest price for the bond on the last traded date.
lowest_price: float | None
The lowest price for the bond on the last traded date.
total_trades: int | None
Total number of trades on the last traded date.
last_traded_date: date | None
Last traded date of the bond.
maturity_date: date | None
Maturity date of the bond.
issue_date: date | None
Issue date of the bond. This is the date when the bond first accrues interest.
issuer_name: str | None
Name of the issuing entity.