---
title: "Catalog of metrics, geographic tiers, and available combinations"
method: GET
path: "/api/v1/real-estate/catalog"
tags: ["Real Estate"]
---

# Catalog of metrics, geographic tiers, and available combinations

`GET /api/v1/real-estate/catalog`

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.

## Response `200`

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

- EnvelopeRealEstateCatalogPayload
  - `data` RealEstateCatalogPayload, required — Catalog of available (metric, geo_type) pairs and their canonical paths.
    - `metrics` string[], required — Ordered list of metric identifiers Sugra exposes.
    - `metric_labels` object, required — Map metric identifier -> human-readable description.
    - `metric_units` object, required — Map metric identifier -> value unit.
    - `geo_types` string[], required — Ordered list of geographic tiers from coarsest to finest.
    - `combinations` RealEstateCatalogCombo[], required — One entry per (metric, geo_type) pair the upstream publishes.
      - `metric` string, required — Metric identifier (`zhvi`, `zori`, `sales_count`, `inventory`, `new_listings`, `days_on_market`, `market_temperature`).
      - `geo_type` string, required — Geographic tier (`national`, `state`, `metro`, `county`, `city`, `zip`, `neighborhood`).
      - `label` string, nullable — Human-readable description of the metric.
      - `unit` string, nullable — Unit of the metric values.
      - `latest_month_loaded` string, nullable — Latest month present in the currently-loaded snapshot for this pair. Null when the pair has not yet been requested and therefore is not resident in memory.
    - `combinations_count` integer, required — Total number of (metric, geo_type) pairs exposed by Sugra.
    - `currently_loaded` RealEstateCurrentlyLoaded[], required — Pairs currently resident in the LRU cache. Empty immediately after process start.
      - `metric` string, required — Metric identifier.
      - `geo_type` string, required — Geographic tier.
      - `latest_month` string, nullable — Latest month column in the loaded snapshot.
    - `lru_cap` integer, required — Maximum number of (metric, geo_type) DataFrames the cache keeps resident. Least-recently-used entries are evicted past this cap.
    - `notes` string[], required — Caveats about edge cases (rent state gap, Metro country-type row, etc).
  - `meta` SugraMeta, required — Metadata attached to every /api/v1/* response envelope.
    - `endpoint` string, required — Requested endpoint path.
    - `data_time` string, required — ISO 8601 UTC timestamp of the source data, not of the request.
    - `response_time` string, required — ISO 8601 UTC timestamp when this response was produced.
    - `provider` string, required — API name and version.
    - `source` string, nullable — Identifier of the primary upstream source used for this response.
    - `attribution` string, nullable — Human-readable attribution mandated by an upstream source (e.g. a securities regulator or self-regulatory organization). Present only on responses whose source requires the owner and source to be clearly identified. Do not remove or alter it when using the response.
    - `fallback_used` boolean, nullable — True when the primary source failed and a fallback produced the data.
    - `fallback_chain` string[], nullable — Ordered list of sources attempted, in the order they were tried.
    - `cached` boolean, nullable — True when this response was served from the internal cache.
    - `stale` boolean, nullable — True when the cached response was returned after the upstream rate-limited or errored. Clients can use this to detect degraded data.

## Other responses

- `401` — Missing or invalid `x-api-key` header.
- `429` — Daily rate limit exceeded. Check `X-RateLimit-Reset` for the next window.
- `503` — Upstream source is temporarily unavailable. Retry after a short delay.

---

[API](https://skmtc.net/sugra/apis/sugra-api.md) · [All operations](https://skmtc.net/sugra/apis/sugra-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/sugra/sugra-api/versions/4e2740743eb4/schema)