API for determining rent index limits for Berlin addresses according to Berlin 2017 and 2019 rent indexes. Residential status is calculated using the street directories for 2017 and 2019.
- install Node dependencies
npm install
- run API
node ./www/bin
- send GET request to
http://localhost:3000/getRentIndex/
using the following body:
required
obj_street
(string): street of the objectobj_houseNumber
(string): house number of the object (with house number supplement if needed)obj_zipCode
(integer): zip code of the objectobj_constructionYear
(integer) construction year of the objectrentIndexYear
(integer): requested rent index (2017 or 2019)obj_spaceSqm
(float): space of the object in square meters
optional
featureGroups
(integer): array [1, 2, 3, 4, 5] covering different appartment features categories according to page 13 and following. For a positive feature category use-1
for a neutral category use0
and for a positive category use1
.
rentIndex
:rentIndexYear
: year of rent index usedbaseLocalComparativeRent
: medium value of determined rent indexminLocalComparativeRent
: minimum value of determined rent indexmaxLocalComparativeRent
: maximum value of determined rent index
This project was funded by the German Federal Ministry of Education and Research within the Prototype Fund funding line organized by Open Knowledge Fundation.