state_coincident_index
Get the Philadelphia Fed State Coincident Indexes.
Examples
from openbb import obb
obb.federal_reserve.philadelphia.state_coincident_index(provider='federal_reserve')
# Get a single state's coincident index.
obb.federal_reserve.philadelphia.state_coincident_index(state='PA', provider='federal_reserve')
# Get the diffusion of state-index increases.
obb.federal_reserve.philadelphia.state_coincident_index(dataset='diffusion', provider='federal_reserve')
Parameters
- standard
- federal_reserve
dataset: str | None
Default: indexes
The per-state coincident indexes, or the one- and three-month diffusion of state index increases.
state: str | None
Filter to a single series; for 'indexes' a two-letter state code (e.g. 'PA') or 'US', for 'diffusion' a code ('DI1' or 'DI3').
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.
Returns
results: FederalReservePhiladelphiaCoincident
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 month, as a month-start date.
state: str
The two-letter state code or 'US', or the diffusion-series code ('DI1' or 'DI3').
value: float | None
The index value.