series
Fetch BLS time series data by series identifier.
Examples
from openbb import obb
# Fetch a single series by symbol from the BLS API.
obb.bls.series(provider='bls', symbol='CUUR0000SA0')
# Fetch multiple series with calculations enabled.
obb.bls.series(provider='bls', symbol='CUUR0000SA0,WPUFD4', calculations=True)
Parameters
- standard
- bls
symbol: str | list[str]
Symbol to get data for. Multiple items allowed for provider(s): bls.
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.
symbol: str | list[str]
Symbol to get data for. Multiple items allowed for provider(s): bls.
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.
category: str | None
Default: cpi
Survey category that scopes the symbol picker's choices. Does not filter the returned data (series are fetched by symbol); keep it in sync with the Search widget to drill down by clicking.
calculations: bool | None
Default: True
Include calculations in the response, if available. Default is True.
annual_average: bool | None
Default: False
Include annual averages in the response, if available. Default is False.
aspects: bool | None
Default: False
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.
Returns
results: BlsSeries
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
- bls
date: date | str
The date of the data.
symbol: str
Symbol representing the entity requested in the data.
title: str | None
Title of the series.
value: float | None
Observation value for the symbol and date.
date: date | str
Observation date.
symbol: str
BLS series identifier.
title: str | None
Title of the series.
value: float | None
Observation value for the symbol and date.
change_1M: float | None
One month change in value.
change_3M: float | None
Three month change in value.
change_6M: float | None
Six month change in value.
change_12M: float | None
One year change in value.
change_percent_1M: float | None
One month change in percent.
change_percent_3M: float | None
Three month change in percent.
change_percent_6M: float | None
Six month change in percent.
change_percent_12M: float | None
One year change in percent.
latest: bool | None
Latest value indicator.
footnotes: str | None
Footnotes accompanying the value.