General

PropertyType

FieldDescriptionTypeRemarks
typeProperty typeenumapartment, house, apartment_building, plot
subtypeProperty subtypeenumonly relevant for apartment and house
apartment_apartment, apartment_ground_floor, apartment_attic, apartment_maisonette, apartment_penthouse, apartment_loft, house_one_family, house_two_family, house_row, house_semi_detached

Location

If used in a request, coordinates or address needs to be provided. If both are provided, the coordinates will be used.

FieldDescriptionTypeRemarks
addressAddress
coordinatesCoordinates

Address

If used in a request, unstructured or structured fields need to be provided. If both are provided, the unstructured field will be used.

FieldDescriptionTypeRemarks
unstructuredUnstructured addressstringUseful to directly query user entries
streetStreetstring
houseNumberHouse numberstring
postCodePost codestring
cityCitystring

Coordinates

FieldDescriptionTypeRemarks
latitudeLatitudefloat
longitudeLongitudefloat

Scores

FieldDescriptionTypeRemarks
overallThe overall scoreScore
socialStructureThe social structure scoreScore
infrastructureThe infrastructure scoreScore
rentPriceThe rent price score of the level 20 divisionScore
dominantPopulationGroupsThe dominant population groupsarray of enumyoung_adults, with_children, seniors, mixed_groups
dominantBuildingTypeThe dominant building typeBuildingClass

PercentageClass

FieldDescriptionTypeRemarks
valuePercentage as a decimalfloate. g. 0.24 for 24 %
classClass describing the relativ value to other compareable divisions for the same levelenumwell_below_average, below_average, average, above_average, well_above_average
values can vary with the specific endpoint
typeType describing the valuestring

Date

TypeDescriptionRemarks
stringDate valueFormat: YYYY-MM-DD

Score

TypeDescriptionRemarks
floatScore valuemin: 0.0 (very bad)
max: 1.0 (very good)

PointOfInterest

FieldDescriptionTypeRemarks
distanceDistance to point of interest in meters.float
nameName of the point of intereststring

ValueRange

FieldDescriptionTypeRemarks
minLower bound valuefloat
maxUpper bound valuefloat

DateValueRange

FieldDescriptionTypeRemarks
minLower bound valueDate
maxUpper bound valueDate

PriceValueRange

FieldDescriptionTypeRemarks
minLower price valuefloat
maxUpper price valuefloat
currencyCurrency usedCurrency

BuildingClass

one_or_two_family_house, apartment_building, high_rise, business, special, unknown

AgeGroup

below_18,below_20, 18_to_29, 20_to_29, 30_to_44, 30_to_64, 45_to_64, 65_to_74, 65_to_79, above_75, above_80, total

VolumeLevel

Volume level in decibel below_55, 55_to_59, 60_to_64, 65_to_69, 70_to_74, above_75

Condition

dilapidated, bad, moderate, good, very_good

Quality

very_simple, simple, good, upscale, very_upscale

Confidence

poor, medium, high

Currency

EUR

Meta

FieldDescriptionTypeRemarks
urlQUIS dashboard URL of the searched locationstringOnly present if the exact location is known
versionCurrent version of the APIstringCould be used to detect new API versions