Udostępnij przez


OpenPLZ (niezależny wydawca) (wersja zapoznawcza)

OpenPLZ API — publiczny interfejs API ulicy i kodu pocztowego dla Niemiec, Liechtensteinu, Szwajcarii i Austrii.

Dokumentacja: https://www.openplzapi.org/de/germany/

Ten łącznik jest dostępny w następujących produktach i regionach:

Usługa Class Regions
Copilot Studio Premium Wszystkie regiony usługi Power Automate z wyjątkiem następujących:
     - Rząd USA (GCC)
     - Rząd USA (GCC High)
     - China Cloud obsługiwane przez firmę 21Vianet
     - Departament Obrony USA (DoD)
Logic Apps Standard Wszystkie regiony usługi Logic Apps z wyjątkiem następujących:
     — Regiony platformy Azure Government
     — Regiony platformy Azure (Chiny)
     - Departament Obrony USA (DoD)
Power Apps Premium Wszystkie regiony usługi Power Apps z wyjątkiem następujących:
     - Rząd USA (GCC)
     - Rząd USA (GCC High)
     - China Cloud obsługiwane przez firmę 21Vianet
     - Departament Obrony USA (DoD)
Power Automate - narzędzie do automatyzacji procesów Premium Wszystkie regiony usługi Power Automate z wyjątkiem następujących:
     - Rząd USA (GCC)
     - Rząd USA (GCC High)
     - China Cloud obsługiwane przez firmę 21Vianet
     - Departament Obrony USA (DoD)
Kontakt
Name OpenPLZ API
adres URL https://www.openplzapi.org
Metadane łącznika
Publisher LowCodeInvestigator
Witryna internetowa https://www.openplzapi.org
Zasady ochrony prywatności https://www.openplzapi.org/legal/privacy-policy
Kategorie Dane
Widoczność Ważne

Łącznik interfejsu API OpenPLZ

Łącznik OpenPLZ API Connector zapewnia ustrukturyzowany dostęp do kodów pocztowych, ulic, działów administracyjnych i danych dotyczących lokalizacji dla Niemiec, Szwajcarii, Austrii i Liechtensteinu. Umożliwia ona rozwiązaniom platformy Microsoft Power Platform wykonywanie zapytań dotyczących niezawodnych i znormalizowanych zestawów danych lokalizacji w formacie opartym na protokole REST.

Ten łącznik uwidacznia wiele operacji tylko do odczytu, które umożliwiają pobieranie informacji hierarchicznych, takich jak stany federalne, kantony, okręgi, gminy, miejscowości, kody pocztowe i ulice.

Publisher

OpenPLZ API


Obsługiwane funkcje

Łącznik interfejsu API OpenPLZ obsługuje następujące możliwości:

  • Pobieranie hierarchii administracyjnych (stany federalne, kantony, dzielnice, gminy, stowarzyszenia komunalne, miejscowości)
  • Wyszukiwanie kodu pocztowego
  • Tworzenie zapytań o katalogi uliczne
  • Praca z zasięgiem między krajami (Niemcy, Szwajcaria, Austria, Liechtenstein)
  • Używanie spójnych formatów odpowiedzi JSON odpowiednich do automatyzacji i walidacji

Wymagania wstępne

Nie ma wymagań wstępnych wymaganych do korzystania z tego łącznika:

  • Brak klucza interfejsu API
  • Brak uwierzytelniania OAuth
  • Brak uwierzytelniania
  • Brak subskrypcji

Interfejs API jest publicznie dostępny.


Jak używać łącznika

  1. Dodaj łącznik interfejsu API OpenPLZ do przepływu usługi Power App lub Power Automate.
  2. Wybierz jedną z dostępnych akcji.
  3. Podaj wymagane parametry.
  4. Użyj zwróconych danych JSON w przepływie pracy lub aplikacji (na przykład, aby wypełnić listy rozwijane, zweryfikować adresy lub przechowywać dane lokalizacji ustrukturyzowanej).

Informacje o połączeniu

Łącznik używa pojedynczego połączenia anonimowego. Nie są wymagane żadne poświadczenia.


Znane ograniczenia

  • Interfejs API tylko do odczytu (dostępne są tylko operacje GET)
  • Potencjalne ograniczanie szybkości żądań nadmiernych lub żądań o wysokiej częstotliwości
  • Brak geokoordynatów ani wielokątnych danych granic
  • Nazwy administracyjne i lokalne są zgodne z konwencjami nazewnictwa w języku niemieckim

Dokumentacja interfejsu API


W poniższych sekcjach opisano zalecaną sekwencję wywołań interfejsu API w celu pobrania hierarchicznych struktur administracyjnych w logicznej kolejności dla każdego kraju.

Niemcy (DE)

Niemcy — dane podstawowe

  • GET /de/FederalStates (Lista wszystkich stanów federalnych (Niemcy))

Niemcy — poziom stanu federalnego (przy użyciu federalStateKey)

  • GET /de/FederalStates/{federalStateKey}/GovernmentRegions (Lista regionów rządowych stanu federalnego (Niemcy))
  • GET /de/FederalStates/{federalStateKey}/Districts (Listy okręgów stanu federalnego (Niemcy))
  • GET /de/FederalStates/{federalStateKey}/Gminy (Lista gmin stanu federalnego (Niemcy))
  • GET /de/FederalStates/{federalStateKey}/MunicipalAssociations (Lista stowarzyszeń miejskich stanu federalnego (Niemcy))
  • GET /de/FederalStates/{federalStateKey}/Localities (Lista miejsc stanu federalnego (Niemcy))

Niemcy — poziom regionów rządowych (przy użyciu governmentRegionKey)

  • GET /de/GovernmentRegions/{governmentRegionKey}/Districts (Lista okręgów regionu rządowego (Niemcy))
  • GET /de/GovernmentRegions/{governmentRegionKey}/Gminy (Lista gmin regionu rządowego (Niemcy))
  • GET /de/GovernmentRegions/{governmentRegionKey}/MunicipalAssociations (Lista skojarzeń gminnych regionu rządowego (Niemcy))
  • GET /de/GovernmentRegions/{governmentRegionKey}/Localities (Lista miejsc w regionie rządowym (Niemcy))

