Skip to content

Reference Price (Deprecated)

Information

We set some of our market analytics and valuation APIs to deprecated, because we stopped development there (exception: Target Rent API). However, their current stable state will be maintained until further notice. There’s no change needed from your side when you have access to the data.

Please be aware that due to this changed status of the concerned APIs, we won’t hand out new access rights.

The resource reference-price represents a reference price for the given location. A location is represented by WGS84-coordinates (latitude and longitude). The result represents the reference prices for the neighbourhood and the quarter. Creating or modifying reference prices is not supported by the API.

GET /reference-price/api/v3.0/latitude/{latitude}/longitude/{longitude}?realEstateType={realEstateType}&objectCategory={objectCategory}&constructionYear={constructionYear}&firstTimeUse={firstTimeUse}&siteArea={siteArea}&livingArea={livingArea}

Supported media types:
JSON

This is version 3.0 of the API. See docs for the previous discontinued version here.

Request

  • latitude - the latitude of the point you wish to use for the request (WGS84 coordinate - required)
  • longitude - the longitude of the point you wish to use for the request (WGS84 coordinate - required)
Query String Parameters
PARAMETER VALUE DESCRIPTION
realEstateType 0 APARTMENT_RENT
1 HOUSE_RENT
2 APARTMENT_BUY
3 HOUSE_BUY
siteArea number Only for houses: area of the site (plot) in square meters. Minimum valid value is 0.
firstTimeUse true To make sure that new building prices are received although construction year is older than this year.
false If no firstTimeUse is given, portfolio real estate will be assumed.
livingArea number The size of the living area in square meters. If no livingArea is available the service assumes 100 sqm. Minimum valid value is 0.
objectCategory 0 no information
3 roof storey
7 maisonette
15 bungalow
17 semi detached house
18 single family house
20 country house
24 villa
24 single family house
25 terrace house
27 wooden house
38 freehold flat
40 terraced flat
117 ground floor
118 apartment
119 special real estate
122 single family house (detached)
123 mid terrace house
124 end terrace house
126 apartment (other)
127 raised ground floor
128 half basement
constructionYear integer number The year of construction of a real estate. This parameter is used to determine the age class of a real estate. The construction year must be a 4 digit number smaller or equals the current year and greater or equal than 0 (optional). If no constructionYear is given, portfolio real estate will be assumed.

Response

200 - OK

PARAMETER DESCRIPTION
averagePriceTotal Average total price in EUR of comparison real estates
averagePricePerSqm Average price in EUR per square meter of living area of comparison real estates
lowerSimpleStd Price in EUR (houses) or EUR/sqm of living area (apartments) one standard deviation lower than the average
higherSimpleStd Price in EUR (houses) or EUR/sqm of living area (apartments) one standard deviation higher than the average
lowerTwiceStd Price in EUR (houses) or EUR/sqm of living area (apartments) two standard deviations lower than the average
higherTwiceStd Price in EUR (houses) or EUR/sqm of living area (apartments) two standard deviations higher than the average
livingAreaAvg Average living area of comparison real estates
siteAreaAvg Average site area of comparison real estates (for houses only)
comparisonCount Number of real estates used for comparison
radiusM Distance to the furthest comparison real estate

Note on comparisonCount and radiusM: Reference Price API looks for up to 500 comparison real estates in the radius up to 10km.

Note on lower/higher Simple/Twice Std: standard deviation is calculated in log-space due to distribution of the prices of real estates. Prices between lowerTwiceStd and lowerSimpleStd are considered cheap. Prices between higherSimpleStd and higherTwiceStd are considered expensive.

Example:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
{
    "livingAreaAvg": 87.0,
    "comparisonCount": 500,
    "radiusM": 9800.0,
    "averagePriceTotal": 143900.0,
    "averagePricePerSqm": 3000.0,
    "higherSimpleStd": 4050.0,
    "higherTwiceStd": 5500.0,
    "lowerSimpleStd": 2200.0,
    "lowerTwiceStd": 1650.0
}
Notable changes from the previous version

Deleted fields:

  • simpleStd, twiceStd - removed to avoid confusion as standard deviation is calculated in log space
  • districtName - v3.0 is not aware of geo-hierarchy and uses only WGS84-coordinates
  • newBuilding - v3.0 has a single model for both new and old apartments and while building age is featured in the model, there is no significant distinction between old and new buildings

Added fields:

  • radiusM - radius of the search for comparison real estates in meters. The model looks for the nearest 500 comparable object in the radius up to 10km. In case comparisonCount is less than 500, radiusM is likely to be 10000.

Possible errors

204 - NO CONTENT

Reference price could not be calculated due to too few comparison real estates or other reason (indicated in response).