Types

Location

Field	Description	Type	Remarks
coordinates		Coordinates
address		Address
uprn	Unique Property Reference Number	integer	Only for UK, used by Property Info

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
buildingName	Building name	string	For UK only
unitIdentifier	Unit identifier	string	For UK only

Score

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

OverriddenScore

Field	Description	Type	Remarks
isOverridden	Score was overridden	boolean
originalScore	Original score value	min: 0.0 (very bad) max: 1.0 (very good)
score	Current score value	min: 0.0 (very bad) max: 1.0 (very good)	If isOverridden is true this will be overridden value, otherwise it will be originalScore

Valuation

Field	Description	Type	Remarks
value	Estimated sale price / monthly net rent / monthly gross rent value of the property	integer
valueRange.lower	Estimated lower bound of the property's sale price / net rent / gross rent value	integer
valueRange.upper	Estimated upper bound of the property's sale price / net rent / gross rent value	integer
valuationDate	The date of the valuation	string	YYYY-MM-DD
valuationConfidence	Confidence of the valuation	string	Valid values are poor, medium or 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 UK min: 1800 ES min: 1921 Not relevant for CZ and SK; Required for AT, BE, CH, DE, ES, FR, JP, NL
livingArea	Net living area, in m2 for countries AT, BE, CH, CZ, DE, FR, JP, NL, SK and in sq.ft in UK	float	min: 10, max: 800, maximum two decimals CH min: 20 CZ max: 500 FR min: 5, max: 1'000 UK min: 100, max: 10`000
landArea	Total area of the lot/parcel on which the house is standing, in m2 for countries AT, BE, CH, CZ, DE, FR, JP, NL, SK and in acres in UK	float	Required for house, min: 50, max: 5'000, maximum two decimals BE min: 30, max: 100'000 CZ min: 10 FR min: 10, max: 100'000 UK min: 0, max: 100
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, ES, UK
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, ES & UK
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 UK min: 1800 ES min: 1921 Not relevant for CZ and SK; Required for AT, BE, CH, DE, ES, FR, JP, NL
livingArea	Net living area, in m2 for countries AT, BE, CH, CZ, DE, FR, JP, NL, SK and in sq.ft in UK	float	min: 10, max: 800, maximum two decimals CH min: 20 CZ max: 500 FR min: 5, max: 1'000 UK min: 100, max: 10`000
landArea	Total area of the lot/parcel on which the house is standing, in m2 for countries AT, BE, CH, CZ, DE, FR, JP, NL, SK and in acres in UK	float	Required for house, min: 50, max: 5'000, maximum two decimals BE min: 30, max: 100'000 CZ min: 10 FR min: 10, max: 100'000 UK min: 0, max: 100
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
volumeStandard	Volume standard	string	Only for house, only relevant for CH Possible values: building_insurance, sia116, sia416
buildingStructure	Building structure	string	Only relevant for CZ, JP and SK
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, ES, UK
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, ES, UK
numberOfBathrooms	Number of bathrooms	integer	min: 1, max: 5
numberOfIndoorParkingSpaces	Garage spaces	integer	min: 0, max: 6 CH max: 100
numberOfOutdoorParkingSpaces	Parking spaces	integer	min: 0, max: 6 CH max: 100
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
hasCellar	Cellar availability	boolean	Only relevant for CZ and SK apartments
isLeasehold	Indicator if it is a freehold or leasehold	boolean	Only relevant for UK
leaseDurationYears	Only for lease offers	integer	Only relevant for UK min: 0, max: 999
isBungalow	Bungalow	boolean	Only relevant in UK for houses
energyLabel	Energy label	string	Only relevant for BE, CH, DE, FR, NL and UK. Valid values for BE are a_plus_plus, a_plus, a, b, c, d, e, f, g Valid values for CH are minergie, minergie_p, minergie_a, minergie_eco, minergie_p_eco, minergie_a_eco Valid values for DE are a_plus_plus, a_plus, a, b, c, d, e, f, g, h Valid values for FR are a, b, c, d, e, f, g Valid values for NL are a_plus_plus_plus, a_plus_plus, a_plus, a, b, c, d, e, f, g Valid values for UK are a, b, c, d, e, f, g
heatingGenerationType	How the building is heated	string	Only relevant for CH. Possible values are electric, wood, gas, oil, district, heat_pump_air, heat_pump_geothermal, solar.
hasSolarPanels	If the building has solar panels	boolean	Only relevant for CH.
hasSauna	Sauna availability	boolean	Only for house
hasPool	Pool availability	boolean	Only for house, supported in AT, BE, CH & DE.
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 BE, CZ, DE, FR, JP, SK & UK min: 1, max: 20 CZ max: 30, BE & 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 AT, BE, DE, FR, NL, UK &JP
renovationYear	Last renovation year of the property	integer	Only relevant for AT, CH and DE min: 1950, max: + 3
ownership	Ownership	string	Only relevant for apartment 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	string	Valid values are apartment, house or multi_family_house (Only relevant for DE)
subcode	Property subtype	string	Field not relevant for FR, JP and multi_family_house Valid values in countries AT, BE, CH, DE, NL, SK are apartment_normal, apartment_maisonette, apartment_attic, apartment_penthouse, apartment_terraced, apartment_studio, house_detached, house_semi_detached, house_row_corner, house_row_middle or house_farm. Valid values for CZ are apartment_normal, apartment_maisonette, apartment_attic, house_family_house, house_villa, house_cottage, house_hut. Valid values for UK are apartment_normal, apartment_maisonette, house_detached, house_semi_detached, house_row_corner, house_row_middle

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

DateValueRange

Field	Description	Type	Remarks
min	Lower bound value	string	Date format: YYYY-MM-DD
max	Upper bound value	string	Date format: YYYY-MM-DD

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, CZK, GBP & EUR, JPY

Energy label

a_plus_plus_plus, a_plus_plus, a_plus, a, b, c, d, e, f, g or h

Building structure

For JP, possible values are wood, heavy_weight_steel, light_weight_steel, reinforced_concrete, steel_reinforced_concrete or block_and_others

For CZ and SK, possible values are wood, stone, panel, mixed, framed_structure

Room configuration

Any combinations like 1R, 2LK, 3LDK, 4LDK+S, 5LDK+2S etc.

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

Generic Image

Field	Description	Type	Remarks
filename	Name of the file	string
url	Url of the image	string
caption	Caption of the image	string	Only present on dossier endpoints and when provided

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

Division

Field	Description	Type	Remarks
official_id	The official ID of the administrative division as defined by the administration/government	string
name	The name of the administrative division	string	The name is returned in the local language (e.g. "Genève" and not "Geneva" is returned)
designation	The administrative division level designation	string	The designation is returned in the local language (e.g. "Kanton" and not "Canton" is returned for the canton Zürich).
level	Division