Value HPI Adjusted (Batch)

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>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>

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>[].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> </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>

[
  {
    "slug": "123-Main-St-Apt-1B-San-Francisco-CA-94132",
    "address": "123 Main St",
    "unit": "Apt 1B",
    "city": "San Francisco",
    "state": "CA",
    "zipcode": "94105"
  }
]

[
  {
    "property/value_hpi_adjusted": {
      "result": {
        "client_value_adjusted": {
          "from_value": 315000,
          "from_date": "2023-01-15",
          "to_date": "2023-06-30",
          "adjusted_by": {
            "block": 904022,
            "blockgroup": 972028,
            "zip": 984655,
            "msa": 994023,
            "state": 894021
          }
        },
        "housecanary_value_adjusted": {
          "from_value": 315000,
          "from_date": "2023-01-15",
          "to_date": "2023-06-30",
          "adjusted_by": {
            "block": 904022,
            "blockgroup": 972028,
            "zip": 984655,
            "msa": 994023,
            "state": 894021
          }
        }
      }
    },
    "address_info": {
      "address_full": "123 Main St San Francisco CA 94132",
      "slug": "123-Main-St-Apt-1B-San-Francisco-CA-94132",
      "address": "123 Main St",
      "unit": "Apt 1B",
      "city": "San Francisco",
      "state": "CA",
      "zipcode": "94132",
      "zipcode_plus4": "1234",
      "block_id": "060750313013007",
      "blockgroup_id": "060750201004",
      "county_fips": "06075",
      "metrodiv": "41860",
      "msa": "41860",
      "geo_precision": "rooftop",
      "lat": 37.789,
      "lng": -122.401,
      "status": {
        "match": true,
        "details": [
          "Address fully verified"
        ],
        "requested_item": {
          "zipcode": "94132",
          "address": "123+Main+St"
        },
        "changes": [
          "State added or changed"
        ]
      }
    }
  }
]