Niemcy — poziom okręgowy (przy użyciu districtKey)

  • GET /de/Districts/{districtKey}/Gminy (Lista gmin powiatu (Niemcy))
  • GET /de/Districts/{districtKey}/MunicipalAssociations (Lista stowarzyszeń miejskich dzielnicy (Niemcy))
  • GET /de/Districts/{districtKey}/Localities (Lista miejsc powiatu (Niemcy))

Niemcy — wyszukiwanie punktów końcowych

  • GET /de/Localities (Wyszukaj miejscowości i kody pocztowe (Niemcy))
  • GET /de/Streets (Wyszukaj ulice (Niemcy))
  • GET /de/FullTextSearch (Wyszukiwanie pełnotekstowe ulic, kodów pocztowych i miejscowości (Niemcy))

Liechtenstein (LI)

Liechtenstein — dane podstawowe

  • GET /li/Gminy (Lista wszystkich gmin (Liechtenstein))

Liechtenstein — punkty końcowe wyszukiwania

  • GET /li/Localities (Wyszukaj miejscowości i kody pocztowe (Liechtenstein))
  • GET /li/Streets (Wyszukaj ulice (Liechtenstein))
  • GET /li/FullTextSearch (Wyszukiwanie pełnotekstowe ulic (Liechtenstein))

Szwajcaria (CH)

Szwajcaria — dane podstawowe

  • GET /ch/Cantons (Lista wszystkich kantonów (Szwajcaria))

Szwajcaria — poziom Kantonu (przy użyciu cantonKey)

  • GET /ch/Cantons/{cantonKey}/Districts (Listy okręgów kantonu (Szwajcaria))
  • GET /ch/Cantons/{cantonKey}/Gminy (Lista gmin kantonu (Szwajcaria))
  • GET /ch/Cantons/{cantonKey}/Localities (Lista miejsc kantonu (Szwajcaria))

Szwajcaria — poziom okręgu (przy użyciu districtKey)

  • GET /ch/Districts/{districtKey}/Gminy (Lista gmin powiatu (Szwajcaria))
  • GET /ch/Districts/{districtKey}/Localities (Lista miejsc w okręgu (Szwajcaria))

Szwajcaria — punkty końcowe wyszukiwania

  • GET /ch/Localities (Wyszukaj miejscowości i kody pocztowe (Szwajcaria))
  • GET /ch/Streets (Wyszukaj ulice (Szwajcaria))
  • GET /ch/FullTextSearch (Wyszukiwanie pełnotekstowe ulic (Szwajcaria))

Austria (AT)

Austria — dane podstawowe

  • GET /at/FederalProvinces (Lista wszystkich prowincji federalnych (Austria))

Austria — poziom prowincji federalnej (przy użyciu federalProvinceKey)

  • GET /at/FederalProvinces/{federalProvinceKey}/Districts (Listy okręgów prowincji federalnej (Austria))
  • GET /at/FederalProvinces/{federalProvinceKey}/Gminy (Lista gmin prowincji federalnej (Austria))
  • GET /at/FederalProvinces/{federalProvinceKey}/Localities (Lista miejsc prowincji federalnej (Austria))

Austria — poziom okręgowy (przy użyciu districtKey)

  • GET /at/Districts/{districtKey}/Gminy (Lista gmin powiatu (Austria))
  • GET /at/Districts/{districtKey}/Localities (Lista miejscowości powiatu (Austria))

Austria — wyszukiwanie punktów końcowych

  • GET /at/Localities (Wyszukaj miejscowości i kody pocztowe (Austria))
  • GET /at/Streets (Wyszukaj ulice (Austria))
  • GET /at/FullTextSearch (Wyszukiwanie pełnotekstowe ulic (Austria))

Limity ograniczania przepustowości

Nazwa Wywołania Okres odnowienia
Wywołania interfejsu API na połączenie 100 60 sekund

Akcje

Lista gmin kantonu (Szwajcaria)

Zwraca wszystkie gminy w szwajcarskim kantonie.

Lista gmin powiatu (Austria)

Zwraca wszystkie gminy w austriackiej dzielnicy.

Lista gmin powiatu (Niemcy)

Zwraca wszystkie gminy w niemieckiej dzielnicy.

Lista gmin powiatu (Szwajcaria)

Zwraca wszystkie gminy w szwajcarskiej dzielnicy.

Lista gmin prowincji federalnej (Austria)

Zwraca wszystkie gminy w austriackiej prowincji federalnej.

Lista gmin regionu rządowego (Niemcy)

Zwraca wszystkie gminy w niemieckim regionie rządowym.

Lista gmin stanu federalnego (Niemcy)

Zwraca wszystkie gminy w niemieckim stanie federalnym.

Lista miejsc kantonu (Szwajcaria)

Zwraca wszystkie miejscowości w szwajcarskim kantonie.

Lista miejsc prowincji federalnej (Austria)

Zwraca wszystkie miejscowości w austriackiej prowincji federalnej.

Lista miejsc stanu federalnego (Niemcy)

Zwraca wszystkie miejscowości w niemieckim stanie federalnym.

Lista miejsc w okręgu (Niemcy)

Zwraca wszystkie miejscowości w niemieckiej dzielnicy.

Lista miejsc w okręgu (Szwajcaria)

Zwraca wszystkie miejscowości w szwajcarskim okręgu.

Lista miejsc w regionie rządowym (Niemcy)

Zwraca wszystkie miejscowości w regionie rządowym Niemiec.

Lista miejscowości powiatu (Austria)

Zwraca wszystkie miejscowości w austriackiej dzielnicy.

Lista okręgów kantonu (Szwajcaria)

Zwraca wszystkie okręgi w szwajcarskim kantonie.

Lista okręgów prowincji federalnej (Austria)

Zwraca wszystkie okręgi w austriackiej prowincji federalnej.

Lista okręgów regionu rządowego (Niemcy)

Zwraca wszystkie okręgi w niemieckim regionie rządowym.

Lista okręgów stanu federalnego (Niemcy)

Zwraca wszystkie okręgi w niemieckim stanie federalnym.

Lista stowarzyszeń gminnych państwa federalnego (Niemcy)

Zwraca wszystkie stowarzyszenia komunalne w niemieckim stanie federalnym.

