Skip to content
A machine readable API to the Gemeindeverzeichnis with additional information
JavaScript PHP HTML CSS
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin
config
controller/api
public
src
.gitignore
.htaccess
README.md
composer.json
composer.lock
db.sql

README.md

Gemeindeverzeichnis

Due to our desire for Open Data, we create a machine readable API to the Gemeindeverzeichnis of the Statistisches Bundesamt (https://www.destatis.de/DE/Themen/Laender-Regionen/Regionales/Gemeindeverzeichnis/_inhalt.html).

Installation

This project is using composer. Install composer and run:

php composer.phar install

Run imports

  1. Place the files data-base.cs, data-homepages.csv and data-station.csv in the root directory of this project.
  2. Run php bin/console import

CURL examples

Details view

This requires the "Gemeindeschlüssel".

curl --header "Content-Type: application/json" \
--request POST \
--data '["09362000"]' \
"https://gvz.integreat-app.de/api/details/"

or

https://gvz.integreat-app.de/api/details/09362000

Search

Search terms can be the name of the location or zip code.

curl --header "Content-Type: application/json" \
--request POST \
--data '["Wangen"]' \
"https://gvz.integreat-app.de/api/search/"

or

curl https://gvz.integreat-app.de/api/search/Wangen

Quick Search

A minimalistic search is also available. This is intended to make suggestions for completion of zip codes or city names.

curl --header "Content-Type: application/json" \
--request POST \
--data '["Wangen"]' \
https://gvz.integreat-app.de/api/quicksearch/

or

curl https://gvz.integreat-app.de/api/quicksearch/Wangen

Search by county

Search by county name

curl --header "Content-Type: application/json" \
--request POST \
--data '["Ravensburg"]' \
https://gvz.integreat-app.de/api/searchcounty/

or

curl https://gvz.integreat-app.de/api/searchcounty/Ravensburg

Submit data

curl --header "Content-Type: application/json" \
--request POST \
--data '[{"key": "", "slug": "", "address_street": "", "address_zip": "", "address_city": "", "opening_hours": "", "email_default": "", "website_default": "", "email_poll": "", "website_poll": ""}]' \
"https://gvz.integreat-app.de/api/update"
You can’t perform that action at this time.