Pricehistory API

The GET method of this resource retrieves the pricetrend for one realestateType for the given location. The location is specified with the path parameters. This call is idempotent.

Example with path parameter cityId:

GET https://rest.immobilienscout24.de/restapi/api/marketdata/v1.0/pricehistory/
region/{regionId}/city/{cityId}?realEstateType={realEstateType}&ageClass={ageClass}&startDate={startDate}

 

Example with path parameter cityId + districtId:

GET https://rest.immobilienscout24.de/restapi/api/marketdata/v1.0/pricehistory/
region/{regionId}/city/{cityId}/district/{districtId}?realEstateType={realEstateType}&ageClass={ageClass}&startDate={startDate}

 

Example with path parameter cityId + districtId + nhoodId:

GET https://rest.immobilienscout24.de/restapi/api/marketdata/v1.0/pricehistory/
region/{regionId}/city/{cityId}/district/{districtId}/nhood/{nhoodId}?realEstateType={realEstateType}&ageClass={ageClass}&startDate={startDate}

Supported media types

  • XML (Accept: application/xml)  (default)
  • 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.
  • A special API permission (contact us by email service@immobilienscout24.de)

Request

Path parameters

  • regionId - id of a region of the IS24-Geo-Hierarchy (required)
  • cityId - id of a city of the IS24-Geo-Hierarchy (required)
  • districtId - id of a district of the IS24-Geo-Hierarchy (optional)
  • nhoodId - id of a neighbourhood of the IS24-Geo-Hierarchy (optional)

Here's the documentation to the geohierarchy webservice to obtain the Geocode-IDs.


Query Parameters

  • Realestatetype - the id of the real estate for which the information should retrieved. Currently only the following types (strings) are supported:
    • "APARTMENT_BUY"
    • "HOUSE_BUY"
    • "APARTMENT_RENT"
    • "HOUSE_RENT"
  • ageClass - [B|N] B = portfolio realestate (german Bestand); N = new builded realestate (german Neubau); Default value is 'B' (optional)
  • startDate - indicated the quarter when the trend should start (e.g. 20081 -> stating with the first quarter of 2008). Default is: all available data (since 2007) (optional)

Response

Status 200 OK.
The requested operation was successful.

Body

XML

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<pricetrend:offeringPriceTrendResponse xmlns:priceindex="http://rest.immobilienscout24.de/schema/priceIndex/2.0" xmlns:pricetrend="http://rest.immobilienscout24.de/schema/offeringPriceTrend/2.0" xmlns:valuation="http://rest.immobilienscout24.de/schema/valuation/2.0" xmlns:cockpit="http://rest.immobilienscout24.de/schema/cockpit/2.0" xmlns:ns6="http://rest.immobilienscout24.de/schema/productpermission/1.0" xmlns:referenceprice="http://rest.immobilienscout24.de/schema/referencePrice/2.0" xmlns:ns8="http://rest.immobilienscout24.de/schema/customer/2.0" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:demographic="http://rest.immobilienscout24.de/schema/demographic/2.0">
    <avgOfferingPrice>
        <quarterOfYear>20091</quarterOfYear>
        <avgPrice>8.30</avgPrice>
    </avgOfferingPrice>
    <avgOfferingPrice>
        <quarterOfYear>20092</quarterOfYear>
        <avgPrice>8.50</avgPrice>
    </avgOfferingPrice>
    <avgOfferingPrice>
        <quarterOfYear>20093</quarterOfYear>
        <avgPrice>8.40</avgPrice>
    </avgOfferingPrice>
    <avgOfferingPrice>
        <quarterOfYear>20094</quarterOfYear>
        <avgPrice>8.20</avgPrice>
    </avgOfferingPrice>
    <avgOfferingPrice>
        <quarterOfYear>20101</quarterOfYear>
        <avgPrice>9.10</avgPrice>
    </avgOfferingPrice>
    <avgOfferingPrice>
        <quarterOfYear>20102</quarterOfYear>
        <avgPrice>10.00</avgPrice>
    </avgOfferingPrice>
    <avgOfferingPrice>
        <quarterOfYear>20103</quarterOfYear>
        <avgPrice>9.80</avgPrice>
    </avgOfferingPrice>
    <avgOfferingPrice>
        <quarterOfYear>20104</quarterOfYear>
        <avgPrice>10.10</avgPrice>
    </avgOfferingPrice>
    <avgOfferingPrice>
        <quarterOfYear>20111</quarterOfYear>
        <avgPrice>9.50</avgPrice>
    </avgOfferingPrice>
    <avgOfferingPrice>
        <quarterOfYear>20112</quarterOfYear>
        <avgPrice>9.70</avgPrice>
    </avgOfferingPrice>
    <avgOfferingPrice>
        <quarterOfYear>20113</quarterOfYear>
        <avgPrice>9.40</avgPrice>
    </avgOfferingPrice>
    <avgOfferingPrice>
        <quarterOfYear>20114</quarterOfYear>
        <avgPrice>9.90</avgPrice>
    </avgOfferingPrice>
<percentualChange>-1.9800</percentualChange>
</pricetrend:offeringPriceTrendResponse>

JSON

{
"avgOfferingPrice":[
    {"quarterOfYear":20081,"avgPrice":6.24},
    {"quarterOfYear":20082,"avgPrice":6.22},
    {"quarterOfYear":20083,"avgPrice":6.27},
    {"quarterOfYear":20084,"avgPrice":6.38},
    {"quarterOfYear":20091,"avgPrice":6.50},
    {"quarterOfYear":20092,"avgPrice":6.49},
    {"quarterOfYear":20093,"avgPrice":6.60},
    {"quarterOfYear":20094,"avgPrice":6.77},
    {"quarterOfYear":20101,"avgPrice":6.90},
    {"quarterOfYear":20102,"avgPrice":6.97},
    {"quarterOfYear":20103,"avgPrice":7.03},
    {"quarterOfYear":20104,"avgPrice":7.23}],
"percentualChange":"15.7800"
}