Lista stowarzyszeń gminnych regionu rządowego (Niemcy)

Zwraca wszystkie stowarzyszenia komunalne w niemieckim regionie rządowym.

Lista stowarzyszeń miejskich powiatu (Niemcy)

Zwraca wszystkie stowarzyszenia komunalne w niemieckim okręgu.

Lista wszystkich gmin (Liechtenstein)

Zwraca wszystkie 11 gmin Księstwa Liechtensteinu.

Lista wszystkich kantonów (Szwajcaria)

Zwraca wszystkie 26 kantonów Szwajcarii.

Lista wszystkich państw federalnych (Niemcy)

Zwraca wszystkie niemieckie stany federalne.

Lista wszystkich prowincji federalnych (Austria)

Zwraca wszystkie 9 prowincji federalnych w Austrii.

Przeszukaj ulice (Austria)

Wyszukuje ulice w Austrii według nazwy ulicy i/lub kodu pocztowego i/lub nazwy miejscowości. Wszystkie parametry obsługują wyrażenia regularne.

Przeszukaj ulice (Niemcy)

Wyszukuje ulice w Niemczech według nazwy ulicy i/lub kodu pocztowego i/lub nazwy miejscowości. Wszystkie parametry obsługują wyrażenia regularne.

Wyszukaj miejscowości i kody pocztowe (Niemcy)

Wyszukuje miejscowości w Niemczech według kodu pocztowego i/lub nazwy miejscowości. Oba parametry obsługują wyrażenia regularne.

Wyszukaj miejscowości i kody pocztowe (Szwajcaria)

Wyszukuje miejscowości w Szwajcarii według kodu pocztowego i/lub nazwy miejscowości. Oba parametry obsługują wyrażenia regularne.

Wyszukaj ulice (Liechtenstein)

Wyszukuje ulice w Liechtensteinie według nazwy ulicy i/lub kodu pocztowego i/lub lokalizacji. Obsługiwane są wyrażenia regularne.

Wyszukaj ulice (Szwajcaria)

Wyszukuje ulice w Szwajcarii według nazwy ulicy i/lub kodu pocztowego i/lub nazwy miejscowości. Wszystkie parametry obsługują wyrażenia regularne.

Wyszukiwanie miejsc i kodów pocztowych (Austria)

Wyszukuje miejscowości w Austrii według kodu pocztowego i/lub nazwy miejscowości. Oba parametry obsługują wyrażenia regularne.

Wyszukiwanie miejsc i kodów pocztowych (Liechtenstein)

Wyszukuje miejscowości w Liechtensteinie według kodu pocztowego i/lub nazwy miejscowości. Obsługiwane są wyrażenia regularne.

Wyszukiwanie pełnotekstowe ulic, kodów pocztowych i miejscowości (Niemcy)

Wyszukiwanie pełnotekstowe po nazwach ulic, kodach pocztowych i nazwach miejscowych w Niemczech.

Wyszukiwanie pełnotekstowe ulic (Austria)

Wyszukiwanie pełnotekstowe po nazwie ulicy, kodzie pocztowym i nazwie lokalizacji dla austriackiego katalogu danych.

Wyszukiwanie pełnotekstowe ulic (Liechtenstein)

Wyszukiwanie pełnotekstowe po nazwie ulicy, kodzie pocztowym i nazwie lokalizacji w Liechtensteinie.

Wyszukiwanie pełnotekstowe ulic (Szwajcaria)

Wyszukiwanie pełnotekstowe po nazwach ulic, kodach pocztowych i nazwach miejscowych w Szwajcarii.

Wyświetlanie listy regionów rządowych stanu federalnego (Niemcy)

Zwraca wszystkie regiony rządowe w niemieckim stanie federalnym.

Lista gmin kantonu (Szwajcaria)

Zwraca wszystkie gminy w szwajcarskim kantonie.

Parametry

Nazwa Klucz Wymagane Typ Opis
Klucz kantonu
cantonKey True string

Liczba BFS kantonu (maksymalnie 2 cyfry).

Indeks strony
page integer

Indeks strony (wartość domyślna: 1).

Rozmiar strony
pageSize integer

Liczba elementów na stronę (wartość domyślna: 50, maksymalna: 50).

Zwraca

Lista gmin powiatu (Austria)

Zwraca wszystkie gminy w austriackiej dzielnicy.

Parametry

Nazwa Klucz Wymagane Typ Opis
Klucz okręgu
districtKey True string

Identyfikator okręgu lub kod okręgowy (3 cyfry).

Indeks strony
page integer

Indeks strony (wartość domyślna: 1).

Rozmiar strony
pageSize integer

Liczba elementów na stronę (wartość domyślna: 50, maksymalna: 50).

Zwraca

Lista gmin powiatu (Niemcy)

Zwraca wszystkie gminy w niemieckiej dzielnicy.

Parametry

Nazwa Klucz Wymagane Typ Opis
Klucz okręgu
districtKey True string

Klucz regionalny okręgu (5 cyfr).

Indeks strony
page integer

Indeks strony (wartość domyślna: 1).

Rozmiar strony
pageSize integer

Liczba elementów na stronę (wartość domyślna: 50, maksymalna: 50).

Zwraca

Lista gmin powiatu (Szwajcaria)

Zwraca wszystkie gminy w szwajcarskiej dzielnicy.

Parametry

Nazwa Klucz Wymagane Typ Opis
Klucz okręgu
districtKey True string

Liczba BFS okręgu (maksymalnie 4 cyfry).

Indeks strony
page integer

Indeks strony (wartość domyślna: 1).

Rozmiar strony
pageSize integer

Liczba elementów na stronę (wartość domyślna: 50, maksymalna: 50).

Zwraca

Lista gmin prowincji federalnej (Austria)

Zwraca wszystkie gminy w austriackiej prowincji federalnej.

Parametry

Nazwa Klucz Wymagane Typ Opis
Klucz prowincji federalnej
federalProvinceKey True string

Identyfikator prowincji federalnej (1 cyfra).

Indeks strony
page integer

Indeks strony (wartość domyślna: 1).

Rozmiar strony
pageSize integer

Liczba elementów na stronę (wartość domyślna: 50, maksymalna: 50).

