state_survey

Get a Richmond Fed Fifth District state business survey.

Examples

from openbb import obb
obb.federal_reserve.richmond.state_survey(provider='federal_reserve')
# Get the Carolinas survey.
obb.federal_reserve.richmond.state_survey(state='carolinas', provider='federal_reserve')

Parameters

• standard
• federal_reserve

state: str | None
Default: virginia
The Fifth District jurisdiction survey to retrieve.

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: FederalReserveRichmondStateSurvey

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 survey month.

adjustment: str | None
The seasonal adjustment (NSA or SA).

horizon: str | None
Current conditions or six-month-ahead expectations.