Endpoint Playground
Test Crawlora's Facet the US housing markets dataset 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/facets?facet=<facet>" \
-H "x-api-key: $CRAWLORA_API_KEY"| Parameter | Type | Required | Prefilled value | Description |
|---|---|---|---|---|
| facet | string | Yes | Facet enum: region_type, state_code, property_type, parent_metro, parent_metro_code, income_vintage, is_latest, period_begin | |
| 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 |
{
"code": 200,
"msg": "OK",
"data": {
"dataset": "housing-markets",
"facet": "property_type",
"items": [
{
"value": "All Residential",
"count": 3712450
},
{
"value": "Single Family Residential",
"count": 3689121
},
{
"value": "Condo/Co-op",
"count": 2418804
}
]
}
}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.
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`. 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",
"facet": "property_type",
"items": [
{
"value": "All Residential",
"count": 3712450
},
{
"value": "Single Family Residential",
"count": 3689121
},
{
"value": "Condo/Co-op",
"count": 2418804
}
]
}
}curl "https://api.crawlora.net/api/v1/datasets/housing-markets/facets?facet=<facet>" \
-H "x-api-key: $CRAWLORA_API_KEY"