Address autocomplete
Autocomplete.searchAddress
Type-ahead suggestions for a partially-typed address (city, street, number, zipcode).
Body parameters
| Body | Type | Description |
|---|---|---|
query | object REQUIRED | Partial fields. |
city | string | City or prefix. |
street | string | Street or prefix. |
number | string | House number. |
zipcode | string | Postal code. |
source | string REQUIRED | Active field: place | street | number | zipcode. |
limit | integer | Max suggestions (default 10). |
selected | string[] | Already-chosen fields, e.g. ["city","zipcode"]. |
Example request
{
"query": {
"city": "Warszawa",
"zipcode": "02-672",
"street": "Dom",
"number": ""
},
"source": "street",
"selected": [
"city",
"zipcode"
]
}Example response
{
"result": {
"items": [
{
"city": "Warszawa",
"street": "Domaniewska",
"zipcode": "02-672",
"count": 1
}
]
}
}result fields
| result fields | Type | Description |
|---|---|---|
items[].city | string | City. |
items[].street | string | Street. |
items[].number | string | House number. |
items[].zipcode | string | Postal code. |
items[].count | integer | How many objects share this name. |
items[].coords | object | { x, y } if uniquely a city or building. |