Zipcode Level

Home Price Index Historical (Time Series) (Batch)

Review historical time series data of monthly home price index (HPI) values for a ZIP code, with coverage dating back to 1975, to better understand past market performance and trends.

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>[].zipcode</td><td>string</td><td>5-digit zipcode</td><td>33019</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>Set of historical HPI values with the associated month</td><td></td> </tr> <tr><td>time_series[]</td><td>object</td><td></td><td></td> </tr> <tr><td>time_series[].hpi_value</td><td>number</td><td>HPI value</td><td>235.45</td> </tr> <tr><td>time_series[].hpi_real</td><td>number</td><td>Inflation-adjusted HPI value</td><td>223.67</td> </tr> <tr><td>time_series[].hpi_trend</td><td>number</td><td>Long-term linear trend in HPI value</td><td>210.12</td> </tr> <tr><td>time_series[].hpi_distance</td><td>number</td><td>Normalized distance of HPI value from a long term linear trend. Units are in standard deviations from the mean.</td><td>1.23</td> </tr> <tr><td>time_series[].month</td><td>string</td><td>Month of the HPI value in ISO format</td><td>2023-07-01</td> </tr> </table>
post/v2/zip/hpi_ts_historical

Query parameters

order'asc' | 'desc' nullable

Chronological order to sort result items. One of [asc or desc]. Defaults to asc.

limitinteger nullable

Maximum integer number of result items to return. Defaults to null.

startstring nullable

Beginning date limit for result items, based on month, in ISO 8601 format, i.e. 2015-01-01. Defaults to null.

endstring nullable

Ending date limit for result items, based on month, in ISO 8601 format, i.e. 2015-01-01. Defaults to null.

Request body

zipcodestring required

5-digit zipcode

Example request

[
  {
    "zipcode": "33019"
  }
]

Response

Success

Example response

[
  {
    "zip/hpi_ts_historical": {
      "result": {
        "time_series": [
          {
            "hpi_value": 235.45,
            "hpi_real": 223.67,
            "hpi_trend": 210.12,
            "hpi_distance": 1.23,
            "month": "2023-07-01"
          }
        ]
      }
    },
    "zipcode_info": {
      "zip": "33019"
    }
  }
]