market_expectations

Get the New York Fed Survey of Market Expectations results data.

Examples

from openbb import obb
obb.federal_reserve.ny.market_expectations(provider='federal_reserve')
# Return only the combined panel.
obb.federal_reserve.ny.market_expectations(panel_type='Combined', provider='federal_reserve')

Parameters

• standard
• federal_reserve

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.

panel_type: str | None
Filter to a single respondent panel.

---

Returns

results: FederalReserveNewYorkMarketExpectations

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 release date.

survey_due_date: date | None
The date responses were due.

panel_type: str | None
The respondent panel: 'Combined', 'Dealer', or 'Participant'.

question_number: str | None
The survey question number.

theme: str | None
The question theme.

subject_group: str | None
The question subject group.

subject: str | None
The question subject.

question_type: str | None
The question type, e.g. 'probability' or 'point'.

question_mode: str | None
The question mode, e.g. 'levels' or 'change'.

question_text: str | None
The full question text.

question_tag: str | None
The machine-readable question identifier.

value_tag: str | None
The machine-readable value identifier.

top_header_value: str | None
The top header label for a matrix question cell.

left_header_value: str | None
The left header label for a matrix question cell.

horizon: str | None
The forecast horizon, e.g. '6months'.

horizon_date: date | None
The date the horizon resolves to.

bucket_range: str | None
The response bucket range label.

bucket_low: float | None
The lower bound of the response bucket.

bucket_high: float | None
The upper bound of the response bucket.

aggregation: str | None
The aggregation statistic, e.g. 'avg', 'count', or 'pctl50'.

aggregation_value: float | None
The aggregated response value.