search_endpoint
Find property_id using fuzzy address matching. Billed per value returned. Handles typos, abbreviations, partial addresses. Pass country_abbreviation to keep every match in one country. Use returned property_id with other endpoints for detailed data.
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>",
"query": "<query>"
},
"name": "search_endpoint"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| query | Yes | Address query. Handles partial addresses, building names, typos. Include city for better accuracy. | |
| select | No | Comma-separated fields to return | |
| api_key | Yes | API key for authentication | |
| exclude | No | Source classes to leave out, comma separated, such as "inferred" or "inferred,observed". Checks the selected fields that have a source column, keeps a match when one of them keeps its value, and empties the rest. | |
| max_results | No | Max results (default: 10, max: 25) | |
| price_quote | No | Return the cost of this request without billing it or returning data | |
| country_abbreviation | No | Only return matches from one country, by its country_abbreviation as location_endpoint returns it (for example "GB"). Default: every country. A query that names a province, a state, or a postal code already ranks its own country first. |