Zwraca

Lista gmin regionu rządowego (Niemcy)

Zwraca wszystkie gminy w niemieckim regionie rządowym.

Parametry

Nazwa Klucz Wymagane Typ Opis
Klucz regionu rządowego
governmentRegionKey True string

Klucz regionalny regionu rządowego (3 cyfry).

Indeks strony
page integer

Indeks strony (wartość domyślna: 1).

Rozmiar strony
pageSize integer

Liczba elementów na stronę (wartość domyślna: 50, maksymalna: 50).

Zwraca

Lista gmin stanu federalnego (Niemcy)

Zwraca wszystkie gminy w niemieckim stanie federalnym.

Parametry

Nazwa Klucz Wymagane Typ Opis
Klucz stanu federalnego
federalStateKey True string

Klucz regionalny stanu federalnego (2 cyfry).

Indeks strony
page integer

Indeks strony (wartość domyślna: 1).

Rozmiar strony
pageSize integer

Liczba elementów na stronę (wartość domyślna: 50, maksymalna: 50).

Zwraca

Lista miejsc kantonu (Szwajcaria)

Zwraca wszystkie miejscowości w szwajcarskim kantonie.

Parametry

Nazwa Klucz Wymagane Typ Opis
Klucz kantonu
cantonKey True string

Liczba BFS kantonu (maksymalnie 2 cyfry).

Indeks strony
page integer

Indeks strony (wartość domyślna: 1).

Rozmiar strony
pageSize integer

Liczba elementów na stronę (wartość domyślna: 50, maksymalna: 50).

Zwraca

Lista miejsc prowincji federalnej (Austria)

Zwraca wszystkie miejscowości w austriackiej prowincji federalnej.

Parametry

Nazwa Klucz Wymagane Typ Opis
Klucz prowincji federalnej
federalProvinceKey True string

Identyfikator prowincji federalnej (1 cyfra).

Indeks strony
page integer

Indeks strony (wartość domyślna: 1).

Rozmiar strony
pageSize integer

Liczba elementów na stronę (wartość domyślna: 50, maksymalna: 50).

Zwraca

Lista miejsc stanu federalnego (Niemcy)

Zwraca wszystkie miejscowości w niemieckim stanie federalnym.

Parametry

Nazwa Klucz Wymagane Typ Opis
Klucz stanu federalnego
federalStateKey True string

Klucz regionalny stanu federalnego (2 cyfry).

Indeks strony
page integer

Indeks strony (wartość domyślna: 1).

Rozmiar strony
pageSize integer

Liczba elementów na stronę (wartość domyślna: 50, maksymalna: 50).

Zwraca

Lista miejsc w okręgu (Niemcy)

Zwraca wszystkie miejscowości w niemieckiej dzielnicy.

Parametry

Nazwa Klucz Wymagane Typ Opis
Klucz okręgu
districtKey True string

Klucz regionalny okręgu (5 cyfr).

Indeks strony
page integer

Indeks strony (wartość domyślna: 1).

Rozmiar strony
pageSize integer

Liczba elementów na stronę (wartość domyślna: 50, maksymalna: 50).

Zwraca

Lista miejsc w okręgu (Szwajcaria)

Zwraca wszystkie miejscowości w szwajcarskim okręgu.

Parametry

Nazwa Klucz Wymagane Typ Opis
Klucz okręgu
districtKey True string

Liczba BFS okręgu (maksymalnie 4 cyfry).

Indeks strony
page integer

Indeks strony (wartość domyślna: 1).

Rozmiar strony
pageSize integer

Liczba elementów na stronę (wartość domyślna: 50, maksymalna: 50).

Zwraca

Lista miejsc w regionie rządowym (Niemcy)

Zwraca wszystkie miejscowości w regionie rządowym Niemiec.

Parametry

Nazwa Klucz Wymagane Typ Opis
Klucz regionu rządowego
governmentRegionKey True string

Klucz regionalny regionu rządowego (3 cyfry).

Indeks strony
page integer

Indeks strony (wartość domyślna: 1).

Rozmiar strony
pageSize integer

Liczba elementów na stronę (wartość domyślna: 50, maksymalna: 50).

Zwraca

Lista miejscowości powiatu (Austria)

Zwraca wszystkie miejscowości w austriackiej dzielnicy.

Parametry

Nazwa Klucz Wymagane Typ Opis
Klucz okręgu
districtKey True string

Identyfikator okręgu lub kod okręgowy (3 cyfry).

Indeks strony
page integer

Indeks strony (wartość domyślna: 1).

Rozmiar strony
pageSize integer

Liczba elementów na stronę (wartość domyślna: 50, maksymalna: 50).

Zwraca

Lista okręgów kantonu (Szwajcaria)

Zwraca wszystkie okręgi w szwajcarskim kantonie.

Parametry

Nazwa Klucz Wymagane Typ Opis
Klucz kantonu
cantonKey True string

Liczba BFS kantonu (maksymalnie 2 cyfry), np. "10" dla Fribourg.

Indeks strony
page integer

Indeks strony (wartość domyślna: 1).

Rozmiar strony
pageSize integer

Liczba elementów na stronę (wartość domyślna: 50, maksymalna: 50).

Zwraca

Lista okręgów prowincji federalnej (Austria)

Zwraca wszystkie okręgi w austriackiej prowincji federalnej.

Parametry

Nazwa Klucz Wymagane Typ Opis
Klucz prowincji federalnej
federalProvinceKey True string

Identyfikator prowincji federalnej (1 cyfra).

Indeks strony
page integer

Indeks strony (wartość domyślna: 1).

Rozmiar strony
pageSize integer

Liczba elementów na stronę (wartość domyślna: 50, maksymalna: 50).

Zwraca

Lista okręgów regionu rządowego (Niemcy)

Zwraca wszystkie okręgi w niemieckim regionie rządowym.

Parametry

Nazwa Klucz Wymagane Typ Opis
Klucz regionu rządowego
governmentRegionKey True string

Klucz regionalny regionu rządowego (3 cyfry).

Indeks strony
page integer

Indeks strony (wartość domyślna: 1).

Rozmiar strony
pageSize integer

Liczba elementów na stronę (wartość domyślna: 50, maksymalna: 50).

