Tutorials, SDKs and Plugins

Search

This tutorial describes how to search for real estates (by region, radius).

search by regions

  • Methode: GET

Request-URL:

https://rest.immobilienscout24.de/restapi/api/search/v1.0/search/region?realestatetype={realestatetype}&geocodes={geocodes}

Example

Path Parameters

  • region

Query Parameters

  • realestatetype - real estate types: appartment rent, housebuy. Here's a list of all real estate types with the correct syntax.
  • geocodes - we use geocode ids identifying the region. Here's the webservice for obtaining the right geocode id.

Ressource name is "/search", path parameter is "/region". You need to enter two query parameters: "realestatetype" and "geocodes".
The complete URI looks like this:

 

https://rest.immobilienscout24.de/restapi/api/search/v1.0/search/region?realestatetype=apartmentrent&geocodes=1276003001046.

 

XML

You don't need to send a Body within GET requests.

 

 

 

 

 

Result:

 

 

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<resultlist:resultlist xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:resultlist="http://rest.immobilienscout24.de/schema/search/resultlist/1.0" xmlns:common="http://rest.immobilienscout24.de/schema/common/1.0" xmlns:ns5="http://rest.immobilienscout24.de/schema/offer/realestates/1.0">

<paging>

<next xlink:href="https://rest.immobilienscout24.de/restapi/api/search/v1.0/search/region?realestatetype=apartmentrent&amp;geocodes=1276003001046&amp;pagenumber=2"/>

<pageNumber>1</pageNumber>

<pageSize>20</pageSize>

<numberOfPages>5</numberOfPages>

<numberOfHits>87</numberOfHits>

</paging>

<resultlistEntries realEstateType="0" numberOfHits="87">

<resultlistEntry creation="2011-05-16T20:26:56.000+02:00" modification="2011-05-17T20:53:24.000+02:00" id="123456" xlink:href="https://rest.immobilienscout24.de/restapi/api/search/v1.0/expose/123456">

<realEstateId>123456</realEstateId>

<resultlist:realEstate xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:search="http://rest.immobilienscout24.de/schema/search/common/1.0" xsi:type="search:ApartmentRent" id="123456">

...

</resultlist:realEstate>

</resultlistEntry>

<resultlistEntry creation="2011-05-16T20:22:22.000+02:00" modification="2011-05-17T20:42:51.000+02:00" id="123457" xlink:href="https://rest.immobilienscout24.de/restapi/api/search/v1.0/expose/123457">

<realEstateId>123457</realEstateId>

<resultlist:realEstate xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:search="http://rest.immobilienscout24.de/schema/search/common/1.0" xsi:type="search:ApartmentRent" id="123457">

...

</resultlist:realEstate>

</resultlistEntry>

...

</resultlistEntries>

</resultlist:resultlist>

 

 

 

 

JSON

You don't need to send a Body within GET requests.

 

 

 

 

 

Result:

 

 

{

"resultlist.resultlist": {

"paging": {

"next": {

"@xlink.href":"https:\/\/rest.immobilienscout24.de\/restapi\/api\/search\/v1.0\/search\/region?realestatetype=apartmentrent&geocodes=1276003001046&pagenumber=2"

},

"pageNumber":1,

"pageSize":20,

"numberOfPages":5,

"numberOfHits":87

},

"resultlistEntries": [{

"@realEstateType":"0",

"@numberOfHits":"87",

"resultlistEntry":[{

"@creation":"2011-05-16T20:26:56.000+02:00",

"@modification":"2011-05-17T20:53:24.000+02:00",

"@id":"123456",

"@xlink.href":"https:\/\/rest.immobilienscout24.de\/restapi\/api\/search\/v1.0\/expose\/123456",

"realEstateId":123456,

"resultlist.realEstate": { ... },

}]

...

}]

}

}

 

 

 

radius search

  • Methode: GET

Request-URL:

https://rest.immobilienscout24.de/restapi/api/search/v1.0/search/radius?realestatetype={realestatetype}&geocoordinates={geocoordinates}

Example

Path Parameters

  • radius

Query Parameters

  • realestatetype - real estate types: appartment rent, housebuy. Here's a list of all real estate types with the correct syntax.
  • geo coordinates - the WGS84 coordinates with the radius

Ressource name is "/search", path parameter is "/radius". You need to enter two query parameters: "realestatetype" and "geocoordinates".


