autocomplete
Suggest addresses in real-time as users type, enabling live autocomplete in UI fields. Biases results to user location for local relevance.
Instructions
Get real-time address suggestions as a user types in an input field.
Returns: array of suggestions each with { text, label, lat, lon }.
WHEN TO USE: ONLY for powering a live address input field in a UI. Minimum 2 characters. DO NOT USE IN AGENTS: Agents should call geocode directly with a complete address. Autocomplete is a UI tool, not an agent tool — it returns partial matches, not reliable coordinates.
FOCUS: Always pass focus.lat/focus.lon when user location is available — returns local results first.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| text | Yes | Partial address or place name as the user types. Minimum 2 characters. | |
| countries | No | ISO country codes to restrict suggestions. Example: "US,CA". | |
| limit | No | Max suggestions to return. Default 5, max 10. | |
| focus.lat | No | Latitude to bias suggestions toward user's location. | |
| focus.lon | No | Longitude to bias suggestions toward user's location. | |
| layers | No | Filter suggestions by type. |