| filtersbody | array | The criteria as [{ filterId, values, exclude }] (the list /ai-criteria returns). Entries sharing a filterId are OR'd, as are a field's bucket, -exact and minimum- entries; everything else is AND'd. Omit for every property. |
| filters[].filterIdbodyrequired | string | Which filter; the filterId rows below list each one and its values. |
| filters[].valuesbodyrequired | string[] | The filter's values (numbers may be sent as numbers). An entry with no values is ignored. |
| filters[].excludebody | boolean | true to leave matching properties out instead. |
| geoPlaceScopebody | object | { "statesNarrowed": string[] }: the selected states that your city, county, ZIP or radius entries narrow; the other selected states count whole, and the *-outside entries add places in unselected states. Without it, geography is AND'd like any other filter. |
| countBybody | string | string[] | records (default), farmProperties (agricultural land use), nonFarmProperties (every other land use). An array adds data.counts; data.count is the first one. |
| filterId "state"body | string[] | Full state names or two-letter codes, any case; Puerto Rico, Guam and U.S. Virgin Islands also work. Unknown states are a 400. |
| filterId "city", "county", "zipcode"body | string[] | Place names in any case (counties with or without "County") or geography catalog ids; ZIP codes as five digits. |
| filterId "city-outside", "county-outside", "zipcode-outside"body | string[] | Same values, for places in states you haven't selected. Send geoPlaceScope with them. |
| filterId "radius"body | string[] | [lat, lon, miles]: within that many miles of the point; miles must be positive. |
| filterId "year-built", "effective-year-built", "sale-year"body | string[] | [fromYear, toYear], four-digit years. Effective year built reflects the latest major renovation. |
| filterId "minimum-year-built", "minimum-effective-year-built", "minimum-sale-year"body | string[] | [op, year], op = more (after), less (before) or equal, e.g. ["more", "2000"]. |
| filterId "land-use-code"body | string[] | "10" Single Family Residence, "11" Condominium, "20" Commercial, "21" Duplex / Triplex / Quadplex, "22" Apartment (5+ Units), "23" Hotel / Motel, "30" Industrial, "50" Vacant Commercial / Industrial, "70" Agricultural, "80" Vacant Land, "90" Exempt. |
| filterId "bedrooms", "bathrooms", "square-footage", "acres", "stories", "units", "parking", "mortgage-liens", "avm-value", "purchase-amount", "first-mortgage-amount", "second-mortgage-amount", "combined-ltv"body | string[] | Buckets as "min-max", or "min-" for that value and up (e.g. bedrooms "3-3", "5-"). Amounts are in dollars, avm-value is the automated value estimate, and combined-ltv is a loan-to-value percentage. |
| filterId "<field>-exact"body | string[] | [min, max] for any field in the row above, e.g. bedrooms-exact ["3", "5"]. |
| filterId "minimum-<field>"body | string[] | [op, number] for any field in that row, op = more (at least), less or equal, e.g. minimum-bedrooms ["more", "3"]. |
| filterId "owner-occupied"body | string[] | "O" owner-occupied, "A" absentee-owned. |
| filterId "mailing-owner"body | string[] | "in-state" or "out-of-state": the owner's mailing address compared with the property's state. |
| filterId "corporate-owner"body | string[] | ["Y"]: owned by a company. With exclude: true, not company-owned. |
| filterId "has-pool"body | string[] | ["Y"]: has a pool. With exclude: true, no pool. |
| filterId "property-quality"body | string[] | "100% Address", "100% Owner Name": every one picked must hold. |