fhfa_hpi_series
Return a bounded FHFA House Price Index history for one US geography from LiveDataLink's self-hosted official snapshot. Includes stable FHFA place_id, geography level, year/period, adjusted and unadjusted index values, pagination, snapshot hash, and required attribution. Use this for 'show California house-price history', 'chart the Austin metro HPI', or as a federal price-index leg alongside realestate_trend. The index measures average price change; it is not a property value or appraisal.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Maximum observations. Default 24. | |
| place | Yes | Exact FHFA place_id or geography name, such as 'CA', 'California', a 5-digit CBSA id, or an FHFA metro name. | |
| offset | No | Observations to skip for pagination. Default 0. | |
| end_year | No | Optional latest observation year. | |
| frequency | No | Observation frequency. Default quarterly. | |
| hpi_flavor | No | FHFA index flavor. Default purchase-only. | |
| start_year | No | Optional earliest observation year. | |
| index_basis | No | Index column to use. Default seasonally_adjusted. | |
| geography_level | No | Optional exact FHFA geography level to disambiguate state, metro, division, or national series. | |
| response_format | No | Human-readable markdown or machine-readable JSON. Default markdown. |