Raw schema
{
"type": "object",
"properties": {
"listing_type": {
"default": "sale",
"enum": [
"sale",
"rent"
],
"title": "Listing Type",
"type": "string",
"description": "'sale' for homes for sale or 'rent' for rentals."
},
"zips": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Zips",
"description": "List of up to 25 US ZIP codes, e.g. [\"78701\", \"78702\"]."
},
"state": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "State",
"description": "US state as a 2-letter code, e.g. 'TX' (use with city or county)."
},
"city": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "City",
"description": "City name, e.g. 'Austin'."
},
"county": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "County",
"description": "County name, e.g. 'Travis'."
},
"price_min": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Price Min",
"description": "Minimum price in US dollars (monthly rent for rentals)."
},
"price_max": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Price Max",
"description": "Maximum price in US dollars (monthly rent for rentals)."
},
"beds_min": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Beds Min",
"description": "Minimum number of bedrooms."
},
"baths_min": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Baths Min",
"description": "Minimum number of bathrooms."
},
"sqft_min": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Sqft Min",
"description": "Minimum living area in square feet."
},
"year_built_min": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Year Built Min",
"description": "Oldest acceptable year built, e.g. 2000."
},
"max_days_on_market": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Max Days On Market",
"description": "Only homes listed for at most this many days."
},
"style": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Style",
"description": "Property styles, e.g. [\"single_family\", \"condos\", \"townhomes\", \"multi_family\"]."
},
"new_construction": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "New Construction",
"description": "True for new construction only; False to exclude it."
},
"sort": {
"default": "price_asc",
"enum": [
"price_asc",
"price_desc",
"ppsf_asc",
"newest",
"dom_asc",
"sqft_desc"
],
"title": "Sort",
"type": "string",
"description": "Sort order: price_asc, price_desc, ppsf_asc (price per square foot), newest, dom_asc (fewest days on market) or sqft_desc."
},
"limit": {
"default": 10,
"title": "Limit",
"type": "integer",
"description": "Homes to return, 1 to 25."
},
"offset": {
"default": 0,
"title": "Offset",
"type": "integer",
"description": "Number of rows to skip, for the next page of results (e.g. 20 after a first call with limit 20)."
}
},
"title": "search_listingsArguments"
}