Openplzapi

OpenPLZ API v1

Open Data API for street and postal code directories of Austria, Germany, Liechtenstein and Switzerland

Maps & location#geocoding

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Open Data API for street and postal code directories of Austria, Germany, Liechtenstein and Switzerland

Endpoints 38

AT

  • GETReturns all localities wihtin a district (Kreis)./at/Districts/:key/Localities
  • GETReturns all municipalities (Gemeinden) within a district (Bezirk)./at/Districts/:key/Municipalities
  • GETReturns all federal provinces (Bundesländer)./at/FederalProvinces
  • GETReturns all districts (Bezirke) within a federal province (Bundesland)./at/FederalProvinces/:key/Districts
  • GETReturns all localities wihtin a federal province (Bundesland)./at/FederalProvinces/:key/Localities
  • GETReturns all municipalities (Gemeinden) within a federal province (Bundesland)./at/FederalProvinces/:key/Municipalities
  • GETPerforms a full-text search using the street name, postal code and city./at/FullTextSearch?searchTerm=1020 Wien Adambergergasse
  • GETReturns all localities whose postal code and/or name matches the given patterns./at/Localities
  • GETReturns all streets whose name, postal code and/or name matches the given patterns./at/Streets

CH

  • GETReturns all cantons (Kantone)./ch/Cantons
  • GETReturns all communes (Gemeinden) within a canton (Kanton)./ch/Cantons/:key/Communes
  • GETReturns all districts (Bezirke) within a canton (Kanton)./ch/Cantons/:key/Districts
  • GETReturns all localities wihtin a canton (Kanton)/ch/Cantons/:key/Localities
  • GETReturns all communes (Gemeinden) within a district (Bezirk)./ch/Districts/:key/Communes
  • GETReturns all localities wihtin a district (Kreis)./ch/Districts/:key/Localities
  • GETPerforms a full-text search using the street name, postal code and city./ch/FullTextSearch?searchTerm=8002 Zürich Bederstrasse
  • GETReturns all localities whose postal code and/or name matches the given patterns./ch/Localities
  • GETReturns all streets whose name, postal code and/or name matches the given patterns./ch/Streets

DE

  • GETReturns all localities wihtin a district (Kreis)./de/Districts/:key/Localities
  • GETReturns all municipal associations (Gemeindeverbände) within a district (Kreis)./de/Districts/:key/MunicipalAssociations
  • GETReturns all municipalities (Gemeinden) within a district (Kreis)./de/Districts/:key/Municipalities
  • GETReturns all federal states (Bundesländer)./de/FederalStates
  • GETReturns all districts (Kreise) within a federal state (Bundesland)./de/FederalStates/:key/Districts
  • GETReturns all government regions (Regierungsbezirke) within a federal state (Bundesaland)./de/FederalStates/:key/GovernmentRegions
  • GETReturns all localities wihtin a federal state (Bundesland)./de/FederalStates/:key/Localities
  • GETReturns all municipal associations (Gemeindeverbände) within a federal state (Bundesland)./de/FederalStates/:key/MunicipalAssociations
  • GETReturns all municipalities (Gemeinden) within a federal state (Bundesland)./de/FederalStates/:key/Municipalities
  • GETPerforms a full-text search using the street name, postal code and city./de/FullTextSearch?searchTerm=Berlin, Pariser Platz
  • GETReturns all districts (Kreise) within a government region (Regierungsbezirk)./de/GovernmentRegions/:key/Districts
  • GETReturns all localities wihtin a government region (Regierungsbezirk)./de/GovernmentRegions/:key/Localities
  • GETReturns all municipal associations (Gemeindeverbünde) within a government region (Regierungsbezirk)./de/GovernmentRegions/:key/MunicipalAssociations
  • GETReturns all municipalities (Gemeinden) within a government region (Regierungsbezirk)./de/GovernmentRegions/:key/Municipalities
  • GETReturns all localities whose postal code and/or name matches the given patterns./de/Localities
  • GETReturns all streets whose name, postal code and/or name matches the given patterns./de/Streets

LI

  • GETReturns all communes (Gemeinden)./li/Communes
  • GETPerforms a full-text search using the street name, postal code and city./li/FullTextSearch?searchTerm=Alte Landstrasse 9490 Vaduz
  • GETReturns all localities whose postal code and/or name matches the given patterns./li/Localities
  • GETReturns all streets whose name, postal code and/or name matches the given patterns./li/Streets

API details

Authentication
None declared in the description
Operations
38 operations on 38 pathsGET 38
Main resources
DE 16AT 9CH 9LI 4
Response formats
application/problem+json application/json text/json text/plain
Description format
OpenAPI 3.0.4, API version v1

How to test the OpenPLZ API v1 in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the OpenPLZ API v1 collection, without the publisher's secrets.
  3. Add your credentialsOpen the collection's variables or an environment and enter your API key or token, if the API needs one.
  4. Send a requestPick an endpoint, for example “Returns all localities wihtin a district (Kreis).” (GET /at/Districts/:key/Localities), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the OpenPLZ API v1?

Open Data API for street and postal code directories of Austria, Germany, Liechtenstein and Switzerland It is listed under Maps & location and has 38 endpoints.

Who publishes the OpenPLZ API v1?

It is listed from Openplzapi's public API description (an OpenAPI document), not published by Openplzapi on Swastik Codes. Anyone who controls openplzapi.org can claim the profile by adding a DNS TXT record.

How do I authenticate with the OpenPLZ API v1?

Its OpenAPI description does not declare an authentication scheme. Some endpoints may be open; check the provider's documentation before relying on that.

How many endpoints does the OpenPLZ API v1 have?

38 operations on 38 paths (38 GET). The largest groups are DE, AT, CH, LI.

Is forking the OpenPLZ API v1 free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.