Skip to content

Types

Location#

Field Description Type Remarks
coordinates Coordinates
address Address

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

Coordinates#

Field Description Type Remarks
latitude Latitude float
longitude Longitude float

Address#

Field Description Type Remarks
postCode Post code string
city City string
street Street string
houseNumber House number string

Score#

Type Description Remarks
float Score value min: 0.0 (very bad)
max: 1.0 (very good)

PropertyLight#

Apartment and House properties#

Field Description Type Remarks
location Property location Location
propertyType Property type PropertyType
buildingYear The year the property was built integer min: 1850, max: \<current year> + 3
FR: min: 1700
Not relevant for CZ;
required for all other countries
livingArea Net living area, in m2 float min: 10, max: 800, maximum two decimals
CH min: 20
CZ max: 500
FR min: 5, max: 1'000
landArea Total area of the lot/parcel on which the house is standing, in m2 float Required for house, min: 50, max: 5'000, maximum two decimals
BE min: 30
CZ min: 10
FR min: 10, max: 30'000
numberOfRooms Number of rooms float min: 1, max: 20
CZ max: 10
in AT, CH and DE, half rooms are allowed (e.g. 2.5);

in JP, use the following rule to map SDK apartment configuration to numberOfRooms: numberOfRooms = Number of bedrooms + 1 (for all SDK combinations, except for 1R/1K where numberOfRooms = 1).
Not supported in BE
hasOpenKitchen Whether the kitchen is in a separate room or part of the living area boolean Only relevant for CZ (example usage: set numberOfRooms = 2 and hasOpenKitchen = true to represent a "2+kk" room layout; set numberOfRooms = 2 and hasOpenKitchen = false to represent a "2+1" room layout)
numberOfBedrooms Number of bedrooms integer min: 1, max: 20
Only supported in BE
numberOfBathrooms Number of bathrooms integer min: 1, max: 5
condition Condition of the property; considering an average across all relevant factors (bathroom, kitchen, floors, windows, heating, etc.) Condition

Multi-Family House properties#

Field Description Type Remarks
location Property location Location
propertyType Property type PropertyType
buildingYear The year the property was built integer min: 1800, max: \<current year> + 3
numberOfUnits Number of units in the building integer min: 3, max: 25
livingArea Net living area, in m2 float min: 10, max: 5'000, maximum two decimals
landArea Total area of the lot/parcel on which the property is standing, in m2 float min: 0, max: 5'000, maximum two decimals
annualRentIncome Total yearly rent income integer min: 5'000, max: 1'000'000
condition Overall building condition Condition

Property#

Some of the fields have country-specific value ranges (see "Remarks" column below).

Apartment and House properties#

Field Description Type Remarks
location Property location Location
propertyType Property type PropertyType
buildingYear The year the property was built integer min: 1850, max: \<current year> + 3
FR: min: 1700
Not relevant for CZ;
required for all other countries
livingArea Net living area, in m2 float min: 10, max: 800, maximum two decimals
CH min: 20
CZ max: 500
FR min: 5, max: 1'000
landArea Total area of the lot/parcel on which the house is standing, in m2 float Required for house, min: 50, max: 5'000, maximum two decimals
BE min: 30
CZ min: 10
FR min: 10, max: 30'000
balconyArea Balcony / Terrace area, in m2 float min: 0, max: 200, maximum two decimals
FR max: 500
gardenArea Garden area, in m2 float Only for apartments, min: 0, max: 200, maximum two decimals
volume Volume, in m3 float Only for house, only relevant for CH, min: 250, max: 4'000, maximum two decimals
numberOfRooms Number of rooms float min: 1, max: 20
CZ max: 10

in AT, CH and DE, half rooms are allowed (e.g. 2.5);

