| q | No | Optional full-text query over region name and city, max 256 characters. | |
| page | No | Result page number, 1-based, default 1; page times page_size must not exceed 10000. | |
| sort | No | Optional sort order. Allowed values: relevance, price_desc, price_asc, list_price_desc, list_price_asc, price_to_income_desc, price_to_income_asc, salary_to_buy_desc, salary_to_buy_asc, dom_asc, dom_desc, inventory_desc, homes_sold_desc, period_desc. Defaults to relevance with q, price_to_income_desc with latest=true, otherwise period_desc. | |
| latest | No | Optional filter for the most recent period per region and property type; true keeps only each series' latest row. | |
| period | No | Optional exact period start date filter in YYYY-MM-DD form, e.g. 2026-05-01. | |
| zip_code | No | Optional exact zip code filter (zip-level rows only), e.g. 60616. | |
| page_size | No | Page size, default 20, max 100; page times page_size must not exceed 10000. | |
| state_code | No | Optional exact two-letter state code filter, e.g. CA. | |
| region_type | No | Optional region level filter. Allowed values: national, metro, county, city, zip. | |
| max_inventory | No | Optional maximum active inventory, 0 or greater. | |
| min_inventory | No | Optional minimum active inventory (listings for sale), 0 or greater. | |
| property_type | No | Optional property type filter. Allowed values: All Residential, Single Family Residential, Condo/Co-op, Townhouse, Multi-Family (2-4 Unit), Single Units Only. | |
| max_median_dom | No | Optional maximum median days on market, 0 or greater. | |
| min_homes_sold | No | Optional minimum homes sold in the period, 0 or greater. | |
| min_median_dom | No | Optional minimum median days on market, 0 or greater. | |
| max_salary_to_buy | No | Optional maximum salary needed to buy in USD per year, 0 or greater. | |
| min_salary_to_buy | No | Optional minimum salary needed to buy the median home in USD per year, 0 or greater. | |
| parent_metro_code | No | Optional exact parent metro (CBSA) code filter, e.g. 16980 for Chicago. | |
| max_price_to_income | No | Optional maximum price-to-income ratio, 0 or greater. | |
| min_price_to_income | No | Optional minimum price-to-income ratio (median sale price over ACS median household income), 0 or greater. | |
| max_median_list_price | No | Optional maximum median list price in USD, 0 or greater. | |
| max_median_sale_price | No | Optional maximum median sale price in USD, 0 or greater. | |
| min_median_list_price | No | Optional minimum median list price in USD, 0 or greater. | |
| min_median_sale_price | No | Optional minimum median sale price in USD, 0 or greater. | |