Metropolitan Statistical Area Level

Returns and Risk Information From Address (Batch)

Review HouseCanary's proprietary historical price return metrics for a MSA, including 1-year and 10-year compound annual growth rates, based on the HouseCanary home price index (HPI).

Source: HouseCanary

Pricing Tier: Basic

Updated: Monthly

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>msa</td><td>string</td><td>5-digit US-census msa ID</td><td>38060</td> </tr> <tr><td>msa_name</td><td>string</td><td>Name of the msa</td><td>San Francisco-Oakland-Hayward, CA</td> </tr> <tr><td>cagr_1</td><td>number</td><td>Historical 1-year compound annual growth rate (CAGR)</td><td>0.0432</td> </tr> <tr><td>cagr_5</td><td>number</td><td>Historical 5-year compound annual growth rate (CAGR)</td><td>0.0319</td> </tr> <tr><td>cagr_10</td><td>number</td><td>Historical 10-year compound annual growth rate (CAGR)</td><td>0.0256</td> </tr> <tr><td>cagr_20</td><td>number</td><td>Historical 20-year compound annual growth rate (CAGR)</td><td>0.0198</td> </tr> <tr><td>returns_1</td><td>number</td><td>Home price appreciation for the last year based on HPI</td><td>0.0376</td> </tr> <tr><td>returns_5</td><td>number</td><td>Home price appreciation for the last 5 years based on HPI</td><td>0.1812</td> </tr> <tr><td>returns_10</td><td>number</td><td>Home price appreciation for the last 10 years based on HPI</td><td>0.3197</td> </tr> <tr><td>returns_20</td><td>number</td><td>Home price appreciation for the last 20 years based on HPI</td><td>0.5123</td> </tr> <tr><td>max_12mo_loss</td><td>number</td><td>Historical maximum percentage 12-month loss in HPI</td><td>-0.0792</td> </tr> <tr><td>risk_12mo_loss</td><td>number</td><td>Probability that this market's HPI will be lower 12 months from now than the current HPI</td><td>0.158</td> </tr> </table>
post/v2/property/msa_details

Request body

slugstring

Unique readable string identifier for the property

addressstring required

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)

unitstring

Unit number for the property, if needed and not already specified in the address string

citystring

City in which the property is located

statestring

2-letter acronym of the US state in which the property is located

zipcodestring

5-digit US zipcode in which the property is located

Example request

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

Response

Success

Example response

[
  {
    "property/msa_details": {
      "result": {
        "msa": "38060",
        "msa_name": "San Francisco-Oakland-Hayward, CA",
        "cagr_1": 0.0432,
        "cagr_5": 0.0319,
        "cagr_10": 0.0256,
        "cagr_20": 0.0198,
        "returns_1": 0.0376,
        "returns_5": 0.1812,
        "returns_10": 0.3197,
        "returns_20": 0.5123,
        "max_12mo_loss": -0.0792,
        "risk_12mo_loss": 0.158
      }
    },
    "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"
        ]
      }
    }
  }
]