Zwraca

Lista okręgów stanu federalnego (Niemcy)

Zwraca wszystkie okręgi w niemieckim stanie federalnym.

Parametry

Nazwa Klucz Wymagane Typ Opis
Klucz stanu federalnego
federalStateKey True string

Klucz regionalny stanu federalnego (2 cyfry).

Indeks strony
page integer

Indeks strony (wartość domyślna: 1).

Rozmiar strony
pageSize integer

Liczba elementów na stronę (wartość domyślna: 50, maksymalna: 50).

Zwraca

Lista stowarzyszeń gminnych państwa federalnego (Niemcy)

Zwraca wszystkie stowarzyszenia komunalne w niemieckim stanie federalnym.

Parametry

Nazwa Klucz Wymagane Typ Opis
Klucz stanu federalnego
federalStateKey True string

Klucz regionalny stanu federalnego (2 cyfry).

Indeks strony
page integer

Indeks strony (wartość domyślna: 1).

Rozmiar strony
pageSize integer

Liczba elementów na stronę (wartość domyślna: 50, maksymalna: 50).

Zwraca

Lista stowarzyszeń gminnych regionu rządowego (Niemcy)

Zwraca wszystkie stowarzyszenia komunalne w niemieckim regionie rządowym.

Parametry

Nazwa Klucz Wymagane Typ Opis
Klucz regionu rządowego
governmentRegionKey True string

Klucz regionalny regionu rządowego (3 cyfry).

Indeks strony
page integer

Indeks strony (wartość domyślna: 1).

Rozmiar strony
pageSize integer

Liczba elementów na stronę (wartość domyślna: 50, maksymalna: 50).

Zwraca

Lista stowarzyszeń miejskich powiatu (Niemcy)

Zwraca wszystkie stowarzyszenia komunalne w niemieckim okręgu.

Parametry

Nazwa Klucz Wymagane Typ Opis
Klucz okręgu
districtKey True string

Klucz regionalny okręgu (5 cyfr).

Indeks strony
page integer

Indeks strony (wartość domyślna: 1).

Rozmiar strony
pageSize integer

Liczba elementów na stronę (wartość domyślna: 50, maksymalna: 50).

Zwraca

Lista wszystkich gmin (Liechtenstein)

Zwraca wszystkie 11 gmin Księstwa Liechtensteinu.

Zwraca

Lista wszystkich kantonów (Szwajcaria)

Zwraca wszystkie 26 kantonów Szwajcarii.

Zwraca

Lista wszystkich państw federalnych (Niemcy)

Zwraca wszystkie niemieckie stany federalne.

Zwraca

Lista wszystkich prowincji federalnych (Austria)

Zwraca wszystkie 9 prowincji federalnych w Austrii.

Zwraca

Przeszukaj ulice (Austria)

Wyszukuje ulice w Austrii według nazwy ulicy i/lub kodu pocztowego i/lub nazwy miejscowości. Wszystkie parametry obsługują wyrażenia regularne.

Parametry

Nazwa Klucz Wymagane Typ Opis
Nazwa ulicy
name string

Nazwa ulicy lub wyrażenie regularne.

Kod pocztowy
postalCode string

Kod pocztowy lub wyrażenie regularne.

Nazwa lokalizacji
locality string

Nazwa lokalizacji lub wyrażenie regularne.

Indeks strony
page integer

Indeks strony (wartość domyślna: 1).

Rozmiar strony
pageSize integer

Liczba elementów na stronę (wartość domyślna: 50, maksymalna: 50).

Zwraca

Przeszukaj ulice (Niemcy)

Wyszukuje ulice w Niemczech według nazwy ulicy i/lub kodu pocztowego i/lub nazwy miejscowości. Wszystkie parametry obsługują wyrażenia regularne.

Parametry

Nazwa Klucz Wymagane Typ Opis
Nazwa ulicy
name string

Nazwa ulicy lub wyrażenie regularne.

Kod pocztowy
postalCode string

Kod pocztowy lub wyrażenie regularne.

Nazwa lokalizacji
locality string

Nazwa lokalizacji lub wyrażenie regularne.

Indeks strony
page integer

Indeks strony (wartość domyślna: 1).

Rozmiar strony
pageSize integer

Liczba elementów na stronę (wartość domyślna: 50, maksymalna: 50).

Zwraca

response
array of Street

Wyszukaj miejscowości i kody pocztowe (Niemcy)

Wyszukuje miejscowości w Niemczech według kodu pocztowego i/lub nazwy miejscowości. Oba parametry obsługują wyrażenia regularne.

Parametry

Nazwa Klucz Wymagane Typ Opis
Kod pocztowy
postalCode string

Kod pocztowy lub wyrażenie regularne (np. '^13').

Nazwa lokalizacji
name string

Nazwa lokalizacji lub wyrażenie regularne.

Indeks strony
page integer

Indeks strony (wartość domyślna: 1).

Rozmiar strony
pageSize integer

Liczba elementów na stronę (wartość domyślna: 50, maksymalna: 50).

Zwraca

Wyszukaj miejscowości i kody pocztowe (Szwajcaria)

Wyszukuje miejscowości w Szwajcarii według kodu pocztowego i/lub nazwy miejscowości. Oba parametry obsługują wyrażenia regularne.

Parametry

Nazwa Klucz Wymagane Typ Opis
Kod pocztowy
postalCode string

Kod pocztowy lub wyrażenie regularne (np. '^80').

Nazwa lokalizacji
name string

Nazwa lokalizacji lub wyrażenie regularne.

Indeks strony
page integer

Indeks strony (wartość domyślna: 1).

Rozmiar strony
pageSize integer

Liczba elementów na stronę (wartość domyślna: 50, maksymalna: 50).

Zwraca

Wyszukaj ulice (Liechtenstein)

Wyszukuje ulice w Liechtensteinie według nazwy ulicy i/lub kodu pocztowego i/lub lokalizacji. Obsługiwane są wyrażenia regularne.

Parametry

Nazwa Klucz Wymagane Typ Opis
Nazwa ulicy
name string

Nazwa ulicy lub wyrażenie regularne.

Kod pocztowy
postalCode string

Kod pocztowy lub wyrażenie regularne.

