Zipcode Level
Market Volatility From Address (Batch)
Obtain HouseCanary's proprietary market volatility metrics for a local ZIP code, including beta, Sharpe ratio, and Modigliani-Modigliani risk-adjusted return, 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>beta</td><td>number</td><td>Beta is a measure of the volatility, or systematic risk, of a security or a portfolio in comparison to the market as a whole. Beta is calculated by comparing the security's or portfolio's price movement to the movement of the market index. A beta of 1 indicates that the security's price moves with the market. A beta above 1 indicates that the security's price is more volatile than the market, while a beta below 1 indicates that the security's price is less volatile than the market.</td><td>1.2</td> </tr> <tr><td>sharpe_ratio</td><td>number</td><td>Sharpe ratio is a measure for calculating risk-adjusted return. It is the average return earned in excess of the risk-free rate per unit of volatility or total risk. A high Sharpe ratio indicates that the risk-adjusted return is high. A low Sharpe ratio indicates that the risk-adjusted return is low.</td><td>0.75</td> </tr> <tr><td>modigliani_risk_adjusted_return</td><td>number</td><td>Measure of volatility in zip HPI relative to national HPI. Values greater than 1 indicate that zip HPI is more volatile.</td><td>0.85</td> </tr> </table>post/v2/property/zip_volatility
Request body
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/zip_volatility": {
"result": {
"beta": 1.2,
"sharpe_ratio": 0.75,
"modigliani_risk_adjusted_return": 0.85
}
},
"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"
]
}
}
}
]