Home Value Index time series by geo tier

GET

/api/v1/real-estate/home-values/{geo_type}

Last modified:2026-07-19 17:02:27

Maintainer:Not configured

OperationId:real_estate_home_values_geo_type

Returns the Home Value Index - a smoothed, seasonally adjusted estimate of the typical home value across the 35th to 65th percentile tier (the mid-tier cut surfaced as default). Values are in USD and cover January 2000 through the latest published month. Available at all seven geographic tiers: national, state, metro, county, city, ZIP, and neighborhood.

Note on the metro tier: the Metro file includes one row with RegionType=country (the United States aggregate) alongside the ~894 Metropolitan Statistical Area rows. Consumers filtering purely on MSA rows should check RegionType=='msa'.

Request

Authorization

API Key

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Path Params

Query Params

Header Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location 'https://sugra.ai/api/v1/real-estate/home-values/?region=undefined&start_month=undefined&end_month=undefined&limit=undefined' \
--header 'x-api-key: <api-key>'

Responses

🟢200OK

application/json

Home Value Index observations per region at the requested tier, ordered ascending by month.

Bodyapplication/json

Example

{
    "data": {
        "metric": "zhvi",
        "geo_type": "metro",
        "unit": "string",
        "label": "string",
        "region_filter": "string",
        "start_month": "string",
        "end_month": "string",
        "regions": [
            {
                "RegionID": 0,
                "SizeRank": 0,
                "RegionName": "string",
                "RegionType": "string",
                "StateName": "string",
                "observations": [
                    {
                        "month": "2026-03-31",
                        "value": 0
                    }
                ],
                "count": 315,
                "property1": "string",
                "property2": "string"
            }
        ],
        "count": 1,
        "dataset_last_modified": "string"
    },
    "meta": {
        "endpoint": "/api/v1/fred/us/cpi",
        "data_time": "2026-04-16T14:30:00Z",
        "response_time": "2026-04-16T14:30:12Z",
        "provider": "Sugra API v1.0.1",
        "source": "string",
        "attribution": "string",
        "fallback_used": true,
        "fallback_chain": [
            "string"
        ],
        "cached": true,
        "stale": true
    }
}

🟠401Unauthorized

🟠422Parameter Error

🟠429

🔴503Service Unavailable

Modified at 2026-07-19 17:02:27

Catalog of metrics, geographic tiers, and available combinations

Observed Rent Index time series by geo tier