Nazwa lokalizacji
locality string

Nazwa lokalizacji lub wyrażenie regularne.

Indeks strony
page integer

Indeks strony (wartość domyślna: 1).

Rozmiar strony
pageSize integer

Liczba elementów na stronę (wartość domyślna: 50, maksymalna: 50).

Zwraca

Wyszukaj ulice (Szwajcaria)

Wyszukuje ulice w Szwajcarii według nazwy ulicy i/lub kodu pocztowego i/lub nazwy miejscowości. Wszystkie parametry obsługują wyrażenia regularne.

Parametry

Nazwa Klucz Wymagane Typ Opis
Nazwa ulicy
name string

Nazwa ulicy lub wyrażenie regularne.

Kod pocztowy
postalCode string

Kod pocztowy lub wyrażenie regularne.

Nazwa lokalizacji
locality string

Nazwa lokalizacji lub wyrażenie regularne.

Indeks strony
page integer

Indeks strony (wartość domyślna: 1).

Rozmiar strony
pageSize integer

Liczba elementów na stronę (wartość domyślna: 50, maksymalna: 50).

Zwraca

Wyszukiwanie miejsc i kodów pocztowych (Austria)

Wyszukuje miejscowości w Austrii według kodu pocztowego i/lub nazwy miejscowości. Oba parametry obsługują wyrażenia regularne.

Parametry

Nazwa Klucz Wymagane Typ Opis
Kod pocztowy
postalCode string

Kod pocztowy lub wyrażenie regularne (np. '^10').

Nazwa lokalizacji
name string

Nazwa lokalizacji lub wyrażenie regularne.

Indeks strony
page integer

Indeks strony (wartość domyślna: 1).

Rozmiar strony
pageSize integer

Liczba elementów na stronę (wartość domyślna: 50, maksymalna: 50).

Zwraca

Wyszukiwanie miejsc i kodów pocztowych (Liechtenstein)

Wyszukuje miejscowości w Liechtensteinie według kodu pocztowego i/lub nazwy miejscowości. Obsługiwane są wyrażenia regularne.

Parametry

Nazwa Klucz Wymagane Typ Opis
Kod pocztowy
postalCode string

Kod pocztowy lub wyrażenie regularne, np. '^94'.

Nazwa lokalizacji
name string

Nazwa lokalizacji lub wyrażenie regularne.

Indeks strony
page integer

Indeks strony (wartość domyślna: 1).

Rozmiar strony
pageSize integer

Liczba elementów na stronę (wartość domyślna: 50, maksymalna: 50).

Zwraca

Wyszukiwanie pełnotekstowe ulic, kodów pocztowych i miejscowości (Niemcy)

Wyszukiwanie pełnotekstowe po nazwach ulic, kodach pocztowych i nazwach miejscowych w Niemczech.

Parametry

Nazwa Klucz Wymagane Typ Opis
Termin wyszukiwania
searchTerm True string

Wyszukiwany termin, np. "Berlin Pariser Platz".

Indeks strony
page integer

Indeks strony (wartość domyślna: 1).

Rozmiar strony
pageSize integer

Liczba elementów na stronę (wartość domyślna: 50, maksymalna: 50).

Zwraca

response
array of Street

Wyszukiwanie pełnotekstowe ulic (Austria)

Wyszukiwanie pełnotekstowe po nazwie ulicy, kodzie pocztowym i nazwie lokalizacji dla austriackiego katalogu danych.

Parametry

Nazwa Klucz Wymagane Typ Opis
Termin wyszukiwania
searchTerm True string

Wyszukiwany termin, np. "Wien Alfred Dallinger Platz".

Indeks strony
page integer

Indeks strony (wartość domyślna: 1).

Rozmiar strony
pageSize integer

Liczba elementów na stronę (wartość domyślna: 50, maksymalna: 50).

Zwraca

Wyszukiwanie pełnotekstowe ulic (Liechtenstein)

Wyszukiwanie pełnotekstowe po nazwie ulicy, kodzie pocztowym i nazwie lokalizacji w Liechtensteinie.

Parametry

Nazwa Klucz Wymagane Typ Opis
Termin wyszukiwania
searchTerm True string

Wyszukiwany termin, np. "9490 Alte Landß".

Indeks strony
page integer

Indeks strony (wartość domyślna: 1).

Rozmiar strony
pageSize integer

Liczba elementów na stronę (wartość domyślna: 50, maksymalna: 50).

Zwraca

Wyszukiwanie pełnotekstowe ulic (Szwajcaria)

Wyszukiwanie pełnotekstowe po nazwach ulic, kodach pocztowych i nazwach miejscowych w Szwajcarii.

Parametry

Nazwa Klucz Wymagane Typ Opis
Termin wyszukiwania
searchTerm True string

Wyszukiwany termin, np. "Zürich Bederß".

Indeks strony
page integer

Indeks strony (wartość domyślna: 1).

Rozmiar strony
pageSize integer

Liczba elementów na stronę (wartość domyślna: 50, maksymalna: 50).

Zwraca

Wyświetlanie listy regionów rządowych stanu federalnego (Niemcy)

Zwraca wszystkie regiony rządowe w niemieckim stanie federalnym.

Parametry

Nazwa Klucz Wymagane Typ Opis
Klucz stanu federalnego
federalStateKey True string

Klucz regionalny państwa federalnego (2 cyfry), np. "09" dla Bawarii.

Indeks strony
page integer

Indeks strony (wartość domyślna: 1).

Rozmiar strony
pageSize integer

Liczba elementów na stronę (wartość domyślna: 50, maksymalna: 50).

Zwraca

Definicje

FederalState

Niemiecki stan federalny

Nazwa Ścieżka Typ Opis
klucz
key string

Klucz regionalny (2 cyfry).

nazwa
name string

Nazwa stanu federalnego.

seatOfGovernment
seatOfGovernment string

Siedziba rządu stanu federalnego.

GovernmentRegion

Region rządowy

Nazwa Ścieżka Typ Opis
klucz
key string

Klucz regionalny (3 cyfry).

nazwa
name string

Nazwa regionu rządowego.

administracyjneheadquarters
administrativeHeadquarters string

Siedziba administracyjna regionu rządowego.

