api.automapa.comv3 - wszystkie systemy działają

Geokoduj adres

Geocoder.geocode

Zamienia jeden adres strukturalny z wymaganym polem city na współrzędne i szczegóły dopasowanego adresu.

POST/v3/Geocoder/geocodeapi.automapa.com

Parametry body

Treść żądaniaTypOpis
addressobject WYMAGANEPodaj obiekt address z wymaganym polem city. Pozostałe pola są opcjonalne; podaj dość szczegółów, aby znaleźć dopasowanie.
countrystringOpcjonalny kod kraju. Brak lub null oznacza PL; pusta wartość pozostaje pusta. Dla adresów w Polsce użyj wielkich liter PL. Geokodowanie międzynarodowe wymaga odpowiedniego dostępu.
provincestringOpcjonalna nazwa województwa; API nie uzupełnia jej automatycznie.
districtstringPole opcjonalne; brak lub null ustawia domyślnie pusty ciąg.
communitystringPole opcjonalne; brak lub null ustawia domyślnie pusty ciąg.
citystring WYMAGANEWymagana nazwa miejscowości w każdym adresie, także dla PL.
quarterstringPole opcjonalne; brak lub null ustawia domyślnie pusty ciąg.
pcodestringPole opcjonalne; brak lub null ustawia domyślnie pusty ciąg.
streetstringPole opcjonalne; brak lub null ustawia domyślnie pusty ciąg.
housestringPole opcjonalne; brak lub null ustawia domyślnie pusty ciąg.
maxResultintegerDla adresów w Polsce maksymalnie 1–3 dopasowania na adres (domyślnie 1). Wartości spoza zakresu są ograniczane do 1–3. Ustaw maxResult w każdym adresie; maxResults nie ustawia tego limitu.

Przykładowe żądanie

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

Przykładowa odpowiedź

{
    "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": ""
        }
    ]
}

Przykład pokazuje wybrane pola odpowiedzi. Rzeczywiste współrzędne i dane kodu pocztowego zależą od danych wejściowych oraz aktualnych danych mapowych; mogą też wystąpić pola rozszerzone zależne od uprawnień.

pola result

pola resultTypOpis
qualityintegerOcena jakości dopasowania geokodowania w skali opisanej w przewodniku jakości.
xdoubleDługość geograficzna w układzie WGS84.
ydoubleSzerokość geograficzna w układzie WGS84.
countrystringKod kraju przypisany do wyniku.
provincestringNazwa województwa lub regionu przypisanego do wyniku.
districtstringNazwa powiatu przypisanego do wyniku.
communitystringNazwa gminy przypisanej do wyniku.
citystringNazwa miejscowości przypisanej do wyniku.
quarterstringNazwa dzielnicy przypisanej do wyniku.
pcodestringKod pocztowy; pole dostępne dla wyników w Polsce.
streetstringNazwa ulicy przypisanej do wyniku.
housestringNumer budynku.
addressTypeinteger ROZSZERZONETyp budynku; pole rozszerzone zależne od uprawnień.
peoplesForAddressinteger ROZSZERZONELiczba mieszkańców przypisana do adresu; pole rozszerzone zależne od uprawnień.
flatsForAddressinteger ROZSZERZONELiczba lokali mieszkalnych przypisana do adresu; pole rozszerzone zależne od uprawnień.
buildingsForAddressinteger ROZSZERZONELiczba budynków przypisana do adresu; pole rozszerzone zależne od uprawnień.
pcodeExtraInfoobject[] ROZSZERZONEDodatkowe informacje o kodzie pocztowym; pole rozszerzone zależne od uprawnień.
resultRadiusnumberPromień otoczki wyniku w metrach; -1 oznacza, że promień jest nieznany.
mapLinkstringAdres URL mapy pokazującej lokalizację wyniku.