Home Price Index Forecast (Time Series) (Batch)

Access forecasted time series data of monthly home price index (HPI) values for a Metropolitan Division, including data three years in the future, for informed property investment planning.

Source: HouseCanary

Pricing Tier: Premium

Updated: Monthly

Request Query Params

<table><tr><th>Property</th><th>Type</th><th>Description</th><th>Example</th><th>Enum Values</th></tr> <tr><td>order</td><td>string</td><td>Chronological order to sort result items. One of [asc or desc]. Defaults to asc.</td><td>asc</td> <td>[asc, desc]</td></tr> <tr><td>limit</td><td>integer</td><td>Maximum integer number of result items to return. Defaults to null.</td><td>10</td> <td></td></tr> <tr><td>start</td><td>string</td><td>Beginning date limit for result items, based on month, in ISO 8601 format, i.e. 2015-01-01. Defaults to null.</td><td>2015-01-01</td> <td></td></tr> <tr><td>end</td><td>string</td><td>Ending date limit for result items, based on month, in ISO 8601 format, i.e. 2015-01-01. Defaults to null.</td><td>2015-01-01</td> <td></td></tr> </table>

Request Body Fields

<table><tr><th>Field</th><th>Type</th><th>Description</th><th>Example</th></tr> <tr><td>[]</td><td>object</td><td></td><td></td> </tr> <tr><td>[].metrodiv</td><td>string</td><td>5-digit US-census metrodiv ID</td><td>41884</td> </tr> </table>

Response

<table><tr><th>Field</th><th>Type</th><th>Description</th><th>Example</th></tr> <tr><td>time_series</td><td>array</td><td></td><td></td> </tr> <tr><td>time_series[]</td><td>object</td><td></td><td></td> </tr> <tr><td>time_series[].month</td><td>string</td><td>Month of the HPI value in ISO format</td><td>2023-08-01</td> </tr> <tr><td>time_series[].hpi_value</td><td>number</td><td>Home price index value</td><td>152.43</td> </tr> <tr><td>time_series[].hpi_real</td><td>number</td><td>Home price index value adjusted for inflation</td><td>143.67</td> </tr> <tr><td>time_series[].hpi_trend</td><td>number</td><td>The normalized distance of hpi_value from a long term linear trend. Units are in standard deviations from the mean.</td><td>0.87</td> </tr> <tr><td>time_series[].hpi_distance</td><td>number</td><td>The normalized distance of hpi_value from the long term linear trend. Units are in standard deviations from the mean.</td><td>-0.22</td> </tr> </table>

[
  {
    "metrodiv": "41884"
  }
]

[
  {
    "metrodiv/hpi_ts_forecast": {
      "result": {
        "time_series": [
          {
            "month": "2023-08-01",
            "hpi_value": 152.43,
            "hpi_real": 143.67,
            "hpi_trend": 0.87,
            "hpi_distance": -0.22
          }
        ]
      }
    },
    "metrodiv_info": {
      "metrodiv": "41884",
      "metrodiv_name": "San Francisco-Redwood City-South San Francisco, CA",
      "msa": "41860",
      "msa_name": "San Francisco-Oakland-Hayward, CA"
    }
  }
]