Retrieve a List of Real Estates

This method provides all real estate objects of a user as a list.

GET /offer/v1.0/user/{username}/realestate

Supported media types:
XML
JSON

Example

The result can be filtered by publish channel ("IS24" or "Homepage" (published on the customer homepage): f.e: GET, hands out all real estate objects of the user with username "999999", which are published on www.immobilienscout24.de.

https://rest.immobilienscout24.de/restapi/api/offer/v1.0/user/999999/realestate?publishchannel=IS24

Request

Path Parameters

PARAMETER DESCRIPTION
Username the username which the user uses for logging in to www.immobilienscout24
Username "me" can be used instead of the username, when the user is logged in by 3-legged oauth

Query Parameters

PARAMETER VALUE DESCRIPTION
publishchannel IS24 published on www.immobilienscout24.de
Homepage not published on www.immobilienscout24.de if "IS24" is not set. It is created in order to present some objects on your own homepage, only. These objects can be accessed by search rest api with the parameter "channel=hp"
notinpublishchannel IS24 not published on www.immobilienscout24.de
Homepage not published on homepage
pagesize 1-100 default = 20 Entries
pagenumber 1-100 starts with 1, default = 1
?features= withAttachments the response is enhanced by attachment urls (several prescaled formats) for the title picture for each list entry
archivedobjectsincluded true/false

Response

XML:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<realestates:realEstates xmlns:ns2="http://rest.immobilienscout24.de/schema/platform/gis/1.0" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:common="http://rest.immobilienscout24.de/schema/common/1.0" xmlns:realestates="http://rest.immobilienscout24.de/schema/offer/realestates/1.0">
<Paging>
  <next xlink:href="http://rest.immobilienscout24.de/restapi/api/offer/v1.0/user/me/realestate?pagenumber=2"/>
  <pageNumber>1</pageNumber>
  <pageSize>20</pageSize>
  <numberOfPages>12</numberOfPages>
  <numberOfHits>222</numberOfHits>
</Paging>
<realEstateList>
  <realEstateElement xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:offerlistelement="http://rest.immobilienscout24.de/schema/offer/listelement/1.0" xsi:type="offerlistelement:OfferHouseRent" xlink:href="http://rest.immobilienscout24.de/restapi/api/offer/v1.0/user/me/realestate/62283354" modification="2013-12-05T09:13:45.000+01:00" creation="2013-12-05T09:13:37.000+01:00" publishDate="2013-12-07T20:37:38.333+01:00" id="62283354">
  <externalId>62283354</externalId>
  <title>Unterbach Haus</title>
  <address>
    <street>Eichenwand</street>
    <houseNumber>2</houseNumber>
    <postcode>40627</postcode>
    <city>Düsseldorf</city>
    <geoHierarchy>
      <continent>
        <geoCodeId>1</geoCodeId>
        <fullGeoCodeId>1</fullGeoCodeId>
      </continent>
    <country>
      <geoCodeId>276</geoCodeId>
      <fullGeoCodeId>1276</fullGeoCodeId>
    </country>
    <region>
      <geoCodeId>10</geoCodeId>
      <fullGeoCodeId>1276010</fullGeoCodeId>
    </region>
    <city>
      <geoCodeId>12</geoCodeId>
      <fullGeoCodeId>1276010012</fullGeoCodeId>
    </city>
    <quarter>
      <geoCodeId>57</geoCodeId>
      <fullGeoCodeId>1276010012057</fullGeoCodeId>
    </quarter>
    <neighbourhood>
      <geoCodeId>5111000008401</geoCodeId>
    </neighbourhood>
    </geoHierarchy>
  </address>
  <realEstateState>ACTIVE</realEstateState>
  <common:publishChannels>
  <publishChannel id="10000" title="Immobilienscout24"/>
  <publishChannel id="10001" title="Homepage"/>
  </common:publishChannels>
  <price>
  <value>45444</value>
  <currency>EUR</currency>
  </price>
  <livingSpace>440</livingSpace>
  <plotArea>460</plotArea>
  <numberOfRooms>5</numberOfRooms>
  <builtInKitchen>false</builtInKitchen>
  </realEstateElement>
  </realEstateList>
</realestates:realEstates>

JSON:

{
"realestates.realEstates":{
"Paging":{
  "next":{
    "@xlink.href":"http:\/\/rest.immobilienscout24.de\/restapi\/api\/offer\/v1.0\/user\/me\/realestate?pagenumber=2"
  },
  "pageNumber":1,
  "pageSize":20,
  "numberOfPages":12,
  "numberOfHits":222
},
"realEstateList":{
  "realEstateElement":[ {
    "@xsi.type":"offerlistelement:OfferApartmentBuy",
    "@xlink.href":"http:\/\/rest.immobilienscout24.de\/restapi\/api\/offer\/v1.0\/user\/me\/realestate\/62283644",
    "@modification":"2013-12-05T10:33:08.000+01:00",
    "@creation":"2013-12-05T10:33:08.000+01:00",
    "@publishDate":"2013-12-07T20:39:08.367+01:00",
    "@id":"62283644",
    "externalId":"vfvfvfvfvvf",
    "title":"RestAPI - Immobilienscout24 Testobjekt! +++BITTE+++ NICHT kontaktieren - Wohnung Kauf",
    "address":{
    "street":"Heuersdorfer Str",
    "houseNumber":"26",
    "postcode":"04574",
    "city":"Heuersdorf",
    "geoHierarchy":{
      "continent":{
      "geoCodeId":1,
      "fullGeoCodeId":"1"
    },
    "country":{
      "geoCodeId":276,
      "fullGeoCodeId":"1276"
    },
    "region":{
      "geoCodeId":13,
      "fullGeoCodeId":"1276013"
    },
    "city":{
      "geoCodeId":32,
      "fullGeoCodeId":"1276013032"
    },
    "quarter":{
      "geoCodeId":17
      "fullGeoCodeId":"1276013032017"
    },
    "neighbourhood":{
      "geoCodeId":14729170311012
    }
    }  
  },
      "realEstateState":"ACTIVE",
      "common.publishChannels":[ {
      "publishChannel":[ {
        "@id":"10000",
        "@title":"Immobilienscout24"
      },
      {
        "@id":"10001",
        "@title":"Homepage"
      } ]
      } ],
        "price":{
        "value":6105880.63,
        "currency":"EUR"
      },
        "livingSpace":7.943069905E7,
        "numberOfRooms":128.23
      }
    }
  }
}