datasets_housing_markets_item
Fetch a US housing market record by region type and table ID; set history=true for the full monthly series.
Instructions
Get a US housing market record from the dataset. Returns one housing-market record by region_type and Redfin table_id from dataset id enum value housing-markets. 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 (defaults to All Residential). period defaults to the most recent period on record. Pass history=true to get the full monthly series (a {dataset, region_type, table_id, property_type, items} envelope, sorted by period ascending) instead of a single record.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| period | No | Exact period start date, YYYY-MM-DD; defaults to the latest period | |
| history | No | Return the full monthly series instead of a single period | |
| table_id | Yes | Redfin table id (the region's stable numeric id) | |
| region_type | Yes | Region level enum: national, metro, county, city, zip | |
| property_type | No | Property type enum: All Residential, Single Family Residential, Condo/Co-op, Townhouse, Multi-Family (2-4 Unit), Single Units Only; defaults to All Residential |