datasets_housing_markets_facets
Facet US housing market data by region type, state, property type, metro, and period. Get aggregated counts to analyze inventory, prices, and sales trends.
Instructions
Facet the US housing markets dataset. Returns terms aggregation counts for the housing markets dataset. Facet enum: region_type, state_code, property_type, parent_metro, parent_metro_code, income_vintage, is_latest, period_begin. region_type enum: national, metro, county, city, zip. property_type enum: All Residential, Single Family Residential, Condo/Co-op, Townhouse, Multi-Family (2-4 Unit), Single Units Only.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| q | No | Full-text query over region name and city, max 256 characters | |
| facet | Yes | Facet enum: region_type, state_code, property_type, parent_metro, parent_metro_code, income_vintage, is_latest, period_begin | |
| latest | No | Filter for the most recent period per region and property type | |
| period | No | Exact period start date filter, YYYY-MM-DD | |
| zip_code | No | Exact zip code filter (zip-level rows only), e.g. 60616 | |
| state_code | No | Exact two-letter state code filter, e.g. CA | |
| region_type | No | Region level enum: national, metro, county, city, zip | |
| max_inventory | No | Maximum active inventory | |
| min_inventory | No | Minimum active inventory | |
| property_type | No | Property type enum: All Residential, Single Family Residential, Condo/Co-op, Townhouse, Multi-Family (2-4 Unit), Single Units Only | |
| max_median_dom | No | Maximum median days on market | |
| min_homes_sold | No | Minimum homes sold in the period | |
| min_median_dom | No | Minimum median days on market | |
| max_salary_to_buy | No | Maximum salary needed to buy in USD per year | |
| min_salary_to_buy | No | Minimum salary needed to buy in USD per year | |
| parent_metro_code | No | Exact parent metro (CBSA) code filter, e.g. 16980 | |
| max_price_to_income | No | Maximum price-to-income ratio | |
| min_price_to_income | No | Minimum price-to-income ratio | |
| max_median_list_price | No | Maximum median list price in USD | |
| max_median_sale_price | No | Maximum median sale price in USD | |
| min_median_list_price | No | Minimum median list price in USD | |
| min_median_sale_price | No | Minimum median sale price in USD |