---
title: "Value HPI Adjusted"
method: GET
path: "/v2/property/value_hpi_adjusted"
tags: ["Property Level"]
---

# Value HPI Adjusted

`GET /v2/property/value_hpi_adjusted`

Obtain adjusted property values based on desired dates using HPI, facilitating historical and future value comparisons.

The data shows the dollar value of this property adjusted from its current AVM value to a desired date, either in the past or in the future. Adjustments are done by using HPI for block, block group, zipcode, MSA and state. All five adjustments are returned in the response.

If the optional parameters client_value and client_date are given, the response will also show adjustment from that date and value to the same desired date. 

Source: HouseCanary 

Pricing Tier: Premium 

Updated: Monthly

## Request Query Params

<table><tr><th>Property</th><th>Type</th><th>Description</th><th>Example</th></tr>
<tr><td>slug</td><td>string</td><td>Unique readable string identifier for the property</td><td>123-Main-St-Apt-1B-San-Francisco-CA-94132</td>
        </tr>
<tr><td>address</td><td>string</td><td>Either a single URL-safe string ("slug") identifying the address, or just a building number, street name, and optionally unit number (if not a slug the payload must also include other identifiers)</td><td>123 Main St</td>
        </tr>
<tr><td>unit</td><td>string</td><td>Unit number for the property, if needed and not already specified in the address string</td><td>Apt 1B</td>
        </tr>
<tr><td>city</td><td>string</td><td>City in which the property is located</td><td>San Francisco</td>
        </tr>
<tr><td>state</td><td>string</td><td>2-letter acronym of the US state in which the property is located</td><td>CA</td>
        </tr>
<tr><td>zipcode</td><td>string</td><td>5-digit US zipcode in which the property is located</td><td>94105</td>
        </tr>
<tr><td>adjust_to_date</td><td>string</td><td>Target date to adjust the value to. Must be the first of the month, in the ISO format, e.g. "2017-01-01". If not supplied, defaults to the current month.</td><td>2017-01-01</td>
        </tr>
<tr><td>client_value</td><td>number</td><td>Alternative dollar value to adjust, supplied by the caller.</td><td>950000</td>
        </tr>
<tr><td>client_date</td><td>string</td><td>Date corresponding to the client_value. Must be the first of the month, in the ISO format, e.g. "2017-01-01"</td><td></td>
        </tr>
</table>

## Response

<table><tr><th>Field</th><th>Type</th><th>Description</th><th>Example</th></tr>
<tr><td>client_value_adjusted</td><td>object</td><td></td><td></td>
        </tr>
<tr><td>client_value_adjusted.from_value</td><td>integer</td><td>Property value as of `from_date`. Defaults to the HouseCanary AVM. Will be `client_value` if supplied in the request.</td><td>315000</td>
        </tr>
<tr><td>client_value_adjusted.from_date</td><td>string</td><td>Date from which the value is adjusted. Defaults to the current month. Will be `client_date` if supplied in the request.</td><td>2023-01-15</td>
        </tr>
<tr><td>client_value_adjusted.to_date</td><td>string</td><td>Date from which the value is adjusted. Defaults to the current month. Will be `adjust_to_date` if supplied in the request.</td><td>2023-06-30</td>
        </tr>
<tr><td>client_value_adjusted.adjusted_by</td><td>object</td><td>The set of HPIs used to adjust the property value in time.</td><td></td>
        </tr>
<tr><td>client_value_adjusted.adjusted_by.block</td><td>integer</td><td>Resulting value after adjusting by block HPI</td><td>904022</td>
        </tr>
<tr><td>client_value_adjusted.adjusted_by.blockgroup</td><td>integer</td><td>Resulting value after adjusting by blockgroup HPI</td><td>972028</td>
        </tr>
<tr><td>client_value_adjusted.adjusted_by.zip</td><td>integer</td><td>Resulting value after adjusting by ZIP code HPI</td><td>984655</td>
        </tr>
<tr><td>client_value_adjusted.adjusted_by.msa</td><td>integer</td><td>Resulting value after adjusting by MSA HPI</td><td>994023</td>
        </tr>
<tr><td>client_value_adjusted.adjusted_by.state</td><td>integer</td><td>Resulting value after adjusting by state HPI</td><td>894021</td>
        </tr>
<tr><td>housecanary_value_adjusted</td><td>object</td><td>The result of adjusting HouseCanary’s current AVM to another date using HouseCanary’s HPIs</td><td></td>
        </tr>
<tr><td>housecanary_value_adjusted.from_value</td><td>integer</td><td>Property value as of `from_date`. Defaults to the HouseCanary AVM. Will be `client_value` if supplied in the request.</td><td>315000</td>
        </tr>
<tr><td>housecanary_value_adjusted.from_date</td><td>string</td><td>Date from which the value is adjusted. Defaults to the current month. Will be `client_date` if supplied in the request.</td><td>2023-01-15</td>
        </tr>
<tr><td>housecanary_value_adjusted.to_date</td><td>string</td><td>Date from which the value is adjusted. Defaults to the current month. Will be `adjust_to_date` if supplied in the request.</td><td>2023-06-30</td>
        </tr>
