Endpoint Playground
Test Crawlora's US Housing Markets Dataset Search API with realistic prefilled filters. Generate a cURL request, inspect stored structured JSON records, and open the full docs or pricing page when you are ready to integrate dataset search. Dataset Playground requests query indexed data and do not apply proxy routing.
curl "https://api.crawlora.net/api/v1/datasets/housing-markets/search" \
-H "x-api-key: $CRAWLORA_API_KEY"| Parameter | Type | Required | Prefilled value | Description |
|---|---|---|---|---|
| q | string | No | Full-text query over region name and city, max 256 characters | |
| region_type | string | No | Region level enum: national, metro, county, city, zip | |
| state_code | string | No | Exact two-letter state code filter, e.g. CA | |
| property_type | string | No | Property type enum: All Residential, Single Family Residential, Condo/Co-op, Townhouse, Multi-Family (2-4 Unit), Single Units Only | |
| parent_metro_code | string | No | Exact parent metro (CBSA) code filter, e.g. 16980 | |
| zip_code | string | No | Exact zip code filter (zip-level rows only), e.g. 60616 | |
| period | string | No | Exact period start date filter, YYYY-MM-DD | |
| latest | boolean | No | Filter for the most recent period per region and property type | |
| min_median_sale_price | number | No | Minimum median sale price in USD | |
| max_median_sale_price | number | No | Maximum median sale price in USD | |
| min_median_list_price | number | No | Minimum median list price in USD | |
| max_median_list_price | number | No | Maximum median list price in USD | |
| min_price_to_income | number | No | Minimum price-to-income ratio | |
| max_price_to_income | number | No | Maximum price-to-income ratio | |
| min_salary_to_buy | integer | No | Minimum salary needed to buy in USD per year | |
| max_salary_to_buy | integer | No | Maximum salary needed to buy in USD per year | |
| min_median_dom | number | No | Minimum median days on market | |
| max_median_dom | number | No | Maximum median days on market | |
| min_inventory | integer | No | Minimum active inventory | |
| max_inventory | integer | No | Maximum active inventory | |
| min_homes_sold | integer | No | Minimum homes sold in the period | |
| sort | string | No | Sort enum: 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 | |
| page | integer | No | Page number, defaults to 1 | |
| page_size | integer | No | Page size, defaults to 20 and maxes at 100; page * page_size must be <= 10000 |
{
"code": 200,
"msg": "OK",
"data": {
"dataset": "housing-markets",
"items": [
{
"region_type": "metro",
"region_type_id": -2,
"table_id": 41940,
"region": "San Jose, CA metro area",
"state_code": "CA",
"property_type": "All Residential",
"property_type_id": -1,
"period_begin": "2026-05-01",
"period_end": "2026-05-31",
"is_latest": true,
"median_sale_price": 1650000,
"median_sale_price_yoy": 0.041,
"median_list_price": 1498000,
"homes_sold": 812,
"inventory": 1421,
"median_dom": 12,
"median_household_income": 153202,
"income_geo_id": "0400000US06",
"income_vintage": "acs2024_5yr",
"price_to_income": 10.77,
"salary_to_buy": 322403,
"affordability_gap": 169201,
"mortgage_rate_pct": 6.49,
"source": "redfin_data_center",
"run_id": "housing-20260711",
"schema_version": 1
}
],
"page": 1,
"page_size": 20,
"total": 934,
"sort": "price_to_income_desc"
}
}Public Playground
Sample responses, schemas, request previews, and code snippets are visible before sign in. Create an account when you are ready to save an API key and run authenticated requests.
Searches monthly Redfin housing-market statistics per region and property type since 2012, joined to Census ACS income for affordability metrics. 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`. Sort enum: `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`. Use `latest=true` for the most recent period per region series. Dataset endpoints are built for repeatable structured search, facets, geo queries, pagination, and item lookup over indexed records. They do not trigger live scraping or proxy routing.
{
"code": 200,
"msg": "OK",
"data": {
"dataset": "housing-markets",
"items": [
{
"region_type": "metro",
"region_type_id": -2,
"table_id": 41940,
"region": "San Jose, CA metro area",
"state_code": "CA",
"property_type": "All Residential",
"property_type_id": -1,
"period_begin": "2026-05-01",
"period_end": "2026-05-31",
"is_latest": true,
"median_sale_price": 1650000,
"median_sale_price_yoy": 0.041,
"median_list_price": 1498000,
"homes_sold": 812,
"inventory": 1421,
"median_dom": 12,
"median_household_income": 153202,
"income_geo_id": "0400000US06",
"income_vintage": "acs2024_5yr",
"price_to_income": 10.77,
"salary_to_buy": 322403,
"affordability_gap": 169201,
"mortgage_rate_pct": 6.49,
"source": "redfin_data_center",
"run_id": "housing-20260711",
"schema_version": 1
}
],
"page": 1,
"page_size": 20,
"total": 934,
"sort": "price_to_income_desc"
}
}curl "https://api.crawlora.net/api/v1/datasets/housing-markets/search" \
-H "x-api-key: $CRAWLORA_API_KEY"