map_endpoint
Get map data: pins, clusters, or heatmaps. Billed per cluster or heatmap cell returned, or per value returned for pins. Scope it with all four bbox coordinates or a polygon: with neither, every property in every country is in scope. A heatmap needs all four bbox coordinates, and a heatmap scoped by a polygon alone is refused. Modes: cluster=true, heatmap=true. There is no cap on how many properties a request may match, so set abort_over yourself if you want a request to give up past a certain number. For maps of active inventory, add has_expand_listings_eq=true to filters so listing-less parcels don't pad results.
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": "map_endpoint"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number for pagination, pins only (default: 1) | |
| select | No | Comma-separated fields to return | |
| api_key | Yes | API key for authentication | |
| cluster | No | Force clustering (default: false) | |
| exclude | No | Source classes to leave out, comma separated, such as "inferred" or "inferred,observed". Checks the selected fields that have a source column and the heatmap field, and a heatmap of a field uses only the kept values (heatmap_values_used counts them). | |
| filters | No | Filters array. Format: "field_operator=value", with the value as plain text and not URL encoded. Use search_api_documentation for reference. | |
| heatmap | No | Enable heatmap mode (default: false) | |
| polygon | No | Polygon coordinates "lat_lng,lat_lng,lat_lng", an alternative to bbox for pins and clusters. A heatmap needs all four bbox values and is refused with a polygon alone. | |
| abort_over | No | Abort if results exceed this count (cost protection) | |
| bbox_ne_lat | No | Bounding box northeast latitude | |
| bbox_ne_lng | No | Bounding box northeast longitude | |
| bbox_sw_lat | No | Bounding box southwest latitude | |
| bbox_sw_lng | No | Bounding box southwest longitude | |
| price_quote | No | Return the cost of this request without billing it or returning data | |
| cluster_over | No | Auto-cluster when results exceed this count | |
| results_per_page | No | Results per page (for pins only) | |
| heatmap_cell_limit | No | Max heatmap cells (default: 1000, max: 10000) | |
| heatmap_aggregation_type | No | Heatmap aggregation: "mean", "median", or "sum" | |
| heatmap_aggregation_field | No | Field for heatmap intensity (e.g., "estimate_list_price"). Without this, uses density. | |
| heatmap_aggregation_invert_intensity | No | Invert intensity (true = lower values show higher intensity, good for affordability) |