PropertyType
| Field | Description | Type | Remarks |
|---|
| type | Property type | enum | apartment, house, apartment_building |
| subtype | Property subtype | enum | only 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.
Address
If used in a request, unstructured or structured fields need to be provided. If both are provided, the unstructured
field will be used.
| Field | Description | Type | Remarks |
|---|
| unstructured | Unstructured address | string | Useful to directly query user entries |
| street | Street | string | |
| houseNumber | House number | string | |
| postCode | Post code | string | |
| city | City | string | |
Coordinates
| Field | Description | Type | Remarks |
|---|
| latitude | Latitude | float | |
| longitude | Longitude | float | |
Scores
| Field | Description | Type | Remarks |
|---|
| overall | The overall score | Score | |
| socialStructure | The social structure score | Score | |
| infrastructure | The infrastructure score | Score | |
| rentPrice | The rent price score | Score | |
| qualityOfLife | The quality of life score | Score | |
| dominantPopulationGroups | The dominant population groups | array of enum | young_adults, with_children, seniors, mixed_groups |
| dominantBuildingType | The dominant building type | BuildingClass | |
Infrastructure
| Field | Description | Type | Remarks |
|---|
| dailyNeeds | | object | |
| dailyNeeds.score | The score of the availability of daily needs | Score | |
| dailyNeeds.nextSupermarket | Next supermarket | PointOfInterest | |
| dailyNeeds.nextBakery | Next bakery | PointOfInterest | |
| dailyNeeds.nextRestaurant | Next restaurant | PointOfInterest | |
| transport | | object | |
| transport.score | The score of the availability of transportation | Score | |
| transport.nextBusStop | Next bus stop | PointOfInterest | |
| transport.nextTrainStation | Next train station | PointOfInterest | |
| transport.nextAirport | Next airport | PointOfInterest | |
| transport.nextChargingStation | Next electric vehicle charging station | PointOfInterest | |
| education | | object | |
| education.score | The score of the availability of education facilities | Score | |
| education.nextChildDayCare | Next child day care | PointOfInterest | |
| education.nextPrimarySchool | Next primary school | PointOfInterest | |
| education.nextHighSchool | Next high school | PointOfInterest | |
| education.nextGrammarSchool | Next grammar school | PointOfInterest | |
| healthAndSport | | object | |
| healthAndSport.score | The score of the availability of health and sport facilities | Score | |
| healthAndSport.recreationAndNatureScore | The score rating the recreation and nature | Score | |
| healthAndSport.nextFamilyDoctor | Next family doctor | PointOfInterest | |
| healthAndSport.nextHospital | Next hospital | PointOfInterest | |
| healthAndSport.nextPharmacy | Next pharmacy | PointOfInterest | |
| healthAndSport.nextSportFacility | Next sport facility | PointOfInterest | |
| noisePollution | | object | |
| noisePollution.score | The score rating the noise pollution | Score | |
| noisePollution.roadLevel | The noise pollution level caused by road traffic | VolumeLevel | |
| noisePollution.trainLevel | The noise pollution level caused by rail traffic | VolumeLevel | |
PercentageClass
| Field | Description | Type | Remarks |
|---|
| value | Percentage as a decimal | float | e. g. 0.24 for 24 % |
| class | Class describing the relativ value to other compareable divisions for the same level | enum | well_below_average, below_average, average, above_average, well_above_average
values can vary with the specific endpoint |
| type | Type describing the value | string | |
Date
| Type | Description | Remarks |
|---|
| string | Date value | Format: YYYY-MM-DD |
Score
| Type | Description | Remarks |
|---|
| float | Score value | min: 0.0 (very bad)
max: 1.0 (very good) |
PointOfInterest
| Field | Description | Type | Remarks |
|---|
| distance | Distance to point of interest in meters. | float | |
| name | Name of the point of interest | string | |
ValueRange
| Field | Description | Type | Remarks |
|---|
| min | Lower bound value | float | |
| max | Upper bound value | float | |
DateValueRange
| Field | Description | Type | Remarks |
|---|
| min | Lower bound value | Date | |
| max | Upper bound value | Date | |
PriceValueRange
| Field | Description | Type | Remarks |
|---|
| min | Lower price value | float | |
| max | Upper price value | float | |
| currency | Currency used | Currency | |
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
| Field | Description | Type | Remarks |
|---|
| url | QUIS dashboard URL of the searched location | string | Only present if the exact location is known |
| version | Current version of the API | string | Could be used to detect new API versions |