api.automapa.comv3 - all systems normal

Geocode an address

Geocoder.geocode

Convert one structured address with a required city to coordinates and matching address details.

POST/v3/Geocoder/geocodeapi.automapa.com

Body parameters

BodyTypeDescription
addressobject REQUIREDProvide an address object with city. Other fields are optional; include enough detail to find a match.
countrystringOptional country code. Omitted or null defaults to PL; an empty value remains empty. Use uppercase PL for Polish addresses. International geocoding requires access to international coverage.
provincestringOptional province name; no value is filled in automatically.
districtstringOptional. Missing or null defaults to an empty string.
communitystringOptional. Missing or null defaults to an empty string.
citystring REQUIREDRequired city name for every address, including PL.
quarterstringOptional. Missing or null defaults to an empty string.
pcodestringOptional. Missing or null defaults to an empty string.
streetstringOptional. Missing or null defaults to an empty string.
housestringOptional. Missing or null defaults to an empty string.
maxResultintegerFor PL addresses, maximum matches per address: 1–3 (default 1). Values outside this range are limited to 1–3. Set maxResult in each address; maxResults does not set this limit.

Example request

{
    "address": {
        "country": "PL",
        "city": "Warszawa",
        "street": "Domaniewska",
        "house": "37"
    }
}

Example response

{
    "result": [
        {
            "quality": 9,
            "x": 21.0071318,
            "y": 52.18284,
            "country": "PL",
            "province": "mazowieckie",
            "district": "Warszawa",
            "community": "Warszawa",
            "city": "Warszawa",
            "quarter": "Mokotów",
            "pcode": "02-672",
            "street": "Domaniewska",
            "house": "37",
            "resultRadius": 0,
            "flat": ""
        }
    ]
}

The example shows selected response fields. Actual coordinates and postal-code data depend on the input and current map data; entitlement-dependent extended fields may also be present.

result fields

result fieldsTypeDescription
qualityintegerGeocoding quality score.
xdoubleLongitude (WGS84).
ydoubleLatitude (WGS84).
countrystringCountry code.
provincestringProvince.
districtstringDistrict (powiat).
communitystringCommunity (gmina).
citystringCity.
quarterstringQuarter.
pcodestringPostal code (PL only).
streetstringStreet.
housestringHouse number.
addressTypeinteger EXTENDEDBuilding type. Extended.
peoplesForAddressinteger EXTENDEDResidents at address. Extended.
flatsForAddressinteger EXTENDEDFlats at address. Extended.
buildingsForAddressinteger EXTENDEDBuildings at address. Extended.
pcodeExtraInfoobject[] EXTENDEDExtra postal-code info. Extended.
resultRadiusnumberResult envelope radius (m). -1 if unknown.
mapLinkstringLink to map result.