GeoMap logo
API docs by Redocly

GeoMap Public API - geocode (2.0.0)

E-mail: kontakt@geomap.immo

Introduction

Documentation of the GeoMap API.

Changelog

API version 2.0.0

  • possibility to request custom regions
  • level extended by value custom for searchRegions request
  • attribute admLevel in responses is mandatory for administrative regions only

API version 1.0.0

  • first release

Geocode

Information about accessible regions and postal codes.

Search regions

Search for regions in Austria, Germany, Switzerland or within custom regions that can be used with other API endpoints.

The search can be carried out the following ways:

  • by a coordinate
  • by a postal code and a country code
  • by a official municipality key (12-digit ARS in Germany, 1 to 4-digit BFS in Switzerland and 5-digit GKZ in Austria) in combination with a country code. The key must be at administrative level municipality!

The regions must be defined by a given level which is either one of the administrative levels, custom level or minAvailableAdmLevel as a method that automatically determines the smallest available administrative level.

The response consists of one or many regions of exactly 1 administrative or the custom level.

Regions of level custom are not subject to any hierarchy nor part of the administrative levels, so they cannot be used for getChildRegions and getParentRegions.

Note: regionIds are subject to versioning depending on the area or data status, i.e. regionIds are not static and will updated regularly.

Authorizations:
BearerAuth
Request Body schema: application/json
One of
required
object

Geolocation defined by latitude and longitude

level
required
string
Enum: "bundesland" "gemeinde" "kreis" "ortsteil" "stadtbezirk" "stadtteil" "minAvailableAdmLevel" "custom"

Administrative / custom level or method to determine the administrative level

  • bundesland - Federal states, in AT and DE named 'Bundesland', in CH 'Kanton'
  • gemeinde - Municipalities
  • kreis - Political district, in AT named 'Politischer Bezirk', in CH 'Bezirk', in DE 'Kreis/Landkreis'
  • ortsteil - Smallest inner-local area unit of 3 possible municipality division levels
  • stadtbezirk - Largest inner-city area unit of 3 possible municipality division levels
  • stadtteil - Middle inner-local area unit of 3 possible municipality division levels
  • minAvailableAdmLevel - Smallest available administrative level. The hierarchy is from large to small: bundesland, kreis, gemeinde, stadtbezirk, stadtteil, ortsteil
  • custom - User defined areas, such as individual areas of partners, which are only accessible to authorised users

Responses

Request samples

Content type
application/json
Example
{
  • "coordinate": {
    },
  • "level": "bundesland"
}

Response samples

Content type
application/json
[
  • {
    }
]

Child regions

This endpoint provides the regions and the administrative level of the direct child regions for a regionId.

The hierarchy is from large to small:

  • bundesland, kreis, gemeinde, stadtbezirk, stadtteil, ortsteil

The response consists of one or many regions of exactly 1 administrative level.

Authorizations:
BearerAuth
path Parameters
regionId
required
string <base64> (RegionId)
Examples: gDdHAeaPLtAZlP0oz1Jdvvwym3m_VpZJ-7_SKYueHfX4ov9M2ydu3jfBmMfi1xoX rbJnzwBexyPJVWIa1FZltwEsz-xkWOH0DfSn0dnfiQG7AWoCt88RC_vuicY6Rx_8 Nah6rd7RbW93pgLwGnikruBtyzobb0ZStZlAfeSJw9MU_kPGBGFPJIhlVLG1lOAQ J1LapNxJG76LX-2WKW-EzhfvWzz1m2XxR8dASZR6e3281hwbAgA39ayI1PGi6jDl 2oDHRqCqmTsA8V5QBNYrExpkqfr66Y7yiAG0KTiGGQEwS5qn1nkotYpaJHuR7h4v

Region ID for which to request direct child regions

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Parent regionIds

This endpoint provides the regionsIds and the administrative level of the direct parent regions for a regionId.

The hierarchy is from large to small:

  • bundesland, kreis, gemeinde, stadtbezirk, stadtteil, ortsteil

The response consists of one or many regions of exactly 1 administrative level.

Authorizations:
BearerAuth
path Parameters
regionId
required
string <base64> (RegionId)
Examples: gDdHAeaPLtAZlP0oz1Jdvvwym3m_VpZJ-7_SKYueHfX4ov9M2ydu3jfBmMfi1xoX rbJnzwBexyPJVWIa1FZltwEsz-xkWOH0DfSn0dnfiQG7AWoCt88RC_vuicY6Rx_8 Nah6rd7RbW93pgLwGnikruBtyzobb0ZStZlAfeSJw9MU_kPGBGFPJIhlVLG1lOAQ J1LapNxJG76LX-2WKW-EzhfvWzz1m2XxR8dASZR6e3281hwbAgA39ayI1PGi6jDl 2oDHRqCqmTsA8V5QBNYrExpkqfr66Y7yiAG0KTiGGQEwS5qn1nkotYpaJHuR7h4v

Region ID for which to request direct parent regions

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Details by regionId

This endpoint provides detailed information for a regionId.

Authorizations:
BearerAuth
path Parameters
regionId
required
string <base64> (RegionId)
Examples: gDdHAeaPLtAZlP0oz1Jdvvwym3m_VpZJ-7_SKYueHfX4ov9M2ydu3jfBmMfi1xoX rbJnzwBexyPJVWIa1FZltwEsz-xkWOH0DfSn0dnfiQG7AWoCt88RC_vuicY6Rx_8 Nah6rd7RbW93pgLwGnikruBtyzobb0ZStZlAfeSJw9MU_kPGBGFPJIhlVLG1lOAQ J1LapNxJG76LX-2WKW-EzhfvWzz1m2XxR8dASZR6e3281hwbAgA39ayI1PGi6jDl 2oDHRqCqmTsA8V5QBNYrExpkqfr66Y7yiAG0KTiGGQEwS5qn1nkotYpaJHuR7h4v

Region ID for which to request detailed information

Responses

Response samples

Content type
application/json
{
  • "regionId": "gDdHAeaPLtAZlP0oz1Jdvvwym3m_VpZJ-7_SKYueHfX4ov9M2ydu3jfBmMfi1xoX",
  • "hasChildren": true,
  • "name": "Luzern",
  • "admLevel": "bundesland",
  • "countryCode": "AT",
  • "code": "01",
  • "coordinate": {
    },
  • "date": "2019-08-24",
  • "parentRegions": [
    ],
  • "source": "Bundesamt für Landestopografie swisstopo",
  • "sourceUrl": "https://www.innsbruck.gv.at/"
}

Search postcodes

Search for postal codes in Austria, Germany, Switzerland or within custom regions that can be used with other API endpoints.

The search can be carried out the following ways:

  • by a coordinate
  • by a regionId
  • by a official municipality key (12-digit ARS in Germany, 1 to 4-digit BFS in Switzerland and 5-digit GKZ in Austria) in combination with a country code. The key must be at administrative level municipality!

The area of a postcode must intersect with a requested region in order to be returned as a result.

Authorizations:
BearerAuth
Request Body schema: application/json
One of
required
object

Geolocation defined by latitude and longitude

Responses

Request samples

Content type
application/json
Example
{
  • "coordinate": {
    }
}

Response samples

Content type
application/json
Example
{ }