---
title: "Returns and Risk Information From Address"
method: GET
path: "/v2/property/msa_details"
tags: ["Metropolitan Statistical Area Level"]
---

# Returns and Risk Information From Address

`GET /v2/property/msa_details`

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

## Query parameters

- `slug` string
- `address` string, required
- `unit` string
- `city` string
- `state` string
- `zipcode` string

## Response `200`

Success

- object[]
  - `property/msa_details` object
    - `api_code_description` string
    - `api_code` unknown
    - `result` object, nullable
      - `msa` string — 5-digit US-census msa ID
      - `msa_name` string — Name of the msa
      - `cagr_1` number — Historical 1-year compound annual growth rate (CAGR)
      - `cagr_5` number — Historical 5-year compound annual growth rate (CAGR)
      - `cagr_10` number — Historical 10-year compound annual growth rate (CAGR)
      - `cagr_20` number — Historical 20-year compound annual growth rate (CAGR)
      - `returns_1` number — Home price appreciation for the last year based on HPI
      - `returns_5` number — Home price appreciation for the last 5 years based on HPI
      - `returns_10` number — Home price appreciation for the last 10 years based on HPI
      - `returns_20` number — Home price appreciation for the last 20 years based on HPI
      - `max_12mo_loss` number — Historical maximum percentage 12-month loss in HPI
      - `risk_12mo_loss` number — Probability that this market's HPI will be lower 12 months from now than the current 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)