The complete URI looks like this:

https://rest.immobilienscout24.de/restapi/api/search/v1.0/search/radius?realestatetype=apartmentrent&geocoordinates=52.518864;13.396597;5

 

XML

You don't need to send a Body within GET requests.

 

 

 

 

 

Result:

 

 

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<resultlist:resultlist xmlns:ns2="http://rest.immobilienscout24.de/schema/platform/gis/1.0" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:resultlist="http://rest.immobilienscout24.de/schema/search/resultlist/1.0" xmlns:common="http://rest.immobilienscout24.de/schema/common/1.0" xmlns:ns6="http://rest.immobilienscout24.de/schema/offer/realestates/1.0">

<paging>

<next xlink:href="https://rest.immobilienscout24.de/restapi/api/search/v1.0/search/radius?realestatetype=apartmentrent&amp;geocoordinates=52.518864%3B13.396597%3B5&amp;pagenumber=2"/>

<pageNumber>1</pageNumber>

<pageSize>20</pageSize>

<numberOfPages>5</numberOfPages>

<numberOfHits>87</numberOfHits>

</paging>

<resultlistEntries realEstateType="0" numberOfHits="87">

<resultlistEntry creation="2011-01-11T14:12:44.000+01:00" modification="2011-08-19T13:38:05.000+02:00" id="123456" xlink:href="https://rest.immobilienscout24.de/restapi/api/search/v1.0/expose/123456">

<realEstateId>123456</realEstateId>

<distance>0.48</distance>

<resultlist:realEstate xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:search="http://rest.immobilienscout24.de/schema/search/common/1.0" xsi:type="search:ApartmentRent" id="123456">

...

</resultlist:realEstate>

</resultlistEntry>

<resultlistEntry creation="2011-08-09T17:51:43.000+02:00" modification="2011-08-09T18:16:43.000+02:00" id="123457" xlink:href="https://rest.immobilienscout24.de/restapi/api/search/v1.0/expose/123457">

<realEstateId>123457</realEstateId>

<distance>0.58</distance>

<resultlist:realEstate xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:search="http://rest.immobilienscout24.de/schema/search/common/1.0" xsi:type="search:ApartmentRent" id="123457">

...

</resultlist:realEstate>

</resultlistEntry>

<resultlistEntry creation="2011-09-08T13:50:20.000+02:00" modification="2011-09-08T13:50:22.000+02:00" id="61919137" xlink:href="https://rest.immobilienscout24.de/restapi/api/search/v1.0/expose/123458">

<realEstateId>123458</realEstateId>

<distance>0.60</distance>

<resultlist:realEstate xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:search="http://rest.immobilienscout24.de/schema/search/common/1.0" xsi:type="search:ApartmentRent" id="123458">

...

</resultlist:realEstate>

</resultlistEntry>

...

</resultlistEntries>

</resultlist:resultlist>

 

 

 

JSON

You don't need to send a Body within GET requests.

 

 

 

 

Result:

 

 

{

"resultlist.resultlist":{

"paging":{

"next":{

"@xlink.href":"https:\/\/rest.immobilienscout24.de\/restapi\/api\/search\/v1.0\/search\/radius?realestatetype=apartmentrent&geocoordinates=52.518864%3B13.396597%3B5"

},

"pageNumber":1,

"pageSize":20,

"numberOfPages":5,

"numberOfHits":87

},

"resultlistEntries":[ {

"@realEstateType":"0",

"@numberOfHits":"87",

"resultlistEntry":[ {

"@creation":"2011-01-11T14:12:44.000+01:00",

"@modification":"2011-08-19T13:38:05.000+02:00",

"@id":"123456",

"@xlink.href":"https:\/\/rest.immobilienscout24.de\/restapi\/api\/search\/v1.0\/expose\/123456", "realEstateId":123456, "distance":0.48,

"resultlist.realEstate":{

...

},

{

"@creation":"2011-08-09T17:51:43.000+02:00",

"@modification":"2011-08-09T18:16:43.000+02:00",

"@id":"123457",

"@xlink.href":"https:\/\/rest.immobilienscout24.de\/restapi\/api\/search\/v1.0\/expose\/123457",

"realEstateId":123457,

"distance":0.58,

"resultlist.realEstate":{

...

},

...

] }

] }

}