federalState
federalState FederalStateSummary

Podsumowanie stanu federalnego

GovernmentRegionSummary

Podsumowanie regionu rządowego

Nazwa Ścieżka Typ Opis
klucz
key string

Klucz regionalny (3 cyfry).

nazwa
name string

Nazwa regionu rządowego.

FederalStateSummary

Podsumowanie stanu federalnego

Nazwa Ścieżka Typ Opis
klucz
key string

Klucz regionalny (2 cyfry).

nazwa
name string

Nazwa stanu federalnego.

Dzielnica

Dzielnica

Nazwa Ścieżka Typ Opis
klucz
key string

Klucz regionalny okręgu (5 cyfr).

nazwa
name string

Nazwa dzielnicy.

typ
type string

Typ dzielnicy (np. "Landkreis", "Kreisfreie Stadt").

administracyjneheadquarters
administrativeHeadquarters string

Siedziba administracyjna powiatu.

governmentRegion
governmentRegion GovernmentRegionSummary

Podsumowanie regionu rządowego

federalState
federalState FederalStateSummary

Podsumowanie stanu federalnego

DistrictSummary

Podsumowanie okręgu

Nazwa Ścieżka Typ Opis
klucz
key string

Klucz regionalny okręgu (5 cyfr).

nazwa
name string

Nazwa dzielnicy.

Skojarzenie komunalne

Stowarzyszenie komunalne

Nazwa Ścieżka Typ Opis
klucz
key string

Klucz stowarzyszenia miejskiego (9 cyfr).

nazwa
name string

Nazwa stowarzyszenia komunalnego.

typ
type string

Kod stowarzyszenia miejskiego (np. "Amt", "Verbandsgemeinde").

administracyjneheadquarters
administrativeHeadquarters string

Siedziba administracyjna stowarzyszenia miejskiego.

dzielnica
district DistrictSummary

Podsumowanie okręgu

governmentRegion
governmentRegion GovernmentRegionSummary

Podsumowanie regionu rządowego

federalState
federalState FederalStateSummary

Podsumowanie stanu federalnego

MunicipalAssociationSummary

Podsumowanie stowarzyszenia komunalnego

Nazwa Ścieżka Typ Opis
klucz
key string
nazwa
name string
typ
type string

Gmina

Gmina

Nazwa Ścieżka Typ Opis
klucz
key string

Klucz regionalny gminy (8 cyfr).

nazwa
name string

Nazwa gminy.

typ
type string

Kod gminy (np. miasto, miasto targowe, miasto wolne od dzielnicy itp.).

postalCode
postalCode string

Kod pocztowy administracji miejskiej.

multiplePostalCodes
multiplePostalCodes boolean

Czy gminy obejmuje więcej niż jeden kod pocztowy?

skojarzenie
association MunicipalAssociationSummary

Podsumowanie stowarzyszenia komunalnego

dzielnica
district DistrictSummary

Podsumowanie okręgu

governmentRegion
governmentRegion GovernmentRegionSummary

Podsumowanie regionu rządowego

federalState
federalState FederalStateSummary

Podsumowanie stanu federalnego

GminySummary

Podsumowanie gminy

Nazwa Ścieżka Typ Opis
klucz
key string
nazwa
name string
typ
type string

Miejscowość

Miejscowość

Nazwa Ścieżka Typ Opis
nazwa
name string

Nazwa lokalizacji.

postalCode
postalCode string

Kod pocztowy lokalizacji.

gmina
municipality MunicipalitySummary

Podsumowanie gminy

dzielnica
district DistrictSummary

Podsumowanie okręgu

governmentRegion
governmentRegion GovernmentRegionSummary

Podsumowanie regionu rządowego

federalState
federalState FederalStateSummary

Podsumowanie stanu federalnego

Ulica

Ulica

Nazwa Ścieżka Typ Opis
nazwa
name string

Nazwa ulicy.

postalCode
postalCode string

Kod pocztowy.

miejscowość
locality string

Nazwa lokalizacji.

dzielnica
borough string

Dzielnica miasta (jeśli jest dostępna).

przedmieście
suburb string

Przedmieścia lub kwartał (jeśli jest dostępny).

gmina
municipality MunicipalitySummary

Podsumowanie gminy

dzielnica
district DistrictSummary

Podsumowanie okręgu

governmentRegion
governmentRegion GovernmentRegionSummary

Podsumowanie regionu rządowego

federalState
federalState FederalStateSummary

Podsumowanie stanu federalnego

GminyLI

Gminy w Liechtensteinie

Nazwa Ścieżka Typ Opis
klucz
key string

Numer gminy (4 cyfry).

nazwa
name string

Oficjalna nazwa gminy.

wyborów
electoralDistrict string

Okręg wyborczy – Oberland lub Unterland.

LokalnośćLI

Lokalizacja w Liechtensteinie

Nazwa Ścieżka Typ Opis
nazwa
name string

Nazwa lokalizacji.

postalCode
postalCode string

Kod pocztowy lokalizacji.

klucz
commune.key string

Numer gminy (4 cyfry).

nazwa
commune.name string

Oficjalna nazwa gminy.

StreetLI

Ulica w Liechtensteinie

Nazwa Ścieżka Typ Opis
klucz
key string

Klucz ulicy.

nazwa
name string

Nazwa ulicy.

stan
status string

Stan ulicy (Planowany, Rzeczywisty, Nieaktualny).

postalCode
postalCode string

Kod pocztowy.

miejscowość
locality string

Nazwa lokalizacji.

klucz
commune.key string

Numer gminy (4 cyfry).

nazwa
commune.name string

Oficjalna nazwa gminy.

KantonCH

Kanton Szwajcarii

Nazwa Ścieżka Typ Opis
klucz
key string

Liczba BFS kantonu (maksymalnie 2 cyfry).

historicalCode
historicalCode string

Historyczny kod kantonu.

nazwa
name string

Nazwa kantonu.

shortName
shortName string

Skrót kantonu (2 litery).

KantonCHSummary

Podsumowanie szwajcarskiego kantonu

Nazwa Ścieżka Typ Opis
klucz
key string

Liczba BFS kantonu (maksymalnie 2 cyfry).

nazwa
name string

Nazwa kantonu.

shortName
shortName string

