Bls Series
Implementation details
Class names
Model name | Parameters class | Data class |
---|---|---|
BlsSeries | BlsSeriesQueryParams | BlsSeriesData |
Import Statement
from openbb_core.provider.standard_models. import (
BlsSeriesData,
BlsSeriesQueryParams,
)
Parameters
- standard
- bls
Name | Type | Description | Default | Optional |
---|---|---|---|---|
symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): bls. | False | |
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 |
---|---|---|---|---|
symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): bls. | False | |
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 |
calculations | bool | Include calculations in the response, if available. Default is True. | True | True |
annual_average | bool | Include annual averages in the response, if available. Default is False. | False | True |
aspects | bool | Include all aspects associated with a data point for a given BLS series ID, if available. Returned with the series metadata, under extras of the response object. Default is False. | False | True |
Data
- standard
- bls
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. |
value | float | Observation value for the symbol and date. |
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. |
value | float | Observation value for the symbol and date. |
change_1M | float | One month change in value. |
change_3M | float | Three month change in value. |
change_6M | float | Six month change in value. |
change_12M | float | One year change in value. |
change_percent_1M | float | One month change in percent. |
change_percent_3M | float | Three month change in percent. |
change_percent_6M | float | Six month change in percent. |
change_percent_12M | float | One year change in percent. |
latest | bool | Latest value indicator. |
footnotes | str | Footnotes accompanying the value. |