Sign in

v5

OpenAPI 3.1.0Proprietary2026-08-031,5423,1505.5 MB
Real Estate

For-sale inventory snapshot by geo tier

Returns the for-sale inventory - a monthly snapshot of homes listed for sale. Values are smoothed to dampen short-term noise. Available at all seven geographic tiers. Complements the sales-count demand indicator with the supply-side view.

get/api/v1/real-estate/inventory/{geo_type}

Path parameters

geo_typestring required

Geographic tier: national, state, metro, county, city, zip, neighborhood.

Example:state

Geographic tier: national, state, metro, county, city, zip, neighborhood.

Query parameters

regionstring nullable

Filter by region. Accepts a RegionID integer, an exact RegionName string (e.g. Houston, TX for metro, California for state, 77494 for ZIP), or a 2-letter state code. Matching is case-insensitive. Leave empty to return every region at the requested tier.

Example:Houston, TX

Filter by region. Accepts a RegionID integer, an exact RegionName string (e.g. Houston, TX for metro, California for state, 77494 for ZIP), or a 2-letter state code. Matching is case-insensitive. Leave empty to return every region at the requested tier.

start_monthstring nullable

Inclusive start month (YYYY-MM or YYYY-MM-DD). Values below the earliest available month are clipped.

Example:2020-01

Inclusive start month (YYYY-MM or YYYY-MM-DD). Values below the earliest available month are clipped.

end_monthstring nullable

Inclusive end month (YYYY-MM or YYYY-MM-DD). Defaults to the latest month available.

Example:2026-03

Inclusive end month (YYYY-MM or YYYY-MM-DD). Defaults to the latest month available.

limitinteger nullable

Maximum number of region rows to return. Leave empty to return every region at the tier.

Example:50

Maximum number of region rows to return. Leave empty to return every region at the tier.

Response

Monthly for-sale inventory observations per region at the requested tier, ordered ascending by month.

Example response

{
  "data": {
    "metric": "zhvi",
    "geo_type": "metro",
    "unit": "USD (typical home value)",
    "label": "Home Value Index (smoothed, seasonally adjusted, 35th-65th percentile tier)",
    "region_filter": "Houston, TX",
    "start_month": "2020-01",
    "end_month": "2026-03",
    "regions": [
      {
        "RegionID": 394692,
        "SizeRank": 5,
        "RegionName": "Houston, TX",
        "RegionType": "msa",
        "StateName": "TX",
        "observations": [
          {
            "month": "2026-03-31",
            "value": 362857.2
          }
        ],
        "count": 315
      }
    ],
    "count": 1,
    "dataset_last_modified": "2026-04-16T17:30:00Z"
  },
  "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": "sugra_crypto",
    "attribution": "Short interest and Reg SHO daily short volume data is owned by and sourced from FINRA (Financial Industry Regulatory Authority).",
    "fallback_chain": [
      "sugra_crypto",
      "sugra_finance"
    ]
  }
}