Primary Dealer Positioning
Implementation details
Class names
Model name | Parameters class | Data class |
---|---|---|
PrimaryDealerPositioning | PrimaryDealerPositioningQueryParams | PrimaryDealerPositioningData |
Import Statement
from openbb_core.provider.standard_models.primary_dealer_positioning import (
PrimaryDealerPositioningData,
PrimaryDealerPositioningQueryParams,
)
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 |
category | Literal['treasuries', 'bills', 'coupons', 'notes', 'tips', 'mbs', 'cmbs', 'municipal', 'corporate', 'commercial_paper', 'corporate_ig', 'corporate_junk', 'abs'] | The category of asset to return, defaults to 'treasuries'. | treasuries | 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. |
value | int | The reported value of the net position (long - short), in millions of $USD. |
name | str | Short name for the series. |
title | str | Title of the series. |