Skrót kantonu (2 litery).

DistrictCH

Dzielnica w Szwajcarii

Nazwa Ścieżka Typ Opis
klucz
key string

Liczba BFS okręgu (maksymalnie 4 cyfry).

historicalCode
historicalCode string

Historyczny kod okręgu.

nazwa
name string

Nazwa dzielnicy.

shortName
shortName string

Krótka nazwa dzielnicy.

Canton
canton CantonCHSummary

Podsumowanie szwajcarskiego kantonu

DistrictCHSummary

Podsumowanie szwajcarskiej dzielnicy

Nazwa Ścieżka Typ Opis
klucz
key string

Liczba BFS okręgu (maksymalnie 4 cyfry).

nazwa
name string

Nazwa dzielnicy.

shortName
shortName string

Krótka nazwa dzielnicy.

Gminy

Gminy w Szwajcarii

Nazwa Ścieżka Typ Opis
klucz
key string

Liczba BFS gminy (maksymalnie 4 cyfry).

historicalCode
historicalCode string

Kod historyczny gminy.

nazwa
name string

Oficjalna nazwa gminy.

shortName
shortName string

Krótka nazwa gminy.

dzielnica
district DistrictCHSummary

Podsumowanie szwajcarskiej dzielnicy

Canton
canton CantonCHSummary

Podsumowanie szwajcarskiego kantonu

GminyCHSummary

Podsumowanie szwajcarskiej gminy

Nazwa Ścieżka Typ Opis
klucz
key string

Liczba BFS gminy (maksymalnie 4 cyfry).

nazwa
name string

Nazwa gminy.

shortName
shortName string

Krótka nazwa gminy.

LocalityCH

Lokalizacja w Szwajcarii

Nazwa Ścieżka Typ Opis
klucz
key string

Identyfikator lokalizacji.

nazwa
name string

Nazwa lokalizacji.

kod pocztowy
postalcode string

Kod pocztowy lokalizacji.

Gminy
commune CommuneCHSummary

Podsumowanie szwajcarskiej gminy

dzielnica
district DistrictCHSummary

Podsumowanie szwajcarskiej dzielnicy

Canton
canton CantonCHSummary

Podsumowanie szwajcarskiego kantonu

StreetCH

Ulica w Szwajcarii

Nazwa Ścieżka Typ Opis
klucz
key string

Klucz ulicy.

nazwa
name string

Nazwa ulicy.

stan
status string

Stan ulicy. Możliwe wartości: Planowana, Rzeczywista, Nieaktualna.

kod pocztowy
postalcode string

Kod pocztowy lokalizacji.

miejscowość
locality string

Nazwa lokalizacji.

Gminy
commune CommuneCHSummary

Podsumowanie szwajcarskiej gminy

dzielnica
district DistrictCHSummary

Podsumowanie szwajcarskiej dzielnicy

Canton
canton CantonCHSummary

Podsumowanie szwajcarskiego kantonu

FederalProvinceAT

Prowincja federalna w Austrii

Nazwa Ścieżka Typ Opis
klucz
key string

Identyfikator prowincji federalnej (1 cyfra).

nazwa
name string

Nazwa prowincji federalnej.

FederalProvinceATSummary

Podsumowanie austriackiej prowincji federalnej

Nazwa Ścieżka Typ Opis
klucz
key string

Identyfikator prowincji federalnej (1 cyfra).

nazwa
name string

Nazwa prowincji federalnej.

DistrictAT

Powiat w Austrii

Nazwa Ścieżka Typ Opis
klucz
key string

Identyfikator okręgu (3 cyfry).

kod
code string

Kod okręgowy (3 cyfry).

nazwa
name string

Nazwa dzielnicy.

federalProvince
federalProvince FederalProvinceATSummary

Podsumowanie austriackiej prowincji federalnej

DistrictATSummary

Podsumowanie austriackiej dzielnicy

Nazwa Ścieżka Typ Opis
klucz
key string

Identyfikator okręgu (3 cyfry).

kod
code string

Kod okręgowy (3 cyfry).

nazwa
name string

Nazwa dzielnicy.

Gminy

Miejscowość w Austrii

Nazwa Ścieżka Typ Opis
klucz
key string

Identyfikator gminy (5 cyfr).

kod
code string

Kod gminy (5 cyfr).

nazwa
name string

Nazwa gminy.

stan
status string

Status gminy (np. miasto, miasto targowe itp.).

postalCode
postalCode string

Kod pocztowy urzędu miejskiego.

multiplePostalCodes
multiplePostalCodes boolean

Czy gminy obejmuje więcej niż jeden kod pocztowy?

dzielnica
district DistrictATSummary

Podsumowanie austriackiej dzielnicy

federalProvince
federalProvince FederalProvinceATSummary

Podsumowanie austriackiej prowincji federalnej

GminyATSummary

Podsumowanie austriackiej gminy

Nazwa Ścieżka Typ Opis
klucz
key string

Identyfikator gminy (5 cyfr).

kod
code string

Kod gminy (5 cyfr).

nazwa
name string

Nazwa gminy.

LokalnośćAT

Lokalizacja w Austrii

Nazwa Ścieżka Typ Opis
klucz
key string

Identyfikator lokalizacji.

nazwa
name string

Nazwa lokalizacji.

kod pocztowy
postalcode string

Kod pocztowy lokalizacji.

gmina
municipality MunicipalityATSummary

Podsumowanie austriackiej gminy

dzielnica
district DistrictATSummary

Podsumowanie austriackiej dzielnicy

federalProvince
federalProvince FederalProvinceATSummary

Podsumowanie austriackiej prowincji federalnej

StreetAT

Ulica w Austrii

Nazwa Ścieżka Typ Opis
klucz
key string

Identyfikator ulicy.

nazwa
name string

Nazwa ulicy.

kod pocztowy
postalcode string

Kod pocztowy lokalizacji.

miejscowość
locality string

Nazwa lokalizacji.

gmina
municipality MunicipalityATSummary

Podsumowanie austriackiej gminy

dzielnica
district DistrictATSummary

Podsumowanie austriackiej dzielnicy

federalProvince
federalProvince FederalProvinceATSummary

Podsumowanie austriackiej prowincji federalnej