Tmx Bond Trades
Implementation details
Class names
| Model name | Parameters class | Data class |
|---|---|---|
TmxBondTrades | TmxBondTradesQueryParams | TmxBondTradesData |
Import Statement
from openbb_core.provider.standard_models. import (
TmxBondTradesData,
TmxBondTradesQueryParams,
)
Parameters
- standard
- tmx
country: str | None
The country to get data. Matches partial name.
isin: str | None
ISIN of the bond.
issuer_type: str | None
Type of bond issuer.
notional_currency: str | None
Description
Currency of the bond, which might differ from the currency of the trade.
Formatted as the 3-letter ISO 4217 code (e.g. GBP, EUR, USD).
start_date: date | str | None | str
Start date of the data, in YYYY-MM-DD format. YYYY-MM-DD or ISO-8601 format. E.g. 2023-01-14T10:55:00Z
end_date: date | str | None | str
End date of the data, in YYYY-MM-DD format. YYYY-MM-DD or ISO-8601 format. E.g. 2023-01-14T10:55:00Z
country: str | None
The country to get data. Matches partial name.
isin: str | None
ISIN of the bond.
issuer_type: str | None
Type of bond issuer.
notional_currency: str | None
Description
Currency of the bond, which might differ from the currency of the trade.
Formatted as the 3-letter ISO 4217 code (e.g. GBP, EUR, USD).
start_date: date | str | None | str
Start date of the data, in YYYY-MM-DD format. YYYY-MM-DD or ISO-8601 format. E.g. 2023-01-14T10:55:00Z
end_date: date | str | None | str
End date of the data, in YYYY-MM-DD format. YYYY-MM-DD or ISO-8601 format. E.g. 2023-01-14T10:55:00Z
cusip: str | None
CUSIP of the bond. One of cusip, isin, or figi is required.
figi: str | None
FIGI of the bond.
account_type: str | None
Default: all
Restrict to trades booked to one account type.
use_cache: bool | None
Default: True
Whether to use the on-disk bond master. Set to False to bypass.
Data
- standard
- tmx
trade_date: date | datetime | None
Date of the transaction.
isin: str | None
ISIN of the bond.
figi: str | None
FIGI of the bond.
cusip: str | None
CUSIP of the bond.
price: float | None
Price of the bond.
current_yield: float | None
Current yield of the bond.
coupon_rate: float | None
Coupon rate of the bond.
volume: int | None
The trading volume.
trade_date: datetime | None
Execution date and time of the trade.
isin: str | None
ISIN of the bond.
figi: str | None
FIGI of the bond.
cusip: str | None
CUSIP of the bond.
price: float | None
Price of the bond.
current_yield: float | None
Current yield of the bond.
coupon_rate: float | None
Coupon rate of the bond.
volume: int | None
The trading volume.
settlement_date: date | None
Settlement date of the trade.
issuer: str | None
The issuer of the bond.
maturity_date: date | None
Maturity date of the bond.
transaction_type: str | None
The type of transaction reported.
account_type: str | None
The account type the trade was booked to.
commission: bool | None
Whether a commission was charged.
volume_capped: bool | None
Whether the reported volume is capped at the disclosure limit.
reported_date: date | None
The date the trade was submitted to CIRO, which is later than the execution date when a trade is reported late or amended.
record_id: str | None
CIRO's unique identifier for the trade record.