primary_dealer_fails
Get Primary Dealer Statistics for Fails to Deliver and Fails to Receive.
Examples
from openbb import obb
obb.federal_reserve.ny.primary_dealer_fails(provider='federal_reserve')
# Transform the data to be percentage totals by asset class.
obb.federal_reserve.ny.primary_dealer_fails(provider='federal_reserve', unit='percent')
Parameters
- standard
- federal_reserve
start_date: date | None | str
Start date of the data, in YYYY-MM-DD format.
end_date: date | None | str
End date of the data, in YYYY-MM-DD format.
start_date: date | None | str
Start date of the data, in YYYY-MM-DD format.
end_date: date | None | str
End date of the data, in YYYY-MM-DD format.
asset_class: str | None
Default: all
Asset class to return, default is 'all'.
Choices
- all
- treasuries
- tips
- agency
- mbs
- corporate
unit: str | None
Default: value
Unit of the data returned to the 'value' field. Default is 'value', which represents millions of USD. 'percent' returns data as the percentage of the total fails-to-receive and fails-to-deliver, by asset class.
Choices
- value
- percent
Returns
results: FederalReservePrimaryDealerFails
Serializable results.
provider: str | None
Provider name.
warnings: Optional[list[Warning_]]
List of warnings.
chart: Optional[Chart]
Chart object.
extra: dict[str, Any]
Extra info.
Data
- standard
- federal_reserve
date: date | str
The observation date.