Raw schema
{
"type": "object",
"properties": {
"state": {
"type": "string",
"pattern": "^[A-Za-z]{2}$",
"description": "Two-letter state code, e.g. TX. Required."
},
"city": {
"default": null,
"description": "City name.",
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 80
},
{
"type": "null"
}
]
},
"zip": {
"default": null,
"description": "Five-digit zip code. The narrowest and cheapest place filter.",
"anyOf": [
{
"type": "string",
"pattern": "^\\d{5}$"
},
{
"type": "null"
}
]
},
"county": {
"default": null,
"description": "County name, without the word County.",
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 80
},
{
"type": "null"
}
]
},
"propertyType": {
"default": null,
"description": "SFR single family, MFR multifamily, CONDO, LAND, MOBILE or OTHER.",
"anyOf": [
{
"type": "string",
"enum": [
"SFR",
"MFR",
"LAND",
"CONDO",
"MOBILE",
"OTHER"
]
},
{
"type": "null"
}
]
},
"flags": {
"default": [],
"description": "Only properties with all of these: pre_foreclosure, foreclosure, auction, reo (bank-owned), vacant, absentee_owner, high_equity, free_clear (no mortgage), inherited.",
"maxItems": 9,
"type": "array",
"items": {
"type": "string",
"enum": [
"pre_foreclosure",
"foreclosure",
"auction",
"reo",
"vacant",
"absentee_owner",
"high_equity",
"free_clear",
"inherited"
]
}
},
"bedsMin": {
"default": null,
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 50
},
{
"type": "null"
}
]
},
"bathsMin": {
"default": null,
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 50
},
{
"type": "null"
}
]
},
"valueMin": {
"default": null,
"anyOf": [
{
"type": "number",
"minimum": 0
},
{
"type": "null"
}
]
},
"valueMax": {
"default": null,
"anyOf": [
{
"type": "number",
"minimum": 0
},
{
"type": "null"
}
]
},
"equityPercentMin": {
"default": null,
"description": "Minimum estimated equity, in percent.",
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 100
},
{
"type": "null"
}
]
},
"yearBuiltMin": {
"default": null,
"anyOf": [
{
"type": "integer",
"minimum": 1600,
"maximum": 2200
},
{
"type": "null"
}
]
},
"yearBuiltMax": {
"default": null,
"anyOf": [
{
"type": "integer",
"minimum": 1600,
"maximum": 2200
},
{
"type": "null"
}
]
},
"corporateOwned": {
"default": false,
"description": "Only properties owned by a company or LLC.",
"type": "boolean"
},
"outOfStateOwner": {
"default": false,
"description": "Only owners whose mailing address is in another state.",
"type": "boolean"
},
"cashBuyer": {
"default": false,
"description": "Only properties bought with cash.",
"type": "boolean"
},
"ownerPropertiesMin": {
"default": null,
"description": "Only owners who own at least this many properties.",
"anyOf": [
{
"type": "integer",
"minimum": 1,
"maximum": 10000
},
{
"type": "null"
}
]
},
"lastSoldAfter": {
"default": null,
"description": "Last sale on or after this date.",
"anyOf": [
{
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
{
"type": "null"
}
]
},
"lastSoldBefore": {
"default": null,
"description": "Last sale on or before this date.",
"anyOf": [
{
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
{
"type": "null"
}
]
},
"offset": {
"default": 0,
"description": "Skip this many matches. Use it to quote the next page.",
"type": "integer",
"minimum": 0,
"maximum": 100000
},
"limit": {
"default": null,
"description": "Records to price in this batch (max 250). Leave empty to let the quote pick a safe batch size.",
"anyOf": [
{
"type": "integer",
"minimum": 1,
"maximum": 250
},
{
"type": "null"
}
]
}
},
"required": [
"state"
]
}