OpenPLZ (Independent Publisher) (Preview)
OpenPLZ API – Public street and postal code API for Germany, Liechtenstein, Switzerland and Austria.
Documentation: https://www.openplzapi.org/de/germany/
This connector is available in the following products and regions:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Logic Apps | Standard | All Logic Apps regions except the following: - Azure Government regions - Azure China regions - US Department of Defense (DoD) |
| Power Apps | Premium | All Power Apps regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Power Automate | Premium | All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Contact | |
|---|---|
| Name | OpenPLZ API |
| URL | https://www.openplzapi.org |
| Connector Metadata | |
|---|---|
| Publisher | LowCodeInvestigator |
| Website | https://www.openplzapi.org |
| Privacy policy | https://www.openplzapi.org/legal/privacy-policy |
| Categories | Data |
| Visibility | Important |
OpenPLZ API Connector
The OpenPLZ API Connector provides structured access to postal codes, streets, administrative divisions, and locality data for Germany, Switzerland, Austria, and Liechtenstein. It enables Microsoft Power Platform solutions to query reliable and normalized location datasets in a REST-based format.
This connector exposes multiple read-only operations that allow retrieval of hierarchical information such as federal states, cantons, districts, municipalities, localities, postal codes, and streets.
Publisher
Supported Features
The OpenPLZ API Connector supports the following capabilities:
- Retrieve administrative hierarchies (federal states, cantons, districts, municipalities, municipal associations, localities)
- Perform postal code lookups
- Query street directories
- Work with cross-country coverage (Germany, Switzerland, Austria, Liechtenstein)
- Consume consistent JSON response formats suitable for automation and validation
Prerequisites
There are no prerequisites required to use this connector:
- No API key
- No OAuth
- No authentication
- No subscription
The API is publicly accessible.
How to Use the Connector
- Add the OpenPLZ API Connector to your Power App or Power Automate flow.
- Choose one of the available actions.
- Provide the required parameters.
- Use the returned JSON data in your workflow or app (for example, to populate dropdown lists, validate addresses, or store structured location data).
Connection Information
The connector uses a single anonymous connection. No credentials are required.
Known Limitations
- Read-only API (only GET operations are available)
- Potential rate limiting for excessive or high-frequency requests
- No geocoordinates or polygon boundary data
- Administrative and locality names follow German-language naming conventions
API Documentation
- General documentation
- Germany documentation
- Switzerland documentation
- Austria documentation
- Liechtenstein is included in the Switzerland documentation
Recommended API Call Order per Country
The following sections describe a recommended sequence of API calls to retrieve hierarchical administrative structures in a logical order for each country.
Germany (DE)
Germany – Base Data
- GET /de/FederalStates (List all federal states (Germany))
Germany – Federal State Level (using federalStateKey)
- GET /de/FederalStates/{federalStateKey}/GovernmentRegions (List government regions of a federal state (Germany))
- GET /de/FederalStates/{federalStateKey}/Districts (List districts of a federal state (Germany))
- GET /de/FederalStates/{federalStateKey}/Municipalities (List municipalities of a federal state (Germany))
- GET /de/FederalStates/{federalStateKey}/MunicipalAssociations (List municipal associations of a federal state (Germany))
- GET /de/FederalStates/{federalStateKey}/Localities (List localities of a federal state (Germany))
Germany – Government Region Level (using governmentRegionKey)
- GET /de/GovernmentRegions/{governmentRegionKey}/Districts (List districts of a government region (Germany))
- GET /de/GovernmentRegions/{governmentRegionKey}/Municipalities (List municipalities of a government region (Germany))
- GET /de/GovernmentRegions/{governmentRegionKey}/MunicipalAssociations (List municipal associations of a government region (Germany))
- GET /de/GovernmentRegions/{governmentRegionKey}/Localities (List localities of a government region (Germany))
Germany – District Level (using districtKey)
- GET /de/Districts/{districtKey}/Municipalities (List municipalities of a district (Germany))
- GET /de/Districts/{districtKey}/MunicipalAssociations (List municipal associations of a district (Germany))
- GET /de/Districts/{districtKey}/Localities (List localities of a district (Germany))
Germany – Search Endpoints
- GET /de/Localities (Search localities and postal codes (Germany))
- GET /de/Streets (Search streets (Germany))
- GET /de/FullTextSearch (Full-text search for streets, postal codes and localities (Germany))
Liechtenstein (LI)
Liechtenstein – Base Data
- GET /li/Communes (List all communes (Liechtenstein))
Liechtenstein – Search Endpoints
- GET /li/Localities (Search localities and postal codes (Liechtenstein))
- GET /li/Streets (Search streets (Liechtenstein))
- GET /li/FullTextSearch (Full-text search for streets (Liechtenstein))
Switzerland (CH)
Switzerland – Base Data
- GET /ch/Cantons (List all cantons (Switzerland))
Switzerland – Canton Level (using cantonKey)
- GET /ch/Cantons/{cantonKey}/Districts (List districts of a canton (Switzerland))
- GET /ch/Cantons/{cantonKey}/Communes (List communes of a canton (Switzerland))
- GET /ch/Cantons/{cantonKey}/Localities (List localities of a canton (Switzerland))
Switzerland – District Level (using districtKey)
- GET /ch/Districts/{districtKey}/Communes (List communes of a district (Switzerland))
- GET /ch/Districts/{districtKey}/Localities (List localities of a district (Switzerland))
Switzerland – Search Endpoints
- GET /ch/Localities (Search localities and postal codes (Switzerland))
- GET /ch/Streets (Search streets (Switzerland))
- GET /ch/FullTextSearch (Full-text search for streets (Switzerland))
Austria (AT)
Austria – Base Data
- GET /at/FederalProvinces (List all federal provinces (Austria))
Austria – Federal Province Level (using federalProvinceKey)
- GET /at/FederalProvinces/{federalProvinceKey}/Districts (List districts of a federal province (Austria))
- GET /at/FederalProvinces/{federalProvinceKey}/Municipalities (List municipalities of a federal province (Austria))
- GET /at/FederalProvinces/{federalProvinceKey}/Localities (List localities of a federal province (Austria))
Austria – District Level (using districtKey)
- GET /at/Districts/{districtKey}/Municipalities (List municipalities of a district (Austria))
- GET /at/Districts/{districtKey}/Localities (List localities of a district (Austria))
Austria – Search Endpoints
- GET /at/Localities (Search localities and postal codes (Austria))
- GET /at/Streets (Search streets (Austria))
- GET /at/FullTextSearch (Full-text search for streets (Austria))
Throttling Limits
| Name | Calls | Renewal Period |
|---|---|---|
| API calls per connection | 100 | 60 seconds |
Actions
| Full-text search for streets, postal codes and localities (Germany) |
Full-text search across street names, postal codes and locality names in Germany. |
| Full-text search for streets (Austria) |
Full-text search across street name, postal code and locality name for the Austrian data directory. |
| Full-text search for streets (Liechtenstein) |
Full-text search across street name, postal code and locality name in Liechtenstein. |
| Full-text search for streets (Switzerland) |
Full-text search across street names, postal codes and locality names in Switzerland. |
| List all cantons (Switzerland) |
Returns all 26 cantons of Switzerland. |
| List all communes (Liechtenstein) |
Returns all 11 communes of the Principality of Liechtenstein. |
| List all federal provinces (Austria) |
Returns all 9 federal provinces in Austria. |
| List all federal states (Germany) |
Returns all German federal states. |
| List communes of a canton (Switzerland) |
Returns all communes within a Swiss canton. |
| List communes of a district (Switzerland) |
Returns all communes within a Swiss district. |
| List districts of a canton (Switzerland) |
Returns all districts within a Swiss canton. |
| List districts of a federal province (Austria) |
Returns all districts within an Austrian federal province. |
| List districts of a federal state (Germany) |
Returns all districts within a German federal state. |
| List districts of a government region (Germany) |
Returns all districts within a German government region. |
| List government regions of a federal state (Germany) |
Returns all government regions within a German federal state. |
| List localities of a canton (Switzerland) |
Returns all localities within a Swiss canton. |
| List localities of a district (Austria) |
Returns all localities within an Austrian district. |
| List localities of a district (Germany) |
Returns all localities within a German district. |
| List localities of a district (Switzerland) |
Returns all localities within a Swiss district. |
| List localities of a federal province (Austria) |
Returns all localities within an Austrian federal province. |
| List localities of a federal state (Germany) |
Returns all localities within a German federal state. |
| List localities of a government region (Germany) |
Returns all localities within a German government region. |
| List municipal associations of a district (Germany) |
Returns all municipal associations within a German district. |
| List municipal associations of a federal state (Germany) |
Returns all municipal associations within a German federal state. |
| List municipal associations of a government region (Germany) |
Returns all municipal associations within a German government region. |
| List municipalities of a district (Austria) |
Returns all municipalities within an Austrian district. |
| List municipalities of a district (Germany) |
Returns all municipalities within a German district. |
| List municipalities of a federal province (Austria) |
Returns all municipalities within an Austrian federal province. |
| List municipalities of a federal state (Germany) |
Returns all municipalities within a German federal state. |
| List municipalities of a government region (Germany) |
Returns all municipalities within a German government region. |
| Search localities and postal codes (Austria) |
Searches for localities in Austria by postal code and/or locality name. Both parameters support regular expressions. |
| Search localities and postal codes (Germany) |
Searches for localities in Germany by postal code and/or locality name. Both parameters support regular expressions. |
| Search localities and postal codes (Liechtenstein) |
Searches for localities in Liechtenstein by postal code and/or locality name. Regular expressions are supported. |
| Search localities and postal codes (Switzerland) |
Searches for localities in Switzerland by postal code and/or locality name. Both parameters support regular expressions. |
| Search streets (Austria) |
Searches for streets in Austria by street name and/or postal code and/or locality name. All parameters support regular expressions. |
| Search streets (Germany) |
Searches for streets in Germany by street name and/or postal code and/or locality name. All parameters support regular expressions. |
| Search streets (Liechtenstein) |
Searches for streets in Liechtenstein by street name and/or postal code and/or locality. Regular expressions are supported. |
| Search streets (Switzerland) |
Searches for streets in Switzerland by street name and/or postal code and/or locality name. All parameters support regular expressions. |
Full-text search for streets, postal codes and localities (Germany)
Full-text search across street names, postal codes and locality names in Germany.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Search term
|
searchTerm | True | string |
Search term, e.g. 'Berlin Pariser Platz'. |
|
Page index
|
page | integer |
Page index (default: 1). |
|
|
Page size
|
pageSize | integer |
Number of items per page (default: 50, max: 50). |
Returns
- response
- array of Street
Full-text search for streets (Austria)
Full-text search across street name, postal code and locality name for the Austrian data directory.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Search term
|
searchTerm | True | string |
Search term, e.g. 'Wien Alfred Dallinger Platz'. |
|
Page index
|
page | integer |
Page index (default: 1). |
|
|
Page size
|
pageSize | integer |
Number of items per page (default: 50, max: 50). |
Returns
- response
- array of StreetAT
Full-text search for streets (Liechtenstein)
Full-text search across street name, postal code and locality name in Liechtenstein.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Search term
|
searchTerm | True | string |
Search term, e.g. '9490 Alte Landstrasse'. |
|
Page index
|
page | integer |
Page index (default: 1). |
|
|
Page size
|
pageSize | integer |
Number of items per page (default: 50, max: 50). |
Returns
- response
- array of StreetLI
Full-text search for streets (Switzerland)
Full-text search across street names, postal codes and locality names in Switzerland.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Search term
|
searchTerm | True | string |
Search term, e.g. 'Zürich Bederstrasse'. |
|
Page index
|
page | integer |
Page index (default: 1). |
|
|
Page size
|
pageSize | integer |
Number of items per page (default: 50, max: 50). |
Returns
- response
- array of StreetCH
List all cantons (Switzerland)
List all communes (Liechtenstein)
List all federal provinces (Austria)
List all federal states (Germany)
List communes of a canton (Switzerland)
Returns all communes within a Swiss canton.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Canton key
|
cantonKey | True | string |
BFS number of the canton (max. 2 digits). |
|
Page index
|
page | integer |
Page index (default: 1). |
|
|
Page size
|
pageSize | integer |
Number of items per page (default: 50, max: 50). |
Returns
- response
- array of CommuneCH
List communes of a district (Switzerland)
Returns all communes within a Swiss district.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
District key
|
districtKey | True | string |
BFS number of the district (max. 4 digits). |
|
Page index
|
page | integer |
Page index (default: 1). |
|
|
Page size
|
pageSize | integer |
Number of items per page (default: 50, max: 50). |
Returns
- response
- array of CommuneCH
List districts of a canton (Switzerland)
Returns all districts within a Swiss canton.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Canton key
|
cantonKey | True | string |
BFS number of the canton (max. 2 digits), e.g. '10' for Fribourg. |
|
Page index
|
page | integer |
Page index (default: 1). |
|
|
Page size
|
pageSize | integer |
Number of items per page (default: 50, max: 50). |
Returns
- response
- array of DistrictCH
List districts of a federal province (Austria)
Returns all districts within an Austrian federal province.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Federal province key
|
federalProvinceKey | True | string |
Federal province identifier (1 digit). |
|
Page index
|
page | integer |
Page index (default: 1). |
|
|
Page size
|
pageSize | integer |
Number of items per page (default: 50, max: 50). |
Returns
- response
- array of DistrictAT
List districts of a federal state (Germany)
Returns all districts within a German federal state.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Federal state key
|
federalStateKey | True | string |
Regional key of the federal state (2 digits). |
|
Page index
|
page | integer |
Page index (default: 1). |
|
|
Page size
|
pageSize | integer |
Number of items per page (default: 50, max: 50). |
Returns
- response
- array of District
List districts of a government region (Germany)
Returns all districts within a German government region.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Government region key
|
governmentRegionKey | True | string |
Regional key of the government region (3 digits). |
|
Page index
|
page | integer |
Page index (default: 1). |
|
|
Page size
|
pageSize | integer |
Number of items per page (default: 50, max: 50). |
Returns
- response
- array of District
List government regions of a federal state (Germany)
Returns all government regions within a German federal state.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Federal state key
|
federalStateKey | True | string |
Regional key of the federal state (2 digits), e.g. '09' for Bavaria. |
|
Page index
|
page | integer |
Page index (default: 1). |
|
|
Page size
|
pageSize | integer |
Number of items per page (default: 50, max: 50). |
Returns
- response
- array of GovernmentRegion
List localities of a canton (Switzerland)
Returns all localities within a Swiss canton.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Canton key
|
cantonKey | True | string |
BFS number of the canton (max. 2 digits). |
|
Page index
|
page | integer |
Page index (default: 1). |
|
|
Page size
|
pageSize | integer |
Number of items per page (default: 50, max: 50). |
Returns
- response
- array of LocalityCH
List localities of a district (Austria)
Returns all localities within an Austrian district.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
District key
|
districtKey | True | string |
District identifier or district code (3 digits). |
|
Page index
|
page | integer |
Page index (default: 1). |
|
|
Page size
|
pageSize | integer |
Number of items per page (default: 50, max: 50). |
Returns
- response
- array of LocalityAT
List localities of a district (Germany)
Returns all localities within a German district.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
District key
|
districtKey | True | string |
Regional key of the district (5 digits). |
|
Page index
|
page | integer |
Page index (default: 1). |
|
|
Page size
|
pageSize | integer |
Number of items per page (default: 50, max: 50). |
Returns
- response
- array of Locality
List localities of a district (Switzerland)
Returns all localities within a Swiss district.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
District key
|
districtKey | True | string |
BFS number of the district (max. 4 digits). |
|
Page index
|
page | integer |
Page index (default: 1). |
|
|
Page size
|
pageSize | integer |
Number of items per page (default: 50, max: 50). |
Returns
- response
- array of LocalityCH
List localities of a federal province (Austria)
Returns all localities within an Austrian federal province.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Federal province key
|
federalProvinceKey | True | string |
Federal province identifier (1 digit). |
|
Page index
|
page | integer |
Page index (default: 1). |
|
|
Page size
|
pageSize | integer |
Number of items per page (default: 50, max: 50). |
Returns
- response
- array of LocalityAT
List localities of a federal state (Germany)
Returns all localities within a German federal state.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Federal state key
|
federalStateKey | True | string |
Regional key of the federal state (2 digits). |
|
Page index
|
page | integer |
Page index (default: 1). |
|
|
Page size
|
pageSize | integer |
Number of items per page (default: 50, max: 50). |
Returns
- response
- array of Locality
List localities of a government region (Germany)
Returns all localities within a German government region.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Government region key
|
governmentRegionKey | True | string |
Regional key of the government region (3 digits). |
|
Page index
|
page | integer |
Page index (default: 1). |
|
|
Page size
|
pageSize | integer |
Number of items per page (default: 50, max: 50). |
Returns
- response
- array of Locality
List municipal associations of a district (Germany)
Returns all municipal associations within a German district.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
District key
|
districtKey | True | string |
Regional key of the district (5 digits). |
|
Page index
|
page | integer |
Page index (default: 1). |
|
|
Page size
|
pageSize | integer |
Number of items per page (default: 50, max: 50). |
Returns
- response
- array of MunicipalAssociation
List municipal associations of a federal state (Germany)
Returns all municipal associations within a German federal state.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Federal state key
|
federalStateKey | True | string |
Regional key of the federal state (2 digits). |
|
Page index
|
page | integer |
Page index (default: 1). |
|
|
Page size
|
pageSize | integer |
Number of items per page (default: 50, max: 50). |
Returns
- response
- array of MunicipalAssociation
List municipal associations of a government region (Germany)
Returns all municipal associations within a German government region.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Government region key
|
governmentRegionKey | True | string |
Regional key of the government region (3 digits). |
|
Page index
|
page | integer |
Page index (default: 1). |
|
|
Page size
|
pageSize | integer |
Number of items per page (default: 50, max: 50). |
Returns
- response
- array of MunicipalAssociation
List municipalities of a district (Austria)
Returns all municipalities within an Austrian district.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
District key
|
districtKey | True | string |
District identifier or district code (3 digits). |
|
Page index
|
page | integer |
Page index (default: 1). |
|
|
Page size
|
pageSize | integer |
Number of items per page (default: 50, max: 50). |
Returns
- response
- array of MunicipalityAT
List municipalities of a district (Germany)
Returns all municipalities within a German district.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
District key
|
districtKey | True | string |
Regional key of the district (5 digits). |
|
Page index
|
page | integer |
Page index (default: 1). |
|
|
Page size
|
pageSize | integer |
Number of items per page (default: 50, max: 50). |
Returns
- response
- array of Municipality
List municipalities of a federal province (Austria)
Returns all municipalities within an Austrian federal province.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Federal province key
|
federalProvinceKey | True | string |
Federal province identifier (1 digit). |
|
Page index
|
page | integer |
Page index (default: 1). |
|
|
Page size
|
pageSize | integer |
Number of items per page (default: 50, max: 50). |
Returns
- response
- array of MunicipalityAT
List municipalities of a federal state (Germany)
Returns all municipalities within a German federal state.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Federal state key
|
federalStateKey | True | string |
Regional key of the federal state (2 digits). |
|
Page index
|
page | integer |
Page index (default: 1). |
|
|
Page size
|
pageSize | integer |
Number of items per page (default: 50, max: 50). |
Returns
- response
- array of Municipality
List municipalities of a government region (Germany)
Returns all municipalities within a German government region.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Government region key
|
governmentRegionKey | True | string |
Regional key of the government region (3 digits). |
|
Page index
|
page | integer |
Page index (default: 1). |
|
|
Page size
|
pageSize | integer |
Number of items per page (default: 50, max: 50). |
Returns
- response
- array of Municipality
Search localities and postal codes (Austria)
Searches for localities in Austria by postal code and/or locality name. Both parameters support regular expressions.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Postal code
|
postalCode | string |
Postal code or regular expression (e.g. '^10'). |
|
|
Locality name
|
name | string |
Locality name or regular expression. |
|
|
Page index
|
page | integer |
Page index (default: 1). |
|
|
Page size
|
pageSize | integer |
Number of items per page (default: 50, max: 50). |
Returns
- response
- array of LocalityAT
Search localities and postal codes (Germany)
Searches for localities in Germany by postal code and/or locality name. Both parameters support regular expressions.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Postal code
|
postalCode | string |
Postal code or regular expression (e.g. '^13'). |
|
|
Locality name
|
name | string |
Locality name or regular expression. |
|
|
Page index
|
page | integer |
Page index (default: 1). |
|
|
Page size
|
pageSize | integer |
Number of items per page (default: 50, max: 50). |
Returns
- response
- array of Locality
Search localities and postal codes (Liechtenstein)
Searches for localities in Liechtenstein by postal code and/or locality name. Regular expressions are supported.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Postal code
|
postalCode | string |
Postal code or regular expression, e.g. '^94'. |
|
|
Locality name
|
name | string |
Locality name or regular expression. |
|
|
Page index
|
page | integer |
Page index (default: 1). |
|
|
Page size
|
pageSize | integer |
Number of items per page (default: 50, max: 50). |
Returns
- response
- array of LocalityLI
Search localities and postal codes (Switzerland)
Searches for localities in Switzerland by postal code and/or locality name. Both parameters support regular expressions.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Postal code
|
postalCode | string |
Postal code or regular expression (e.g. '^80'). |
|
|
Locality name
|
name | string |
Locality name or regular expression. |
|
|
Page index
|
page | integer |
Page index (default: 1). |
|
|
Page size
|
pageSize | integer |
Number of items per page (default: 50, max: 50). |
Returns
- response
- array of LocalityCH
Search streets (Austria)
Searches for streets in Austria by street name and/or postal code and/or locality name. All parameters support regular expressions.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Street name
|
name | string |
Street name or regular expression. |
|
|
Postal code
|
postalCode | string |
Postal code or regular expression. |
|
|
Locality name
|
locality | string |
Locality name or regular expression. |
|
|
Page index
|
page | integer |
Page index (default: 1). |
|
|
Page size
|
pageSize | integer |
Number of items per page (default: 50, max: 50). |
Returns
- response
- array of StreetAT
Search streets (Germany)
Searches for streets in Germany by street name and/or postal code and/or locality name. All parameters support regular expressions.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Street name
|
name | string |
Street name or regular expression. |
|
|
Postal code
|
postalCode | string |
Postal code or regular expression. |
|
|
Locality name
|
locality | string |
Locality name or regular expression. |
|
|
Page index
|
page | integer |
Page index (default: 1). |
|
|
Page size
|
pageSize | integer |
Number of items per page (default: 50, max: 50). |
Returns
- response
- array of Street
Search streets (Liechtenstein)
Searches for streets in Liechtenstein by street name and/or postal code and/or locality. Regular expressions are supported.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Street name
|
name | string |
Street name or regular expression. |
|
|
Postal code
|
postalCode | string |
Postal code or regular expression. |
|
|
Locality name
|
locality | string |
Locality name or regular expression. |
|
|
Page index
|
page | integer |
Page index (default: 1). |
|
|
Page size
|
pageSize | integer |
Number of items per page (default: 50, max: 50). |
Returns
- response
- array of StreetLI
Search streets (Switzerland)
Searches for streets in Switzerland by street name and/or postal code and/or locality name. All parameters support regular expressions.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Street name
|
name | string |
Street name or regular expression. |
|
|
Postal code
|
postalCode | string |
Postal code or regular expression. |
|
|
Locality name
|
locality | string |
Locality name or regular expression. |
|
|
Page index
|
page | integer |
Page index (default: 1). |
|
|
Page size
|
pageSize | integer |
Number of items per page (default: 50, max: 50). |
Returns
- response
- array of StreetCH
Definitions
FederalState
German federal state
| Name | Path | Type | Description |
|---|---|---|---|
|
key
|
key | string |
Regional key (2 digits). |
|
name
|
name | string |
Name of the federal state. |
|
seatOfGovernment
|
seatOfGovernment | string |
Seat of government of the federal state. |
GovernmentRegion
Government region
| Name | Path | Type | Description |
|---|---|---|---|
|
key
|
key | string |
Regional key (3 digits). |
|
name
|
name | string |
Name of the government region. |
|
administrativeHeadquarters
|
administrativeHeadquarters | string |
Administrative headquarters of the government region. |
|
federalState
|
federalState | FederalStateSummary |
Summary of a federal state |
GovernmentRegionSummary
Summary of a government region
| Name | Path | Type | Description |
|---|---|---|---|
|
key
|
key | string |
Regional key (3 digits). |
|
name
|
name | string |
Name of the government region. |
FederalStateSummary
Summary of a federal state
| Name | Path | Type | Description |
|---|---|---|---|
|
key
|
key | string |
Regional key (2 digits). |
|
name
|
name | string |
Name of the federal state. |
District
District
| Name | Path | Type | Description |
|---|---|---|---|
|
key
|
key | string |
Regional key of the district (5 digits). |
|
name
|
name | string |
Name of the district. |
|
type
|
type | string |
Type of the district (e.g. 'Landkreis', 'Kreisfreie Stadt'). |
|
administrativeHeadquarters
|
administrativeHeadquarters | string |
Administrative headquarters of the district. |
|
governmentRegion
|
governmentRegion | GovernmentRegionSummary |
Summary of a government region |
|
federalState
|
federalState | FederalStateSummary |
Summary of a federal state |
DistrictSummary
Summary of a district
| Name | Path | Type | Description |
|---|---|---|---|
|
key
|
key | string |
Regional key of the district (5 digits). |
|
name
|
name | string |
Name of the district. |
MunicipalAssociation
Municipal association
| Name | Path | Type | Description |
|---|---|---|---|
|
key
|
key | string |
Key of the municipal association (9 digits). |
|
name
|
name | string |
Name of the municipal association. |
|
type
|
type | string |
Code of the municipal association (e.g. 'Amt', 'Verbandsgemeinde'). |
|
administrativeHeadquarters
|
administrativeHeadquarters | string |
Administrative headquarters of the municipal association. |
|
district
|
district | DistrictSummary |
Summary of a district |
|
governmentRegion
|
governmentRegion | GovernmentRegionSummary |
Summary of a government region |
|
federalState
|
federalState | FederalStateSummary |
Summary of a federal state |
MunicipalAssociationSummary
Summary of a municipal association
| Name | Path | Type | Description |
|---|---|---|---|
|
key
|
key | string | |
|
name
|
name | string | |
|
type
|
type | string |
Municipality
Municipality
| Name | Path | Type | Description |
|---|---|---|---|
|
key
|
key | string |
Regional key of the municipality (8 digits). |
|
name
|
name | string |
Name of the municipality. |
|
type
|
type | string |
Code of the municipality (e.g. city, market town, district-free city, etc.). |
|
postalCode
|
postalCode | string |
Postal code of the municipal administration. |
|
multiplePostalCodes
|
multiplePostalCodes | boolean |
Does the municipality cover more than one postal code? |
|
association
|
association | MunicipalAssociationSummary |
Summary of a municipal association |
|
district
|
district | DistrictSummary |
Summary of a district |
|
governmentRegion
|
governmentRegion | GovernmentRegionSummary |
Summary of a government region |
|
federalState
|
federalState | FederalStateSummary |
Summary of a federal state |
MunicipalitySummary
Summary of a municipality
| Name | Path | Type | Description |
|---|---|---|---|
|
key
|
key | string | |
|
name
|
name | string | |
|
type
|
type | string |
Locality
Locality
| Name | Path | Type | Description |
|---|---|---|---|
|
name
|
name | string |
Name of the locality. |
|
postalCode
|
postalCode | string |
Postal code of the locality. |
|
municipality
|
municipality | MunicipalitySummary |
Summary of a municipality |
|
district
|
district | DistrictSummary |
Summary of a district |
|
governmentRegion
|
governmentRegion | GovernmentRegionSummary |
Summary of a government region |
|
federalState
|
federalState | FederalStateSummary |
Summary of a federal state |
Street
Street
| Name | Path | Type | Description |
|---|---|---|---|
|
name
|
name | string |
Street name. |
|
postalCode
|
postalCode | string |
Postal code. |
|
locality
|
locality | string |
Locality name. |
|
borough
|
borough | string |
City borough (if available). |
|
suburb
|
suburb | string |
Suburb or quarter (if available). |
|
municipality
|
municipality | MunicipalitySummary |
Summary of a municipality |
|
district
|
district | DistrictSummary |
Summary of a district |
|
governmentRegion
|
governmentRegion | GovernmentRegionSummary |
Summary of a government region |
|
federalState
|
federalState | FederalStateSummary |
Summary of a federal state |
CommuneLI
Commune in Liechtenstein
| Name | Path | Type | Description |
|---|---|---|---|
|
key
|
key | string |
Commune number (4 digits). |
|
name
|
name | string |
Official name of the commune. |
|
electoralDistrict
|
electoralDistrict | string |
Electoral district – Oberland or Unterland. |
LocalityLI
Locality in Liechtenstein
| Name | Path | Type | Description |
|---|---|---|---|
|
name
|
name | string |
Name of the locality. |
|
postalCode
|
postalCode | string |
Postal code of the locality. |
|
key
|
commune.key | string |
Commune number (4 digits). |
|
name
|
commune.name | string |
Official name of the commune. |
StreetLI
Street in Liechtenstein
| Name | Path | Type | Description |
|---|---|---|---|
|
key
|
key | string |
Street key. |
|
name
|
name | string |
Street name. |
|
status
|
status | string |
Street status (Planned, Real, Outdated). |
|
postalCode
|
postalCode | string |
Postal code. |
|
locality
|
locality | string |
Name of the locality. |
|
key
|
commune.key | string |
Commune number (4 digits). |
|
name
|
commune.name | string |
Official name of the commune. |
CantonCH
Canton of Switzerland
| Name | Path | Type | Description |
|---|---|---|---|
|
key
|
key | string |
BFS number of the canton (max. 2 digits). |
|
historicalCode
|
historicalCode | string |
Historical code of the canton. |
|
name
|
name | string |
Name of the canton. |
|
shortName
|
shortName | string |
Abbreviation of the canton (2 letters). |
CantonCHSummary
Summary of a Swiss canton
| Name | Path | Type | Description |
|---|---|---|---|
|
key
|
key | string |
BFS number of the canton (max. 2 digits). |
|
name
|
name | string |
Name of the canton. |
|
shortName
|
shortName | string |
Abbreviation of the canton (2 letters). |
DistrictCH
District in Switzerland
| Name | Path | Type | Description |
|---|---|---|---|
|
key
|
key | string |
BFS number of the district (max. 4 digits). |
|
historicalCode
|
historicalCode | string |
Historical code of the district. |
|
name
|
name | string |
Name of the district. |
|
shortName
|
shortName | string |
Short name of the district. |
|
canton
|
canton | CantonCHSummary |
Summary of a Swiss canton |
DistrictCHSummary
Summary of a Swiss district
| Name | Path | Type | Description |
|---|---|---|---|
|
key
|
key | string |
BFS number of the district (max. 4 digits). |
|
name
|
name | string |
Name of the district. |
|
shortName
|
shortName | string |
Short name of the district. |
CommuneCH
Commune in Switzerland
| Name | Path | Type | Description |
|---|---|---|---|
|
key
|
key | string |
BFS number of the commune (max. 4 digits). |
|
historicalCode
|
historicalCode | string |
Historical code of the commune. |
|
name
|
name | string |
Official name of the commune. |
|
shortName
|
shortName | string |
Short name of the commune. |
|
district
|
district | DistrictCHSummary |
Summary of a Swiss district |
|
canton
|
canton | CantonCHSummary |
Summary of a Swiss canton |
CommuneCHSummary
Summary of a Swiss commune
| Name | Path | Type | Description |
|---|---|---|---|
|
key
|
key | string |
BFS number of the commune (max. 4 digits). |
|
name
|
name | string |
Name of the commune. |
|
shortName
|
shortName | string |
Short name of the commune. |
LocalityCH
Locality in Switzerland
| Name | Path | Type | Description |
|---|---|---|---|
|
key
|
key | string |
Locality identifier. |
|
name
|
name | string |
Name of the locality. |
|
postalcode
|
postalcode | string |
Postal code of the locality. |
|
commune
|
commune | CommuneCHSummary |
Summary of a Swiss commune |
|
district
|
district | DistrictCHSummary |
Summary of a Swiss district |
|
canton
|
canton | CantonCHSummary |
Summary of a Swiss canton |
StreetCH
Street in Switzerland
| Name | Path | Type | Description |
|---|---|---|---|
|
key
|
key | string |
Street key. |
|
name
|
name | string |
Street name. |
|
status
|
status | string |
Street status. Possible values: Planned, Real, Outdated. |
|
postalcode
|
postalcode | string |
Postal code of the locality. |
|
locality
|
locality | string |
Name of the locality. |
|
commune
|
commune | CommuneCHSummary |
Summary of a Swiss commune |
|
district
|
district | DistrictCHSummary |
Summary of a Swiss district |
|
canton
|
canton | CantonCHSummary |
Summary of a Swiss canton |
FederalProvinceAT
Federal province in Austria
| Name | Path | Type | Description |
|---|---|---|---|
|
key
|
key | string |
Federal province identifier (1 digit). |
|
name
|
name | string |
Name of the federal province. |
FederalProvinceATSummary
Summary of an Austrian federal province
| Name | Path | Type | Description |
|---|---|---|---|
|
key
|
key | string |
Federal province identifier (1 digit). |
|
name
|
name | string |
Name of the federal province. |
DistrictAT
District in Austria
| Name | Path | Type | Description |
|---|---|---|---|
|
key
|
key | string |
District identifier (3 digits). |
|
code
|
code | string |
District code (3 digits). |
|
name
|
name | string |
Name of the district. |
|
federalProvince
|
federalProvince | FederalProvinceATSummary |
Summary of an Austrian federal province |
DistrictATSummary
Summary of an Austrian district
| Name | Path | Type | Description |
|---|---|---|---|
|
key
|
key | string |
District identifier (3 digits). |
|
code
|
code | string |
District code (3 digits). |
|
name
|
name | string |
Name of the district. |
MunicipalityAT
Municipality in Austria
| Name | Path | Type | Description |
|---|---|---|---|
|
key
|
key | string |
Municipality identifier (5 digits). |
|
code
|
code | string |
Municipality code (5 digits). |
|
name
|
name | string |
Name of the municipality. |
|
status
|
status | string |
Status of the municipality (e.g. city, market town, etc.). |
|
postalCode
|
postalCode | string |
Postal code of the municipal office. |
|
multiplePostalCodes
|
multiplePostalCodes | boolean |
Does the municipality cover more than one postal code? |
|
district
|
district | DistrictATSummary |
Summary of an Austrian district |
|
federalProvince
|
federalProvince | FederalProvinceATSummary |
Summary of an Austrian federal province |
MunicipalityATSummary
Summary of an Austrian municipality
| Name | Path | Type | Description |
|---|---|---|---|
|
key
|
key | string |
Municipality identifier (5 digits). |
|
code
|
code | string |
Municipality code (5 digits). |
|
name
|
name | string |
Name of the municipality. |
LocalityAT
Locality in Austria
| Name | Path | Type | Description |
|---|---|---|---|
|
key
|
key | string |
Locality identifier. |
|
name
|
name | string |
Name of the locality. |
|
postalcode
|
postalcode | string |
Postal code of the locality. |
|
municipality
|
municipality | MunicipalityATSummary |
Summary of an Austrian municipality |
|
district
|
district | DistrictATSummary |
Summary of an Austrian district |
|
federalProvince
|
federalProvince | FederalProvinceATSummary |
Summary of an Austrian federal province |
StreetAT
Street in Austria
| Name | Path | Type | Description |
|---|---|---|---|
|
key
|
key | string |
Street identifier. |
|
name
|
name | string |
Name of the street. |
|
postalcode
|
postalcode | string |
Postal code of the locality. |
|
locality
|
locality | string |
Name of the locality. |
|
municipality
|
municipality | MunicipalityATSummary |
Summary of an Austrian municipality |
|
district
|
district | DistrictATSummary |
Summary of an Austrian district |
|
federalProvince
|
federalProvince | FederalProvinceATSummary |
Summary of an Austrian federal province |