GETbyID RealEstate

This method hands out a real estate objects by scout object id or by your own object id.

https://rest.immobilienscout24.de/restapi/api/offer/v1.0/user/{username}/realestate/{id} or .../ext-{externalId}

  • Example: GET https://rest.immobilienscout24.de/restapi/api/offer/v1.0/user/999999/realestate/58850320 hands out the real estate object with the named scout object ID.

Supported media types

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

Authorization requirements

A System Key and an authenticated user are required for this operation:

Please use a secure connection (https) for this operation.

Request

Path Parameters

  • 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.
  • id: the unique scout object ID, which is being created by POST REALESTATE automatically.
  • external-id: can be used instead of the scout object ID
    • it is the customer-defined ID of the real estate, must be unique per user

Query Parameters

  • usenewenergysourceenev2014values=true - New param since 20.08.2014. Due to downward compatibility you can see the new energySourceEnev2014 values: BIO_ENERGY, WIND_ENERGY, HYDRO_ENERGY, ENVIRONMENTAL_THERMAL_ENERGY,COMBINED_HEAT_AND_POWER_FOSSIL_FUELS,
    COMBINED_HEAT_AND_POWER_RENEWABLE_ENERGY, COMBINED_HEAT_AND_POWER_REGENERATIVE_ENERGY, COMBINED_HEAT_AND_POWER_BIO_ENERGY

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

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<realestates:houseBuy 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" id="74719707">
    <externalId>441</externalId>
    <title>house buy and project</title>
    <creationDate>2014-08-12T11:26:14.000+02:00</creationDate>
    <lastModificationDate>2014-08-12T11:30:37.000+02:00</lastModificationDate>
    <address>
        <street>andreasstr</street>
        <houseNumber>10</houseNumber>
        <postcode>10243</postcode>
        <city>berlin</city>
        <wgs84Coordinate>
            <latitude>52.51245</latitude>
            <longitude>13.43134</longitude>
        </wgs84Coordinate>
        <geoHierarchy>
            <continent>
                <geoCodeId>1</geoCodeId>
                <fullGeoCodeId>1</fullGeoCodeId>
            </continent>
            <country>
                <geoCodeId>276</geoCodeId>
                <fullGeoCodeId>1276</fullGeoCodeId>
            </country>
            <region>
                <geoCodeId>3</geoCodeId>
                <fullGeoCodeId>1276003</fullGeoCodeId>
            </region>
            <city>
                <geoCodeId>1</geoCodeId>
                <fullGeoCodeId>1276003001</fullGeoCodeId>
            </city>
            <quarter>
                <geoCodeId>17</geoCodeId>
                <fullGeoCodeId>1276003001017</fullGeoCodeId>
            </quarter>
            <neighbourhood>
                <geoCodeId>11000000002348</geoCodeId>
            </neighbourhood>
        </geoHierarchy>
    </address>
    <apiSearchData>
        <searchField1>searchApiField1</searchField1>
        <searchField2>searchApiField2</searchField2>
        <searchField3>searchApiField3</searchField3>
    </apiSearchData>
    <realEstateState>ACTIVE</realEstateState>
    <groupNumber>500</groupNumber>
    <descriptionNote>Objektbeschreibung</descriptionNote>
    <furnishingNote>Ausstattung </furnishingNote>
    <locationNote>Lage</locationNote>
    <otherNote>Sonstiges </otherNote>
    <attachments xlink:href="http://devrst03.rz.is/restapi/api/offer/v1.0/user/me/realestate/74719707/attachment"/>
    <realEstateProjectId>33505</realEstateProjectId>
    <showAddress>true</showAddress>
    <contact id="53323004"/>
    <common:publishChannels>
        <publishChannel id="10000" title="ImmobilienScout24"/>
        <publishChannel id="10001" title="Homepage"/>
    </common:publishChannels>
    <lodgerFlat>YES</lodgerFlat>
    <constructionPhase>PROJECTED</constructionPhase>
    <buildingType>SINGLE_FAMILY_HOUSE</buildingType>
    <energyCertificate>
        <energyCertificateAvailability>AVAILABLE</energyCertificateAvailability>
        <energyCertificateCreationDate>BEFORE_01_MAY_2014</energyCertificateCreationDate>
    </energyCertificate>
    <cellar>YES</cellar>
    <handicappedAccessible>YES</handicappedAccessible>
    <numberOfParkingSpaces>2</numberOfParkingSpaces>
    <condition>FIRST_TIME_USE_AFTER_REFURBISHMENT</condition>
    <lastRefurbishment>2002</lastRefurbishment>
    <interiorQuality>SOPHISTICATED</interiorQuality>
    <constructionYear>1999</constructionYear>
    <freeFrom>sofort</freeFrom>
    <heatingType>SELF_CONTAINED_CENTRAL_HEATING</heatingType>
    <heatingTypeEnev2014>SELF_CONTAINED_CENTRAL_HEATING</heatingTypeEnev2014>
    <energySourcesEnev2014>
        <energySourceEnev2014>SOLAR_HEATING</energySourceEnev2014>
        <energySourceEnev2014>WIND_ENERGY</energySourceEnev2014>
        <energySourceEnev2014>GEOTHERMAL</energySourceEnev2014>
        <energySourceEnev2014>COMBINED_HEAT_AND_POWER_BIO_ENERGY</energySourceEnev2014>
    </energySourcesEnev2014>
    <buildingEnergyRatingType>ENERGY_REQUIRED</buildingEnergyRatingType>
    <thermalCharacteristic>174</thermalCharacteristic>
    <energyConsumptionContainsWarmWater>NOT_APPLICABLE</energyConsumptionContainsWarmWater>
    <numberOfFloors>1</numberOfFloors>
    <usableFloorSpace>100.00</usableFloorSpace>
    <numberOfBedRooms>2</numberOfBedRooms>
    <numberOfBathRooms>2</numberOfBathRooms>
    <guestToilet>YES</guestToilet>
    <parkingSpaceType>OUTSIDE</parkingSpaceType>
    <rented>YES</rented>
    <rentalIncome>522.00</rentalIncome>
    <listed>YES</listed>
    <parkingSpacePrice>1500.00</parkingSpacePrice>
    <summerResidencePractical>YES</summerResidencePractical>
    <price>
        <value>250000.00</value>
        <currency>EUR</currency>
        <marketingType>PURCHASE</marketingType>
        <priceIntervalType>ONE_TIME_CHARGE</priceIntervalType>
    </price>
    <livingSpace>140.00</livingSpace>
    <plotArea>500.00</plotArea>
    <numberOfRooms>4</numberOfRooms>
    <energyPerformanceCertificate>true</energyPerformanceCertificate>
    <courtage>
        <hasCourtage>YES</hasCourtage>
        <courtage>Provisionshöhe </courtage>
        <courtageNote>Provisionshinweis</courtageNote>
    </courtage>