in JP, use the following rule to map SDK apartment configuration to numberOfRooms: numberOfRooms = Number of bedrooms + 1 (for all SDK combinations, except for 1R/1K where numberOfRooms = 1).
Not supported in BE
hasOpenKitchen Whether the kitchen is in a separate room or part of the living area boolean Only relevant for CZ (example usage: set numberOfRooms = 2 and hasOpenKitchen = true to represent a "2+kk" room layout; set numberOfRooms = 2 and hasOpenKitchen = false to represent a "2+1" room layout)
numberOfBedrooms Number of bedrooms integer min: 1, max: 20
Only supported in BE
numberOfBathrooms Number of bathrooms integer min: 1, max: 5
numberOfIndoorParkingSpaces Garage spaces integer min: 0, max: 6
numberOfOutdoorParkingSpaces Parking spaces integer min: 0, max: 6
floorNumber Floor number integer Only for apartments, min: 0, max: 20
FR, NL & BE: max: 50
CZ max: 30
JP: min: 1, max: 60
hasLift Lift availability boolean Only for apartments
energyLabel Energy label enum Either minergie or do not provide the field, only relevant for CH
hasSauna Sauna availability boolean Only for house
hasPool Pool availability boolean Only for house
numberOfFloorsInBuilding For apartment: Total number of floors of the building in which the apartment is located (Includes ground floor for all countries except FR).
For house: Total number of floors of the house
integer Only relevant for CZ, DE, FR, & JP
min: 1, max: 20
CZ max: 30, FR: max: 50
JP: max: 60
isFurnished Whether the property is furnished or not boolean Only relevant for FR
isNew Whether the property has never been used before ("B√Ętiment neuf" in French, "Erstverkauf" / "Erstvermietung" in German) boolean Only relevant for FR, DE, AT, NL & JP
renovationYear Last renovation year of the property integer Only relevant for CH and DE
min: 1950, max: <current year> + 3
ownership Ownership enum Only relevant in CZ; possible values: personal or cooperative
condition.bathrooms Bathrooms condition Condition
condition.kitchen Kitchen condition Condition
condition.flooring Flooring condition Condition
condition.windows Windows condition Condition
condition.masonry Masonry condition Condition Only for house
quality.bathrooms Bathrooms quality Quality
quality.kitchen Kitchen quality Quality
quality.flooring Flooring quality Quality
quality.windows Windows quality Quality
quality.masonry Masonry quality Quality Only for house

Multi-Family House properties#

Field Description Type Remarks
location Property location Location
propertyType Property type PropertyType
buildingYear The year the property was built integer min: 1800, max: \<current year> + 3
livingArea Net living area, in m2 float min: 10, max: 5'000, maximum two decimals
numberOfUnits Number of units in the building integer min: 3, max: 25
landArea Total area of the lot/parcel on which the property is standing, in m2 float min: 0, max: 5'000, maximum two decimals
annualRentIncome Total yearly rent income integer min: 5'000, max: 1'000'000 (Only relevant for DE)
condition.overall Overall building condition Condition (Only relevant for DE)
quality.overall Overall building quality Quality (Only relevant for DE)

PropertyType#

Field Description Type Remarks
code Property type enum apartment, house or multi_family_house (Only relevant for CH & DE)
subcode Property subtype enum Not relevant for FR, AT, JP and multi_family_house
apartment_normal, apartment_maisonette, apartment_attic, apartment_penthouse, apartment_terraced, apartment_studio, house_detached, house_semi_detached, house_row_corner, house_row_middle orhouse_farm

LowerUpperBound#

Field Description Type Remarks
lower Lower bound value integer
upper Upper bound value integer

ValueRange#

Field Description Type Remarks
min Lower bound value integer
max Upper bound value integer

PriceValueRange#

Field Description Type Remarks
min Lower price value integer
max Upper price value integer
currency Currency used Currency
## FloatValueRange
Field Description Type Remarks
min Lower bound value float
max Upper bound value float

Confidence#

poor, medium or good

Condition#

renovation_needed, well_maintained or new_or_recently_renovated

Quality#

simple, normal, high_quality or luxury

Currency#

CHF, EUR, JPY or CZK

Dossier Image#

Field Description Type Remarks
filename Filename of the uploaded image string Get the filename from the Dossier Images endpoint
caption Caption of the image string Maximum of 60 characters

User Defined Field#

Field Description Type Remarks
label Label of the field string Maximum of 20 characters
value Value of the field string Maximum of 20 characters