Datasets API endpoint
Use Crawlora's US housing markets dataset item 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/items/{region_type}/{table_id}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. 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 |
|---|---|---|---|---|---|
| region_type (path) | string | Yes | Region level enum: national, metro, county, city, zip | ||
| table_id (path) | integer | Yes | Redfin table id (the region's stable numeric id) | ||
| period | string | No | the latest period | Exact period start date, YYYY-MM-DD; defaults to the latest period | |
| property_type | string | No | All Residential | Property type enum: All Residential, Single Family Residential, Condo/Co-op, Townhouse, Multi-Family (2-4 Unit), Single Units Only; defaults to All Residential | |
| history | boolean | No | Return the full monthly series instead of a single period | ||
| x-api-key (header) | string | Yes | API key required |
curl -X GET "https://api.crawlora.net/api/v1/datasets/housing-markets/items/%3Cregion_type%3E/%3Ctable_id%3E?history=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.
- Without `history`, returns the single record for the requested (or latest) period. - With `history=true`, returns a `{dataset, region_type, table_id, property_type, items}` envelope with every stored month. - Returns `404` when the region/period/property-type combination is not present in the stored dataset. - Returns the standard invalid params envelope for an unknown `region_type`, a non-numeric `table_id`, an invalid `property_type`, or a malformed `period`. - Does not trigger live scraping. Example response: ```json { "code": 200, "msg": "OK", "data": { "region_type": "zip", "region_type_id": 2, "table_id": 26097, "region": "Zip Code: 60616", "state": "Illinois", "state_code": "IL", "zip_code": "60616", "parent_metro": "Chicago, IL", "parent_metro_code": "16984", "property_type": "All Residential", "property_type_id": -1, "period_begin": "2026-03-01", "period_end": "2026-05-31", "is_latest": true, "median_sale_price": 340000, "median_sale_price_yoy": 0.062, "median_list_price": 349900, "homes_sold": 94, "inventory": 151, "median_dom": 38, "median_household_income": 91245, "income_geo_id": "860Z200US60616", "income_vintage": "acs2024_5yr", "price_to_income": 3.73, "salary_to_buy": 96581, "affordability_gap": 5336, "mortgage_rate_pct": 6.49, "source": "redfin_data_center", "run_id": "housing-20260711", "schema_version": 1 } } ```
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 |
| 404 | Not Found | #/definitions/app.Response |
| 429 | Too Many Requests | #/definitions/app.Response |
| 500 | Internal Server Error | #/definitions/app.Response |
{
"code": 200,
"msg": "OK",
"data": {
"region_type": "zip",
"region_type_id": 2,
"table_id": 26097,
"region": "Zip Code: 60616",
"state": "Illinois",
"state_code": "IL",
"zip_code": "60616",
"parent_metro": "Chicago, IL",
"parent_metro_code": "16984",
"property_type": "All Residential",
"property_type_id": -1,
"period_begin": "2026-03-01",
"period_end": "2026-05-31",
"is_latest": true,
"median_sale_price": 340000,
"median_sale_price_yoy": 0.062,
"median_list_price": 349900,
"homes_sold": 94,
"inventory": 151,
"median_dom": 38,
"median_household_income": 91245,
"income_geo_id": "860Z200US60616",
"income_vintage": "acs2024_5yr",
"price_to_income": 3.73,
"salary_to_buy": 96581,
"affordability_gap": 5336,
"mortgage_rate_pct": 6.49,
"source": "redfin_data_center",
"run_id": "housing-20260711",
"schema_version": 1
}
}Request schema
No body schema
Response schema
#/definitions/datasets.housingMarketItemResponseDoc
| Field | Type | Required | Enum | Bounds | Example | Description |
|---|---|---|---|---|---|---|
| code | integer | No | 200 | |||
| data | es.HousingMarketRecord | No | ||||
| data.affordability_gap | integer | No | ||||
| data.avg_sale_to_list | number | No | ||||
| data.city | string | No | ||||
| data.homes_sold | integer | No | ||||
| data.income_geo_id | string | No | ||||
| data.income_vintage | string | No | ||||
| data.inventory | integer | No | ||||
| data.is_latest | boolean | No | IsLatest is true only on the most recent period per (region_type_id, table_id, property_type_id); the loader maintains it. | |||
| data.last_updated | string | No | ||||
| data.list_price_to_income | number | No | ||||
| data.loaded_at | string | No | ||||
| data.median_dom | number | No | ||||
| data.median_household_income | integer | No | Affordability join (Census ACS 5-year median household income). Present only where the income geography matched and median_sale_price exists. | |||
| data.median_list_ppsf | number | No | ||||
| data.median_list_ppsf_mom | number | No | ||||
| data.median_list_ppsf_yoy | number | No | ||||
| data.median_list_price | number | No | ||||
| data.median_list_price_mom | number | No | ||||
| data.median_list_price_yoy | number | No | ||||
| data.median_ppsf | number | No | ||||
| data.median_ppsf_mom | number | No | ||||
| data.median_ppsf_yoy | number | No | ||||
| data.median_sale_price | number | No | ||||
| data.median_sale_price_mom | number | No | ||||
| data.median_sale_price_yoy | number | No | ||||
| data.months_of_supply | number | No | ||||
| data.mortgage_rate_pct | number | No | ||||
| data.new_listings | integer | No | ||||
| data.off_market_in_two_weeks | number | No | ||||
| data.parent_metro | string | No | ||||
| data.parent_metro_code | string | No | ||||
| data.pending_sales | integer | No | ||||
| data.period_begin | string | No | ||||
| data.period_end | string | No | ||||
| data.price_drops | number | No | ||||
| data.price_to_income | number | No | ||||
| data.property_type | string | No | ||||
| data.property_type_id | integer | No | ||||
| data.region | string | No | ||||
| data.region_type | string | No | RegionType is the normalized region level: national, metro, county, city, zip. | |||
| data.region_type_id | integer | No | ||||
| data.run_id | string | No | ||||
| data.salary_to_buy | integer | No | ||||
| data.schema_version | integer | No | ||||
| data.sold_above_list | number | No | ||||
| data.source | string | No | ||||
| data.state | string | No | ||||
| data.state_code | string | No | ||||
| data.table_id | integer | No | ||||
| data.zip_code | string | No | ZipCode is set on zip rows only, parsed from REGION ("Zip Code: 60616"). | |||
| 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/items/%3Cregion_type%3E/%3Ctable_id%3E?history=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