api.automapa.comv3 - all systems normal

Address autocomplete

Autocomplete.searchAddress

Type-ahead suggestions for a partially-typed address (city, street, number, zipcode).

POST/v3/Autocomplete/searchAddressapi.automapa.com

Body parameters

BodyTypeDescription
queryobject REQUIREDPartial fields.
citystringCity or prefix.
streetstringStreet or prefix.
numberstringHouse number.
zipcodestringPostal code.
sourcestring REQUIREDActive field: place | street | number | zipcode.
limitintegerMax suggestions (default 10).
selectedstring[]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 fieldsTypeDescription
items[].citystringCity.
items[].streetstringStreet.
items[].numberstringHouse number.
items[].zipcodestringPostal code.
items[].countintegerHow many objects share this name.
items[].coordsobject{ x, y } if uniquely a city or building.