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 freeWhen 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.6 server contract. Omitted optional values use the documented defaults.
| Input | Contract |
|---|---|
| ward | optional; string; max length 8 |
| property_type | optional; string; max length 80 |
| use_code | optional; string; max length 16 |
| tax_class | optional; string; max length 8 |
| min_assessment | optional; integer; minimum 0 |
| max_assessment | optional; integer; minimum 0 |
| has_balance | optional; boolean |
| min_balance_cents | optional; integer; minimum 0 |
| has_tax_sale_flag | optional; boolean |
| sale_date_from | optional; string; date |
| sale_date_to | optional; string; date |
| sort_by | optional; string; default account_id_asc; one of assessment_desc, balance_desc, sale_date_desc, address_asc, account_id_asc |
| cursor | optional; string; max length 128 |
| limit | optional; 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.