Geo Auto Completion

The GeoAutoCompletion (GAC) provides autocompletion and suggestions for the German and Austrian geohierarchy as well as for postcodes and streets.

GET /gis/v2.0/geoautocomplete/{DEU|AUT}...

Supported media types:
JSON

Notes:

  • We offer two resources: suggestion and entity

Suggestion resource

Request

Path parameters

Parameter Value
country DEU, AUT

Query parameters

Parameter Description Default value
i Input for matching geographical entities (mandatory)
l Limit the number of results (max: 120) 50
t Comma-separated list of entity types (see below) that should be considered.
For backward compatibility reasons this parameter is optional (defaulting to value country,region,city,district,quarterOrTown,postcodeWithQuarter), but it's strongly recommended to specify a value in order to be explicit (and you probably also don't want type postcodeWithQuarter, see comment below).

t= example description
All A shortcut for "country,region,city,district,quarterOrTown,postcode,street" (please note: The parameter "trainStation" is not included).
country Deutschland

Österreich
country
region Brandenburg

Steiermark
The federal states according to our Geohierarchy
city Potsdam

Salzburg (Stadt)
City (according to our Geohierarchy)
district Potsdam-Mittelmark (Kreis)

Salzburg-Umgebung
County / rural district (according to our Geohierarchy)
quarterOrTown Potsdam - Golm

Rathenow

Salzburg (Stadt) - Aigen

Goldegg
Boroughs in cities or small towns/villages in counties
quarter Lühsdorf (Treuenbrietzen)

Salzburg (Bergheim)
Quarters within boroughs or towns/municipalities (including smaller villages) in the format "quarter (parent)" (or "city - quarter" for quarters within boroughs)
postcode 14467 Potsdam

5020 Salzburg
Postal localities in the format "postcode locality" (as also used for postal addresses)
postcodeWithQuarter 14467 Potsdam - Berliner Vorstadt

5020 Salzburg (Stadt) - Aigen
Combinations of postcode and quarterOrTown (search term must be a number)
Note that this type is useful only in very special cases as the combination of postcode with quarterOrTown doesn't usually reflect actual addresses that users might expect, in other words it's almost always better to use type postcode instead.
street Am Neuen Palais, 14469 Potsdam - Potsdam West

Albert-Schweitzer-Straße, 5020 Salzburg - Salzburg - Süd
Street sections as "street, postcode city" or "street, postcode city - quarter" (depending on whether the street section belongs to a specific quarter)
trainStation S Griebnitzsee (Potsdam)

Potsdam Hauptbahnhof
Trainstations (only in Germany)

Examples

GET https://rest.immobilienscout24.de/restapi/api/gis/v2.0/geoautocomplete/DEU?i=10557%20Strasse%20des&t=street

  [
    {
      "entity":{
        "type":"street",
        "id":"S1885578",
        "label":"Straße des 17. Juni 10557 Berlin - Charlottenburg (Charlottenburg)"
      },
      "matches":[
        {
          "offset":20,
          "length":5
        },
        {
          "offset":0,
          "length":6
        },
        {
          "offset":7,
          "length":3
        }
      ]

    },
    {
      "entity":{
        "type":"street",
        "id":"S1885685",
        "label":"Straße des 17. Juni 10557 Berlin - Tiergarten (Tiergarten)"
      },
      "matches":[
        {
          "offset":20,
          "length":5
        },
        {
          "offset":0,
          "length":6
        },
        {
          "offset":7,
          "length":3
        }
      ]
    }
  ]

GET http://rest.immobilienscout24.de/restapi/api/gis/v2.0/geoautocomplete/AUT?i=Salzburg&t=city,district

  [
         {
             "entity":
             {
                 "type": "city",
                 "id": "1040005001",
                 "label": "Salzburg (Stadt)"
             },
             "matches":
             [
                 [
                     0,
                     8
                 ]
             ]
         },
         {
             "entity":
             {
                 "type": "district",
                 "id": "1040005003",
                 "label": "Salzburg-Umgebung"
             },
             "matches":
             [
                 [
                     0,
                     8
                 ]
             ]
         }
      ]

Entity resource

Request

Path parameters


Parameter Description
country DEU or AUT
id The ID of the entity (as given in the suggestion result)

Query parameters


Parameter Default value Description
g None GeoCodingType, One of:
  • None: basic information about the entity (type, id, label, address)
  • GeoId: basic information plus the GeoId (geohierarchical id) of the region it represents or belongs to
  • Lambert: basic information plus LambertEU coordinates (x,y) of the center of the entity
  • WGS84: basic information plus Wgs84 coordinates (lat,lon) of the center of the entity

Example request and response

GET http://rest.immobilienscout24.de/restapi/api/gis/v2.0/geoautocomplete/DEU/entity/1276007004

{
  "type": "city",
  "id": "1276007004",
  "label": "Frankfurt am Main",
  "address": {
    "city": "Frankfurt am Main",
    "region": "Hessen"
  }
}

GET https://rest.immobilienscout24.de/restapi/api/gis/v2.0/geoautocomplete/DEU/entity/1276003001?g=GeoId

{
  "type": "city",
  "id": "1276003001",
  "label": "Berlin",
  "geoId": "1276003001",
  "address": {
    "city": "Berlin",
    "region": "Berlin"
  }
}

GET https://rest.immobilienscout24.de/restapi/api/gis/v2.0/geoautocomplete/DEU/entity/S1190910?g=Lambert

{
  "type": "street",
  "id": "S1190910",
  "label": "Insterburger Straße 76139 Karlsruhe-Waldstadt",
  "geoData": {
    "x": -112428,
    "y": 2126542
  },
  "address": {
    "street": "Insterburger Straße",
    "postcode": "76139",
    "quarter": "Waldstadt",
    "city": "Karlsruhe"
  }
}

GET https://rest.immobilienscout24.de/restapi/api/gis/v2.0/geoautocomplete/DEU/entity/S1190910?g=WGS84

{
  "type": "street",
  "id": "S1190910",
  "label": "Insterburger Straße 76139 Karlsruhe-Waldstadt",
  "geoData": {
    "lat": 49.03796,
    "lon": 8.43886
  },
  "address": {
    "street": "Insterburger Straße",
    "postcode": "76139",
    "quarter": "Waldstadt",
    "city": "Karlsruhe"
  }
}