</realestates:houseBuy>

JSON

    {
       "realestates.houseBuy":
       {
           "@id": "74719707",
           "externalId": "441",
           "title": "house buy and project 2",
           "creationDate": "2014-08-12T11:26:14.000+02:00",
           "lastModificationDate": "2014-08-12T11:30:37.000+02:00",
           "address":
           {
               "street": "andreasstr",
               "houseNumber": "10",
               "postcode": "10243",
               "city": "berlin",
               "wgs84Coordinate":
               {
                   "latitude": 52.51245,
                   "longitude": 13.43134
               },
               "geoHierarchy":
               {
                   "continent":
                   {
                       "geoCodeId": 1,
                       "fullGeoCodeId": "1"
                   },
                   "country":
                   {
                       "geoCodeId": 276,
                       "fullGeoCodeId": "1276"
                   },
                   "region":
                   {
                       "geoCodeId": 3,
                       "fullGeoCodeId": "1276003"
                   },
                   "city":
                   {
                       "geoCodeId": 1,
                       "fullGeoCodeId": "1276003001"
                   },
                   "quarter":
                   {
                       "geoCodeId": 17,
                       "fullGeoCodeId": "1276003001017"
                   },
                   "neighbourhood":
                   {
                       "geoCodeId": 11000000002348
                   }
               }
           },
           "apiSearchData":
           {
               "searchField1": "searchApiField1",
               "searchField2": "searchApiField2",
               "searchField3": "searchApiField3"
           },
           "realEstateState": "ACTIVE",
           "groupNumber": 500,
           "descriptionNote": "Objektbeschreibung",
           "furnishingNote": "Ausstattung ",
           "locationNote": "Lage",
           "otherNote": "Sonstiges ",
           "attachments":
           [
               {
                   "@xlink.href": "http://devrst03.rz.is/restapi/api/offer/v1.0/user/me/realestate/74719707/attachment"
               }
           ],
           "realEstateProjectId": 33505,
           "showAddress": "true",
           "contact":
           {
               "@id": "53323004"
           },
           "common.publishChannels":
           [
               {
                   "publishChannel":
                   [
                       {
                           "@id": "10000",
                           "@title": "ImmobilienScout24"
                       },
                       {
                           "@id": "10001",
                           "@title": "Homepage"
                       }
                   ]
               }
           ],
           "lodgerFlat": "YES",
           "constructionPhase": "PROJECTED",
           "buildingType": "SINGLE_FAMILY_HOUSE",
           "energyCertificate":
           {
               "energyCertificateAvailability": "AVAILABLE",
               "energyCertificateCreationDate": "BEFORE_01_MAY_2014"
           },
           "cellar": "YES",
           "handicappedAccessible": "YES",
           "numberOfParkingSpaces": 2,
           "condition": "FIRST_TIME_USE_AFTER_REFURBISHMENT",
           "lastRefurbishment": 2002,
           "interiorQuality": "SOPHISTICATED",
           "constructionYear": 1999,
           "freeFrom": "sofort",
           "heatingType": "SELF_CONTAINED_CENTRAL_HEATING",
           "heatingTypeEnev2014": "SELF_CONTAINED_CENTRAL_HEATING",
           "energySourcesEnev2014":
           {
               "energySourceEnev2014":
               [
                   "SOLAR_HEATING",
                   "WIND_ENERGY",
                   "GEOTHERMAL",
                   "COMBINED_HEAT_AND_POWER_BIO_ENERGY"
               ]
           },
           "buildingEnergyRatingType": "ENERGY_REQUIRED",
           "thermalCharacteristic": 174,
           "energyConsumptionContainsWarmWater": "NOT_APPLICABLE",
           "numberOfFloors": 1,
           "usableFloorSpace": 100,
           "numberOfBedRooms": 2,
           "numberOfBathRooms": 2,
           "guestToilet": "YES",
           "parkingSpaceType": "OUTSIDE",
           "rented": "YES",
           "rentalIncome": 522,
           "listed": "YES",
           "parkingSpacePrice": 1500,
           "summerResidencePractical": "YES",
           "price":
           {
               "value": 250000,
               "currency": "EUR",
               "marketingType": "PURCHASE",
               "priceIntervalType": "ONE_TIME_CHARGE"
           },
           "livingSpace": 140,
           "plotArea": 500,
           "numberOfRooms": 4,
           "energyPerformanceCertificate": "true",
           "courtage":
           {
               "hasCourtage": "YES",
               "courtage": "Provisionshöhe ",
               "courtageNote": "Provisionshinweis"
           }
       }
    }