Datasets

Facet the US housing markets dataset

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.

get/datasets/housing-markets/facets

Request

  • Base URL: https://api.crawlora.net/api/v1
  • URL: https://api.crawlora.net/api/v1/datasets/housing-markets/facets
  • Auth: API key in header x-api-key

Query parameters

facet'region_type' | 'state_code' | 'property_type' | 'parent_metro' | 'parent_metro_code' | 'income_vintage' | 'is_latest' | 'period_begin' required

Facet enum: region_type, state_code, property_type, parent_metro, parent_metro_code, income_vintage, is_latest, period_begin

qstring

Full-text query over region name and city, max 256 characters

region_type'national' | 'metro' | 'county' | 'city' | 'zip'

Region level enum: national, metro, county, city, zip

state_codestring

Exact two-letter state code filter, e.g. CA

property_typestring

Property type enum: All Residential, Single Family Residential, Condo/Co-op, Townhouse, Multi-Family (2-4 Unit), Single Units Only

parent_metro_codestring

Exact parent metro (CBSA) code filter, e.g. 16980

zip_codestring

Exact zip code filter (zip-level rows only), e.g. 60616

periodstring

Exact period start date filter, YYYY-MM-DD

latestboolean

Filter for the most recent period per region and property type

min_median_sale_pricenumber

Minimum median sale price in USD

max_median_sale_pricenumber

Maximum median sale price in USD

min_median_list_pricenumber

Minimum median list price in USD

max_median_list_pricenumber

Maximum median list price in USD

min_price_to_incomenumber

Minimum price-to-income ratio

max_price_to_incomenumber

Maximum price-to-income ratio

min_salary_to_buyinteger

Minimum salary needed to buy in USD per year

max_salary_to_buyinteger

Maximum salary needed to buy in USD per year

min_median_domnumber

Minimum median days on market

max_median_domnumber

Maximum median days on market

min_inventoryinteger

Minimum active inventory

max_inventoryinteger

Maximum active inventory

min_homes_soldinteger

Minimum homes sold in the period

Headers

x-api-keystring required

API key required

Response

OK

codeinteger
msgstring

Example response

{
  "code": 200,
  "msg": "OK"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.