properties_endpoint
Retrieve property data (hundreds of fields) with filtering, sorting, and expansion. Billed per value returned: each selected field's price for each home that has a value for it, so a field with no value for a home is not billed. Always set select= to limit fields. For comparables, 'good' properties, or active inventory, add has_expand_listings_eq=true to filters: a fast indexed boolean filter that excludes the long tail of listing-less parcels (use has_expand_listings_rent_eq=true for rentals). Use expand=listings,permits,assessments only when you actually need the related records, not just to filter on their existence (has_expand_permits_eq=true and has_expand_assessments_eq=true cover that). Take place names and abbreviations from location_endpoint. When select names a field with a source column, pass exclude=inferred unless the user wants inferred values too or the call looks up one named property. Set price_quote=true first when the row count is unknown. See search_api_documentation for full filter syntax.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"api_key": "<api_key>"
},
"name": "properties_endpoint"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| city | No | City name as location_endpoint returns it (for example "Calgary"). Letter case, accents and punctuation do not matter. Requires country_abbreviation and province_abbreviation, and the request is refused with a 400 error if either is missing. | |
| page | No | Page number for pagination (default: 1) | |
| expand | No | Comma-separated. Values: "listings", "listings_rent", "permits", "assessments". Each attached record is a flat charge, so only include when you need the related records themselves. To filter to properties that HAVE a set, prefer the indexed boolean filters passed via `filters` (has_expand_listings_eq=true, has_expand_listings_rent_eq=true, has_expand_permits_eq=true, has_expand_assessments_eq=true) over expanding with `filter_expand_match=all`. They are far faster and cheaper. | |
| select | No | Comma-separated fields to return, or "all". Use field_list to discover fields. | |
| address | No | Address for a single property lookup. Letter case and punctuation do not matter, but abbreviations are not rewritten, so write road types in full as the address field does ("Place", not "Pl"). Requires country_abbreviation, province_abbreviation and city. For fuzzy, abbreviated or partial addresses use search_endpoint instead. | |
| api_key | Yes | API key for authentication | |
| exclude | No | Source classes to leave out, comma separated: "inferred" leaves out every value Houski worked out, and "inferred,observed" keeps only values from a linked public record. Checks the selected fields that have a source column (field_detail names it), keeps a property when one of them keeps its value, and empties the rest. search_api_documentation page filter lists every class. | |
| filters | No | Filters array. Format: "field_operator=value", with the value as plain text and not URL encoded. Operators: _eq, _neq, _gte, _lte, _gt, _lt, _in, _regex, _nregex (rows that do not match the regex). Text values compare exactly, letter case included (property_type_eq=House). To narrow to a place, use the country_abbreviation, province_abbreviation, city, community and address arguments, which ignore letter case, rather than filters such as city_eq. Use search_api_documentation for full reference. | |
| polygon | No | Polygon coordinates "lat_lng,lat_lng,lat_lng", latitude and longitude joined by an underscore. Maximum 100 points, simplify a shape that has more. | |
| sort_by | No | Sort field. Format: "field_sort=asc" or "field_sort=desc" | |
| community | No | Community/neighborhood name. Letter case, accents and punctuation do not matter. Requires country_abbreviation, province_abbreviation and city, and the request is refused with a 400 error if any is missing. | |
| bbox_ne_lat | No | Bounding box northeast latitude. All four bbox values are required together. | |
| bbox_ne_lng | No | Bounding box northeast longitude. All four bbox values are required together. | |
| bbox_sw_lat | No | Bounding box southwest latitude. All four bbox values are required together. | |
| bbox_sw_lng | No | Bounding box southwest longitude. All four bbox values are required together. | |
| price_quote | No | Return the cost of this request without billing it or returning data | |
| community_in | No | Several community names, comma separated. This is a plain filter on the community name, so it compares each name exactly, letter case included, and spelled as location_endpoint returns it. It needs no other location parameter, but without city it matches communities with those names in every city. | |
| results_per_page | No | Results per page (default: 6, max: 1000) | |
| filter_expand_match | No | "any" or "all". Use this only when filtering on values inside expanded records (for example expand_permit_content_regex). To filter on mere presence of a set, use the has_expand_* boolean filters in `filters` instead. | |
| country_abbreviation | No | Country abbreviation as location_endpoint returns it (for example "CA", "US", "GB" or "KR"). Any letter case is accepted. | |
| province_abbreviation | No | Province, state or region abbreviation as location_endpoint returns it (for example "AB" in Canada). Any letter case is accepted. Requires country_abbreviation. |