consumer_housing

Get the New York Fed SCE Housing Survey across all topics.

Examples

from openbb import obb
obb.federal_reserve.ny.consumer_housing(provider='federal_reserve')
# Get expected mortgage rate perceptions by demographics.
obb.federal_reserve.ny.consumer_housing(topic='rate_perceptions_demo', provider='federal_reserve')

Parameters

• standard
• federal_reserve

topic: str | None
Default: home_price_expectations
The housing survey topic sheet. Topics ending in '_demo' break the series down by respondent demographics; '_distr' topics give the distribution of responses.

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

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.