|
6 | 6 | from .models.economy import ( |
7 | 7 | FedInflation, |
8 | 8 | TreasuryYield, |
| 9 | + FedInflationExpectations, |
9 | 10 | ) |
10 | 11 | from .models.common import Sort, Order |
11 | 12 | from .models.request import RequestOptionBuilder |
@@ -85,3 +86,44 @@ def list_inflation( |
85 | 86 | deserializer=FedInflation.from_dict, |
86 | 87 | options=options, |
87 | 88 | ) |
| 89 | + |
| 90 | + def list_inflation_expectations( |
| 91 | + self, |
| 92 | + date: Optional[Union[str, date]] = None, |
| 93 | + date_any_of: Optional[str] = None, |
| 94 | + date_gt: Optional[Union[str, date]] = None, |
| 95 | + date_gte: Optional[Union[str, date]] = None, |
| 96 | + date_lt: Optional[Union[str, date]] = None, |
| 97 | + date_lte: Optional[Union[str, date]] = None, |
| 98 | + limit: Optional[int] = None, |
| 99 | + sort: Optional[Union[str, Sort]] = None, |
| 100 | + params: Optional[Dict[str, Any]] = None, |
| 101 | + raw: bool = False, |
| 102 | + options: Optional[RequestOptionBuilder] = None, |
| 103 | + ) -> Union[Iterator[FedInflationExpectations], HTTPResponse]: |
| 104 | + """ |
| 105 | + A table tracking inflation expectations from both market-based and economic model perspectives across different time horizons. |
| 106 | +
|
| 107 | + :param date: Calendar date of the observation (YYYY-MM-DD). |
| 108 | + :param date_any_of: Filter equal to any of the values. Multiple values can be specified by using a comma separated list. |
| 109 | + :param date_gt: Filter greater than the value. |
| 110 | + :param date_gte: Filter greater than or equal to the value. |
| 111 | + :param date_lt: Filter less than the value. |
| 112 | + :param date_lte: Filter less than or equal to the value. |
| 113 | + :param limit: Limit the maximum number of results returned. Defaults to '100' if not specified. The maximum allowed limit is '50000'. |
| 114 | + :param sort: A comma separated list of sort columns. For each column, append '.asc' or '.desc' to specify the sort direction. The sort column defaults to 'date' if not specified. The sort order defaults to 'asc' if not specified. |
| 115 | + :param params: Additional query parameters. |
| 116 | + :param raw: Return raw HTTPResponse object if True, else return Iterator[FedInflationExpectations]. |
| 117 | + :param options: RequestOptionBuilder for additional headers or params. |
| 118 | + :return: An iterator of FedInflationExpectations objects or HTTPResponse if raw=True. |
| 119 | + """ |
| 120 | + url = "/fed/v1/inflation-expectations" |
| 121 | + |
| 122 | + return self._paginate( |
| 123 | + path=url, |
| 124 | + params=self._get_params(self.list_inflation_expectations, locals()), |
| 125 | + deserializer=FedInflationExpectations.from_dict, |
| 126 | + raw=raw, |
| 127 | + result_key="results", |
| 128 | + options=options, |
| 129 | + ) |
0 commit comments