Address Autocomplete
auto_complete_addressWhat it returns
Up to 5 address suggestions matching a partial address string. Powered by a national address graph and curated to US street-level results only — city names, state codes, and ZIP codes alone return no matches.
When to use it
Power a typeahead input on a "lookup property" form.
Resolve user-typed input to a canonical address string before calling
info/current-estimate.Disambiguate between similar-named streets in the same city.
Pricing
Free — 0 credits. Safe to fire on every keystroke (debounce in the client recommended for cost-of-network, not credits).
Errors
Status | Meaning |
400 |
|
401 | Authentication failed. |
503 | Upstream address service unavailable. Retry with backoff. |
FAQ
Does this work for commercial addresses?
No. Only US residential street addresses are returned. The endpoint upstream filters to area_type == "address" records only.
Can I autocomplete by ZIP code?
No — ZIP-only input returns an empty data array. Provide a street fragment with at least one number or street word.
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": {
"input": "<input>"
},
"name": "auto_complete_address"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| input | Yes | Partial address. Minimum 2 characters. Example: `4411 E Hidden`. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||