Primary Dealer Fails
Implementation details
Class names
Model name | Parameters class | Data class |
---|---|---|
PrimaryDealerFails | PrimaryDealerFailsQueryParams | PrimaryDealerFailsData |
Import Statement
from openbb_core.provider.standard_models.primary_dealer_fails import (
PrimaryDealerFailsData,
PrimaryDealerFailsQueryParams,
)
Parameters
- standard
- federal_reserve
Name | Type | Description | Default | Optional |
---|---|---|---|---|
start_date | Union[date, str] | Start date of the data, in YYYY-MM-DD format. | None | True |
end_date | Union[date, str] | End date of the data, in YYYY-MM-DD format. | None | True |
Name | Type | Description | Default | Optional |
---|---|---|---|---|
start_date | Union[date, str] | Start date of the data, in YYYY-MM-DD format. | None | True |
end_date | Union[date, str] | End date of the data, in YYYY-MM-DD format. | None | True |
asset_class | Literal['all', 'treasuries', 'tips', 'agency', 'mbs', 'corporate'] | Asset class to return, default is 'all'. | all | True |
unit | Literal['value', 'percent'] | 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. | value | True |
Data
- standard
- federal_reserve
Name | Type | Description |
---|---|---|
date | Union[date, str] | The date of the data. |
symbol | str | Symbol representing the entity requested in the data. |
Name | Type | Description |
---|---|---|
date | Union[date, str] | The date of the data. |
symbol | str | Symbol representing the entity requested in the data. |
title | str | Title of the series' symbol. |
value | Union[int, float] | Value of the data returned, in millions of USD if the unit parameter is 'value' else a normalized percent. |