Documentation

search_properties

Search properties

Search provides bounded lender screening over validated filters and deterministic sorts. It returns candidates for follow-up, not a bulk export or a lending decision.

Start free

When to use it

Use for bounded lender screening with allowlisted valuation, classification, sale-date, delinquency, balance, and tax-sale filters plus deterministic sorting. No arbitrary SQL, owner-name search, mailing-address output, or bulk export.

Use an allowlisted filter combination, follow the keyset cursor when has_more is true, then resolve and inspect a named result with narrow detail tools.

Input contract

These inputs and limits are pinned to the production v0.4.10 server contract. Omitted optional values use the documented defaults.

Input contract table
InputContract
wardoptional; string; max length 8
property_typeoptional; string; max length 80
use_codeoptional; string; max length 16
tax_classoptional; string; max length 8
min_assessmentoptional; integer; minimum 0
max_assessmentoptional; integer; minimum 0
has_balanceoptional; boolean
min_balance_centsoptional; integer; minimum 0
has_tax_sale_flagoptional; boolean
sale_date_fromoptional; string; date
sale_date_tooptional; string; date
sort_byoptional; string; default account_id_asc; one of assessment_desc, balance_desc, sale_date_desc, address_asc, account_id_asc
cursoroptional; string; max length 128
limitoptional; integer; minimum 1; maximum 50; default 20
{
  "ward": "2",
  "property_type": "Commercial-Office (Large)",
  "tax_class": "2",
  "min_assessment": 100000000,
  "sort_by": "assessment_desc",
  "limit": 10
}

Response and verification

Successful sourced responses preserve effective dates, typed null meaning, source references, quality flags, and exact-versus-contextual property-link scope.

Use the display-ready sources for a visible Source or Verify action. Responses return each field with a source reference that can be checked against the official portal. See Source citations and verification for the evidence format.

Limits

  • No arbitrary SQL or bulk export is exposed.
  • Owner-name search and mailing-address output are excluded.
  • Screening criteria do not produce a credit or lending conclusion.