Skip to main content

DocsREST API and MCP server

Property Data Search API

Endpoints, auth and live samples for Audience Builder, Connect Data and CRM sync.

Base URLhttps://us-farmvision-new-api.onrender.com

Audience Builder: Property Data Search

Property Search Count

Counts the property records that match a filter list; send countBy as an array to get several counts at once. 400 names the field at fault (filters must be a list), and 429 or 503 mean too many counts are running, so retry shortly.

POSThttps://us-farmvision-new-api.onrender.com/api/v1/property-search/countTry it

In this section

Authentication

Get API key

Bearer token or partner key

Send your GTM Scoop API key (llmcp_…) as a Bearer token. Partner keys issued by our team go in x-api-key instead, never both. Calls with no credentials get 401.

Authorization: Bearer YOUR_API_KEY
x-api-key: YOUR_PARTNER_KEY

Request body

application/json
FieldTypeDescription
filtersbodyarrayThe 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[].filterIdbodyrequiredstringWhich filter; the filterId rows below list each one and its values.
filters[].valuesbodyrequiredstring[]The filter's values (numbers may be sent as numbers). An entry with no values is ignored.
filters[].excludebodybooleantrue to leave matching properties out instead.
geoPlaceScopebodyobject{ "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.
countBybodystring | 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"bodystring[]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"bodystring[]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"bodystring[]Same values, for places in states you haven't selected. Send geoPlaceScope with them.
filterId "radius"bodystring[][lat, lon, miles]: within that many miles of the point; miles must be positive.
filterId "year-built", "effective-year-built", "sale-year"bodystring[][fromYear, toYear], four-digit years. Effective year built reflects the latest major renovation.
filterId "minimum-year-built", "minimum-effective-year-built", "minimum-sale-year"bodystring[][op, year], op = more (after), less (before) or equal, e.g. ["more", "2000"].
filterId "land-use-code"bodystring[]"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"bodystring[]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"bodystring[][min, max] for any field in the row above, e.g. bedrooms-exact ["3", "5"].
filterId "minimum-<field>"bodystring[][op, number] for any field in that row, op = more (at least), less or equal, e.g. minimum-bedrooms ["more", "3"].
filterId "owner-occupied"bodystring[]"O" owner-occupied, "A" absentee-owned.
filterId "mailing-owner"bodystring[]"in-state" or "out-of-state": the owner's mailing address compared with the property's state.
filterId "corporate-owner"bodystring[]["Y"]: owned by a company. With exclude: true, not company-owned.
filterId "has-pool"bodystring[]["Y"]: has a pool. With exclude: true, no pool.
filterId "property-quality"bodystring[]"100% Address", "100% Owner Name": every one picked must hold.

Mounted at

/api/v1/property-search

Sizes a property audience from parcel records: location, size, year built, land use, value, mortgages and ownership. Same credentials and per-minute limits as Farm Data Search; filters always use the { filterId, values, exclude } list form.

Try it in the playground

Signed out: 10 free tries a day with names hidden. Log in for live data.

Open playground

Related endpoints

All 2 endpoints in this section

Bearer (API key or session token) or a partner x-api-key; a GTM Scoop request with no credentials gets 401.

MethodPathWhat it does
POST/api/v1/property-search/count

Property Search Count

Counts the property records that match a filter list; send countBy as an array to get several counts at once. 400 names the field at fault (filters must be a list), and 429 or 503 mean too many counts are running, so retry shortly.

21 parameters
  • filters (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[].filterId (string, required) Which filter; the filterId rows below list each one and its values.
  • filters[].values (string[], required) The filter's values (numbers may be sent as numbers). An entry with no values is ignored.
  • filters[].exclude (boolean) true to leave matching properties out instead.
  • geoPlaceScope (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.
  • countBy (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" (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" (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" (string[]) Same values, for places in states you haven't selected. Send geoPlaceScope with them.
  • filterId "radius" (string[]) [lat, lon, miles]: within that many miles of the point; miles must be positive.
  • filterId "year-built", "effective-year-built", "sale-year" (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" (string[]) [op, year], op = more (after), less (before) or equal, e.g. ["more", "2000"].
  • filterId "land-use-code" (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" (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" (string[]) [min, max] for any field in the row above, e.g. bedrooms-exact ["3", "5"].
  • filterId "minimum-<field>" (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" (string[]) "O" owner-occupied, "A" absentee-owned.
  • filterId "mailing-owner" (string[]) "in-state" or "out-of-state": the owner's mailing address compared with the property's state.
  • filterId "corporate-owner" (string[]) ["Y"]: owned by a company. With exclude: true, not company-owned.
  • filterId "has-pool" (string[]) ["Y"]: has a pool. With exclude: true, no pool.
  • filterId "property-quality" (string[]) "100% Address", "100% Owner Name": every one picked must hold.
Try Property Search Count in the Playground
POST/api/v1/property-search/ai-criteria

Property AI Criteria

Turns a plain-language request into Property filters, returned in the list form /count accepts as-is (it returns filters, not a count). Relative dates such as "sold in the last 5 years" are resolved against today, and anything it couldn't map comes back in unmatched. Uses the AI criteria budget shared with Farm and Business (429 AI_RATE_LIMIT or AI_DAILY_LIMIT); 502 means generation failed: retry.

2 parameters
  • text (string, required) The request in plain language, up to 2,000 characters.
  • hintStates (string[]) States already selected. Helps resolve a city or county name that exists in several states.
Try Property AI Criteria in the Playground

Cookies on GTM Scoop

Essential cookies keep you signed in and the site secure, and are always on. Optional cookies (Google Analytics) help us understand how the site is used. They are on by default, except in the EU/EEA, the UK and Switzerland, where they stay off until you choose Accept All Cookies; choose Essential Cookies Only to turn them off. We do not use advertising cookies and we do not sell or share your personal information. The site works the same whichever you choose. We keep a record of your choice with the date, your IP address and the page you were on. Cookie Policy · Privacy Policy