For AI agents: the documentation index is /docs/llms.txt, and this page is available as Markdown.
Similar properties
Returns up to 8 properties near a given property with the same use and a building of similar size, nearest first. $1 per 1,000 properties returned.
The matching rule is fixed. To set your own criteria, call find with near set to the property and where clauses on use, size, year built or price. For recorded sales near a property, use find sales with near.
GET/v1/properties/{id}/similar
Parameters
| Name | Type | Description |
|---|---|---|
id |
path | A property ID. |
radius_m |
number | How far to look, 200 to 50,000 m. Default 5,000. When few are close, the search reaches further, up to 50 km. |
max_cost_usd |
number | Refuse the call if it costs more. |
Request
curl "https://api.westkite.com/v1/properties/property:08cdd01c-64d6-8ed2-b7b8-8158ccadf8a0/similar?radius_m=5000" \
-H "Authorization: Bearer $WESTKITE_API_KEY"
Response
{
"data": {
"properties": [
{ "id": "property:8a41d0c2-…", "address": "2210 Example Ave", "propertyType": "Industrial", "buildingSqft": 51200, "yearBuilt": 1974 }
],
"criteria": { "…": "…" }
},
"missing": [],
"billing": { "operation_id": "op_6b21…", "operation": "similar", "charged_usd": 0.001, "balance_usd": 9.95 },
"request_id": "req_6b21…"
}
Similar means the same use and, when the building area is known, a building within about 40% of its size. criteria says what was matched. For recorded sales near a property, use find sales with near.
Errors
| Code | When |
|---|---|
not_found |
No published property has that ID. |
insufficient_balance |
Your balance can't cover the rows. |