Region auto completion (DEPRECATED)

This API is DEPRECATED. New version is GeoAutoCompletion (GAC) v2 API.

Shutdown date: 31 January 2017

Returns a list of resources identified by the following URL. The GET method of the region resource retrieves all regions starting with the given letters and the amount of available real estates for an optional real estate type (defaults to APARTMENT_RENT). At least two letters are required.

https://rest.immobilienscout24.de/restapi/api/search/v1.0/region

Note:

  • The region completition service is currently restricted to regions of Germany (DEU).
  • If no real estate is provided, the amount represents the default real estate type (APARTMENT_RENT).
  • We don't hand out the amount of listings for the given region/realestate type by this API. Please use the search statistics API instead

Supported media types

  • XML (Accept: application/xml)
  • JSON (Accept: application/json)

Authorization requirements

  • At least a System Key is required for this operation. See Authentication via Two-legged OAuth for further details.

Request

Path Parameters

  • none

Query Parameters

  • q - The query of for the auto completion request (at least two letters). If there are no matches for for the given query, a validation exception is returned.
  • realEstateType- The real estate type for the request. This parameter is optional, the standard value is APARTMENT_RENT. The real estate type HOUSE_TYPE is not supported by the auto completion service.

Response

The following section includes the HTTP status code, a short description and examples for the response body content of a successful processed request.
Error responses as well as other simple message responses are described in detail within the common message responses.

  • Status 200 OK - The requested operation was successful.

Header

No special headers.

Body

XML

https://rest.immobilienscout24.de/restapi/api/search/v1.0/region?q=berlin

<region:regions xmlns:region="http://rest.immobilienscout24.de/schema/search/region/1.0">
   <region>
      <name>Berlin-Mitte (Mitte)</name>
      <geoCodeId>397714134</geoCodeId>
      <amount>0</amount>
   </region>
   <region>
      <name>Berlin-Prenzlauer Berg (Prenzlauer Berg)</name>
      <geoCodeId>397714142</geoCodeId>
      <amount>0</amount>
   </region>
   <region>
      <name>Berlin-Friedrichshain (Friedrichshain)</name>
      <geoCodeId>397714105</geoCodeId>
      <amount>0</amount>
   </region>
</region:regions>

JSON

https://rest.immobilienscout24.de/restapi/api/search/v1.0/region?q=berlin

{
   "region.regions":[
      {
         "region":[
            {
               "name":"Berlin",
               "geoCodeId":1276003001,
               "amount":0
            },
            {
               "name":"Berlin-Mitte (Mitte)",
               "geoCodeId":397714134,
               "amount":0
            },
            {
               "name":"Berlin-Neukölln (Neukölln)",
               "geoCodeId":397714136,
               "amount":0
            }
         ]
      }
   ]
}