OVERVIEW
One base URL, JSON everywhere.
All endpoints live under https://api.homeavm.com/v1 and return JSON. Money is in US dollars, distances in miles, timestamps in UTC.
The API is in private beta. Request access below and we'll send a key within two working days.
AUTHENTICATION
Bearer keys, one per environment.
Send your key in the Authorization header. Keep keys on your server; never ship them to a browser.
Authorization: Bearer hav_live_••••••••••••
GET /v1/valuation
Estimate the market value of a home, with a range and confidence.
ParameterTypeDescription
addressstringFull street address (required)
includestringOptional: comps, drivers
curl "https://api.homeavm.com/v1/valuation?address=1428%20Maple%20Ridge%20Dr%2C%20Austin%2C%20TX" \
-H "Authorization: Bearer $HOMEAVM_KEY"
GET /v1/comps
Comparable sales for a subject property, ranked by similarity.
ParameterTypeDescription
addressstringFull street address (required)
radius_minumberSearch radius, default 0.5
limitintegerMaximum comps, default 10
curl "https://api.homeavm.com/v1/comps?address=1428%20Maple%20Ridge%20Dr%2C%20Austin%2C%20TX" \
-H "Authorization: Bearer $HOMEAVM_KEY"
GET /v1/rent-estimate
Monthly market rent for long-term rentals, with a range.
ParameterTypeDescription
addressstringFull street address (required)
bedroomsintegerOptional override
curl "https://api.homeavm.com/v1/rent-estimate?address=1428%20Maple%20Ridge%20Dr%2C%20Austin%2C%20TX" \
-H "Authorization: Bearer $HOMEAVM_KEY"
GET /v1/market
Market statistics for a ZIP code or city.
ParameterTypeDescription
zipstringFive-digit ZIP code
monthstringYYYY-MM, default: latest
curl "https://api.homeavm.com/v1/market?zip=78745" \
-H "Authorization: Bearer $HOMEAVM_KEY"
ERRORS
Plain error codes with a message.
StatusCodeMeaning
400invalid_requestA parameter is missing or malformed.
401unauthorizedThe key is missing or wrong.
404not_foundWe couldn't match the address.
429rate_limitedSlow down; see the Retry-After header.
500server_errorOur fault. Retry with backoff.
RATE LIMITS
Generous during the beta.
Beta keys allow 1,000 requests a day and 10 requests a second. Limits are returned in X-RateLimit-* headers.