Inputs and types
The shared location, filter, paging and lookup inputs, and the Money, Address and Location types used in every row.
Every source uses the same input groups. A source's page lists which ones its routes take.
#Location
Where to search. Send exactly one of: zip; city with state; bbox; or lat with lng and radius_mi. None, or more than one, returns 422 with param set to location.
| Parameter | Type | Default | Description |
|---|---|---|---|
zip | string | Five-digit ZIP code. | |
city | string | City name. Send with state. | |
state | string | Two-letter state code. Send with city. | |
bbox | string | Map box as west,south,east,north in decimal degrees. | |
lat | number, -90–90 | Center latitude. Send with lng and radius_mi. | |
lng | number, -180–180 | Center longitude. | |
radius_mi | number, 0.1–10 | Search radius in miles, up to 10. |
#Filters
Optional filters for area searches.
| Parameter | Type | Default | Description |
|---|---|---|---|
min_price | integer, 0–∞ | Lowest price in dollars. On rentals, the lowest monthly rent. | |
max_price | integer, 0–∞ | Highest price in dollars. On rentals, the highest monthly rent. | |
beds_min | integer, 0–10 | Fewest bedrooms. | |
baths_min | number, 0–10 | Fewest bathrooms. | |
sqft_min | integer, 0–∞ | Smallest living area in square feet. | |
sqft_max | integer, 0–∞ | Largest living area in square feet. | |
property_type | One or more of single_family, condo, townhouse, multi_family, land, manufactured, apartment, comma-separated | One or more home types, separated by commas, like single_family,townhouse. |
#Paging
Paging. The first call sends no cursor. Send result.next_cursor to get the next page. It is null on the last page.
| Parameter | Type | Default | Description |
|---|---|---|---|
cursor | string | The next_cursor from the previous page. It only works on the route that made it and with the same inputs. |
#Lookup
Which home. Send exactly one of address, url or source_id. None, or more than one, returns 422 with param set to lookup.
| Parameter | Type | Default | Description |
|---|---|---|---|
address | string | Full street address with city and state or ZIP, like 2041 Samuel Dr, Denver, CO 80221. An address that matches several homes returns 422 address_ambiguous with up to 5 candidates. | |
url | string | The home's page URL on the source site. | |
source_id | string | The source's own ID for the home. On Zillow, the zpid. |
#Types
Money: An amount with its currency. Amounts are numbers, not strings.
| Field | Type | Description |
|---|---|---|
amount | number | The amount. |
currency | string | ISO 4217 code, like USD. |
Address: A street address as the source shows it, split into parts.
| Field | Type | Description |
|---|---|---|
line1 | string or null | Street number and name. Null when the source hides the address. |
unit | string or null | Unit, apartment or suite. Null when the home has none. |
city | string | City. |
state | string | Two-letter state code. |
zip | string | Five-digit ZIP code. |
county | string or null | County name. Null when the source does not give it. |
county_fips | string or null | Five-digit county FIPS code. Null when unknown. |
Location: Map point for the home.
| Field | Type | Description |
|---|---|---|
lat | number | Latitude. |
lng | number | Longitude. |
#Sold-price disclosure
Some states don't make sale prices public. In those states a sold row's sale_price can be null, and sale_price_disclosure is not_disclosed.
Non-disclosure states: AK, ID, KS, LA, MS, MT, ND, NM, TX, UT, WY. Partly: MO (Some counties do not disclose sale prices.)