General

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

Property

Field Description Type Remarks
id Programatic id of the property string  
customId Custom id of the property string The id users are familiar with.
externalId External id of the property string The id of the external system.
parentId Id of the parent property group string  
location Location of the property Location  
propertyType Type of the property PropertyType "type": "plot" and "type": "apartment_building" are not supported. Use PropertyGroup instead.
buildingYear Building year of the property integer  
livingArea Living area of the property float  
landArea Land area of the property float  
numberOfRooms Number of rooms float  
floor Floor of the property integer  
condition Condition of the property Condition default: moderate
quality Quality of the property Quality default: good
energyCertificate Energy certificate of the property EnergyCertificate  
primaryEnergySource Primary energy source of the property PrimaryEnergySource  
heatingTypes Heating types of the property array of HeatingType  
equipments Equipments of the property array of Equipment  

PropertyGroup

Field Description Type Remarks
id Programatic id of the property group string  
customId Custom id of the property group string The id users are familiar with.
externalId External id of the property group string The id of the external system.
parentId Id of the parent property group string  
location Location of the property group Location  
totalProperties Total number of properties in the property group integer  
totalPropertyGroups Total number of property groups in the property group integer  

PropertyImage

Field Description Type Remarks
id Programatic id of the image string  
propertyId Id of the property string  
type Type of the image enum title, ground_plan, default
caption Caption of the image string  
image Image to upload string Only required in requests and not send in responses. Maximum file size: 10 MB. Supported formats: image/png, image/jpeg, image/webp, image/heic
src URL of the image string Only present and required in responses.
previewSrc URL of the preview image string Only present and required in responses.

Location

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

Field Description Type Remarks
address   Address  
coordinates   Coordinates  

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  

EnergyCertificate

Field Description Type Remarks
type Type enum consumption, requirement
value Value float  

PrimaryEnergySource

geothermal, solar, wood_pellets, gas, oil, district_heating, electricity, money, natural_gas_l, natural_gas_h, lpg, district_heating_steam, wood, wood_chips, coal, local_heating, heat_supply, bioenergy, wind_energy, water_energy, environmental_heat, fossil, renewable, regenerative, bio

HeatingType

Predefined heating types have i18n translations. If you want to use your own heating type, just pass the name of the heating type as a string. It will be displayed as is.

heat_power_plants, electric, floor, district, underfloor, gas, wood_pellet, night_storage_heaters, furnace, oil, solar, heat_pump, central

Equipment

Predefined equipments have i18n translations. If you want to use your own equipment, just pass the name of the equipment as a string. It will be displayed as is.

kitchen, balcony, lift, terrace, underfloor_heating, parking_spot, first_occupancy, carport, garage_space, cellar, garden, garden_joint_use, parquet, photovoltaic_system, guest_toilet

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

Field Description Type Remarks
url QUIS dashboard URL of the searched location or link to the entity in QUIS string Only present if the exact location is known
version Current version of the API string Could be used to detect new API versions

© 2020-2024 QUIS® ist ein Service der Analyse & Konzepte immo.analytics GmbH