Geokoduj adres
Geocoder.geocode
Zamienia jeden adres strukturalny z wymaganym polem city na współrzędne i szczegóły dopasowanego adresu.
Parametry body
| Treść żądania | Typ | Opis |
|---|---|---|
address | object WYMAGANE | Podaj obiekt address z wymaganym polem city. Pozostałe pola są opcjonalne; podaj dość szczegółów, aby znaleźć dopasowanie. |
country | string | Opcjonalny 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. |
province | string | Opcjonalna nazwa województwa; API nie uzupełnia jej automatycznie. |
district | string | Pole opcjonalne; brak lub null ustawia domyślnie pusty ciąg. |
community | string | Pole opcjonalne; brak lub null ustawia domyślnie pusty ciąg. |
city | string WYMAGANE | Wymagana nazwa miejscowości w każdym adresie, także dla PL. |
quarter | string | Pole opcjonalne; brak lub null ustawia domyślnie pusty ciąg. |
pcode | string | Pole opcjonalne; brak lub null ustawia domyślnie pusty ciąg. |
street | string | Pole opcjonalne; brak lub null ustawia domyślnie pusty ciąg. |
house | string | Pole opcjonalne; brak lub null ustawia domyślnie pusty ciąg. |
maxResult | integer | Dla 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 result | Typ | Opis |
|---|---|---|
quality | integer | Ocena jakości dopasowania geokodowania w skali opisanej w przewodniku jakości. |
x | double | Długość geograficzna w układzie WGS84. |
y | double | Szerokość geograficzna w układzie WGS84. |
country | string | Kod kraju przypisany do wyniku. |
province | string | Nazwa województwa lub regionu przypisanego do wyniku. |
district | string | Nazwa powiatu przypisanego do wyniku. |
community | string | Nazwa gminy przypisanej do wyniku. |
city | string | Nazwa miejscowości przypisanej do wyniku. |
quarter | string | Nazwa dzielnicy przypisanej do wyniku. |
pcode | string | Kod pocztowy; pole dostępne dla wyników w Polsce. |
street | string | Nazwa ulicy przypisanej do wyniku. |
house | string | Numer budynku. |
addressType | integer ROZSZERZONE | Typ budynku; pole rozszerzone zależne od uprawnień. |
peoplesForAddress | integer ROZSZERZONE | Liczba mieszkańców przypisana do adresu; pole rozszerzone zależne od uprawnień. |
flatsForAddress | integer ROZSZERZONE | Liczba lokali mieszkalnych przypisana do adresu; pole rozszerzone zależne od uprawnień. |
buildingsForAddress | integer ROZSZERZONE | Liczba budynków przypisana do adresu; pole rozszerzone zależne od uprawnień. |
pcodeExtraInfo | object[] ROZSZERZONE | Dodatkowe informacje o kodzie pocztowym; pole rozszerzone zależne od uprawnień. |
resultRadius | number | Promień otoczki wyniku w metrach; -1 oznacza, że promień jest nieznany. |
mapLink | string | Adres URL mapy pokazującej lokalizację wyniku. |