Datasets API endpoint
Use Crawlora's Facet the US housing markets dataset API to search or inspect stored structured datasets as JSON. This page includes request parameters, cURL examples, response schema, validation behavior, credit cost, and a Playground link for testing before integration. Dataset endpoints read indexed records and do not apply proxy routing.
/datasets/housing-markets/facetsReturns 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`. Developers commonly use this endpoint for repeatable dataset search, filtering, facets, local business enrichment, analytics, exports, and internal tools that need structured records beyond the limited manual refinement available in the Google Maps app. Authentication uses the x-api-key header, usage is metered with the credit cost shown on this page, and the request does not trigger live scraping or proxy routing.
Request parameters are generated from the active endpoint catalog. Dataset parameters filter, page, facet, or locate stored structured records; they do not configure a live scraper or proxy path.
| Parameter | Type | Required | Default | Description | Example |
|---|---|---|---|---|---|
| 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 | ||
| x-api-key (header) | string | Yes | API key required |
curl -X GET "https://api.crawlora.net/api/v1/datasets/housing-markets/facets?q=coffee&latest=true" \ -H "x-api-key: $CRAWLORA_API_KEY"
Send your scraping API key in the x-api-key header. Use the console API Keys page to rotate or select the active key.
Endpoint usage is metered in credits. The plan prices, included credits, limits, and overage rates below match the active backend billing configuration.
| Plan | Price | Included credits | Daily cap | Rate limit | Overage |
|---|---|---|---|---|---|
| Free | $0/mo | 2,000 | 500 daily credits | 5/min | No overage |
| Starter | $9/mo | 20,000 | 5,000 daily credits | 15/min | $0.75/1,000 overage credits when enabled |
| Growth | $29/mo | 100,000 | 25,000 daily credits | 45/min | $0.45/1,000 overage credits when enabled |
| Pro | $79/mo | 400,000 | No daily cap | 120/min | $0.30/1,000 overage credits |
| Business | $199/mo | 1,200,000 | No daily cap | 300/min | $0.20/1,000 overage credits |
| Enterprise | $499/mo | 5,000,000 | No daily cap | 1,000/min | $0.12/1,000 overage credits |
This endpoint reads stored indexed dataset records. It does not execute a live upstream Google Maps request, browser session, or proxy-routed scraping job.
- Returns up to `50` buckets ordered by descending count. - `facet` is required; unsupported values return the standard invalid params envelope. - The `is_latest` boolean facet returns `true`/`false` bucket values; `period_begin` buckets are dates. - Combine `latest=true` with the `period_begin` facet to confirm the dataset's current month, or facet `state_code` filtered to `region_type=city` to see per-state city coverage. - Returns an empty `items` array (not an error) when the dataset has no data yet. - Does not trigger live scraping. Example response: ```json { "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 } ] } } ```
Crawlora does not silently return invalid dataset search results when filters, pagination, coordinates, or stored record lookups cannot be satisfied.
| Status | Common failure case |
|---|---|
| 400 | Invalid input, missing required parameter, invalid enum, bad coordinate pair, or result window beyond the dataset limit |
| 404 | Requested stored dataset item is not present |
| 429 | Plan or endpoint rate limit exceeded |
| 500 | Internal dataset query or storage error |
When possible, Crawlora returns structured error context so your integration can adjust filters, page size, location inputs, or lookup identifiers.
| Status | Description | Schema |
|---|---|---|
| 400 | Bad Request | #/definitions/app.Response |
| 429 | Too Many Requests | #/definitions/app.Response |
| 500 | Internal Server Error | #/definitions/app.Response |
{
"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
}
]
}
}Request schema
No body schema
Response schema
#/definitions/datasets.housingMarketsFacetResponseDoc
| Field | Type | Required | Enum | Bounds | Example | Description |
|---|---|---|---|---|---|---|
| code | integer | No | 200 | |||
| data | datasets.HousingFacetResponse | No | ||||
| data.dataset | string | No | ||||
| data.facet | string | No | ||||
| data.items | array | No | ||||
| data.items[].count | integer | No | ||||
| data.items[].value | string | No | ||||
| msg | string | No | OK |
Use environment variables for secrets and keep Crawlora API keys server-side.
curl -X GET "https://api.crawlora.net/api/v1/datasets/housing-markets/facets?q=coffee&latest=true" \
-H "x-api-key: $CRAWLORA_API_KEY"Crawlora is designed for responsible structured public web data workflows. Customers are responsible for using Crawlora in compliance with applicable laws, third-party rights, target-platform rules, and Crawlora terms.
Read Crawlora terms