Catalog of metrics, geographic tiers, and available combinations

Discovery endpoint for the upstream housing-market data surface. Lists the seven metrics (home values, rent, sales count, for-sale inventory, new listings, days on market, market temperature) and the up to seven geographic tiers (national, state, metro, county, city, ZIP, neighborhood). Enumerates every (metric, geo_type) combination the upstream publishes plus the latest month present in any snapshot loaded into memory.

Important gaps documented here: rent has no state-level file; sales_count is only published at national and metro tiers. These edge cases return structured 404s from the per-metric endpoints.

get/api/v1/real-estate/catalog

Response

Support matrix of metrics and geographic tiers with the current LRU cache state.

Example response

{
  "data": {
    "metrics": [
      "zhvi",
      "zori",
      "sales_count",
      "inventory",
      "new_listings",
      "days_on_market",
      "market_temperature"
    ],
    "geo_types": [
      "national",
      "state",
      "metro",
      "county",
      "city",
      "zip",
      "neighborhood"
    ],
    "combinations": [
      {
        "metric": "zhvi",
        "geo_type": "metro",
        "label": "Home Value Index (smoothed, seasonally adjusted, 35th-65th percentile tier)",
        "unit": "USD (typical home value)",
        "latest_month_loaded": "2026-03-31"
      }
    ],
    "combinations_count": 48,
    "currently_loaded": [
      {
        "metric": "zhvi",
        "geo_type": "national",
        "latest_month": "2026-03-31"
      }
    ],
    "lru_cap": 10
  },
  "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",
    "data_age_days": 8.532,
    "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"
    ],
    "period": "2026-Q1",
    "notes": "the UKMTO report behind these counts is dated 2026-08-21 and is 11 days old"
  }
}

Changes

Changed in 2 of the 24 revisions of this API.15

Sep 1, 2026328d061c12ca3See the full diff
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
Aug 8, 20264c4530760ba112See the full diff
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added

Full history