<tr><td>housecanary_value_adjusted.adjusted_by</td><td>object</td><td>The set of HPIs used to adjust the property value in time.</td><td></td>
        </tr>
<tr><td>housecanary_value_adjusted.adjusted_by.block</td><td>integer</td><td>Resulting value after adjusting by block HPI</td><td>904022</td>
        </tr>
<tr><td>housecanary_value_adjusted.adjusted_by.blockgroup</td><td>integer</td><td>Resulting value after adjusting by blockgroup HPI</td><td>972028</td>
        </tr>
<tr><td>housecanary_value_adjusted.adjusted_by.zip</td><td>integer</td><td>Resulting value after adjusting by ZIP code HPI</td><td>984655</td>
        </tr>
<tr><td>housecanary_value_adjusted.adjusted_by.msa</td><td>integer</td><td>Resulting value after adjusting by MSA HPI</td><td>994023</td>
        </tr>
<tr><td>housecanary_value_adjusted.adjusted_by.state</td><td>integer</td><td>Resulting value after adjusting by state HPI</td><td>894021</td>
        </tr>
</table>

## Query parameters

- `slug` string
- `address` string, required
- `unit` string
- `city` string
- `state` string
- `zipcode` string
- `adjust_to_date` string, date, nullable
- `client_value` number, nullable
- `client_date` string, date, nullable

## Response `200`

Success

- object[]
  - `property/value_hpi_adjusted` object
    - `api_code_description` string
    - `api_code` unknown
    - `result` object, nullable
      - `client_value_adjusted` object, nullable
        - `from_value` integer — Property value as of `from_date`. Defaults to the HouseCanary AVM. Will be `client_value` if supplied in the request.
        - `from_date` string, date — Date from which the value is adjusted. Defaults to the current month. Will be `client_date` if supplied in the request.
        - `to_date` string, date — Date from which the value is adjusted. Defaults to the current month. Will be `adjust_to_date` if supplied in the request.
        - `adjusted_by` object — The set of HPIs used to adjust the property value in time.
          - `block` integer — Resulting value after adjusting by block HPI
          - `blockgroup` integer — Resulting value after adjusting by blockgroup HPI
          - `zip` integer — Resulting value after adjusting by ZIP code HPI
          - `msa` integer — Resulting value after adjusting by MSA HPI
          - `state` integer — Resulting value after adjusting by state HPI
      - `housecanary_value_adjusted` object — The result of adjusting HouseCanary’s current AVM to another date using HouseCanary’s HPIs
        - `from_value` integer — Property value as of `from_date`. Defaults to the HouseCanary AVM. Will be `client_value` if supplied in the request.
        - `from_date` string, date — Date from which the value is adjusted. Defaults to the current month. Will be `client_date` if supplied in the request.
        - `to_date` string, date — Date from which the value is adjusted. Defaults to the current month. Will be `adjust_to_date` if supplied in the request.
        - `adjusted_by` object — The set of HPIs used to adjust the property value in time.
          - `block` integer — Resulting value after adjusting by block HPI
          - `blockgroup` integer — Resulting value after adjusting by blockgroup HPI
          - `zip` integer — Resulting value after adjusting by ZIP code HPI
          - `msa` integer — Resulting value after adjusting by MSA HPI
          - `state` integer — Resulting value after adjusting by state HPI
  - `address_info` AddressInfo
    - `address_full` string, nullable — Full address string
    - `slug` string, nullable — HouseCanary address slug
    - `address` string, nullable — Street address
    - `unit` string, nullable — Unit within the building, if any
    - `city` string, nullable — City where property is located
    - `state` string, nullable — 2-character state abbreviation
    - `zipcode` string, nullable — 5-character US zipcode
    - `zipcode_plus4` string, nullable — 4-character zipcode extension
    - `block_id` string, nullable — 15-digit US census block ID
    - `blockgroup_id` string, nullable — 12-digit census block group ID
    - `county_fips` string, nullable — 5-digit US census county ID
    - `metrodiv` string, nullable — 5-digit US census Metropolitan Division ID
    - `msa` string, nullable — 5-digit US census MSA ID
    - `geo_precision` 'rooftop' | 'parcel' | 'zip9' | 'zip5' | 'unknown', nullable — A string describing available geo precision
    - `lat` number, nullable — Latitude value, in degrees
    - `lng` number, nullable — Longitude value, in degrees
    - `status` object
      - `match` boolean — Whether the address was matched to a canonical address in HouseCanary's systems
      - `details` string[]
      - `requested_item` object — Exact address parameters provided in the original API request
      - `changes` string[]
      - `errors` string[]

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `429` — Rate limit exceeded

---

[API](https://skmtc.net/housecanary/apis/housecanary-analytics-and-portfolio-monitoring-apis.md) · [All operations](https://skmtc.net/housecanary/apis/housecanary-analytics-and-portfolio-monitoring-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/housecanary/housecanary-analytics-and-portfolio-monitoring-apis/revisions/38afb6724de7/schema)