Changelog

2023-09-01#

Increased max items for userDefinedFields field from 12 to 50 in Dossier creation, update, read

2023-06-17#

Added support for priceUpdates field in Offer search response

2023-07-10#

Added rentNet filter support and rentNet criterion for orderBy.field in UK to Offer search.

2023-06-22#

Exclusive Offer Search switched filters.location type from LocationFilter to an array of LocationFilters. The use of non-array filters.location is deprecated and will be removed in the future.

2023-06-19#

Added end_date option for groupBy.field and endDate filter support to Offer statistics.

2023-05-16#

Added energyLabel option for groupBy.field and energy_label metric support to Offer statistics.

2023-05-15#

livingArea, landArea fields are optional for UK in Property and Property Light objects
numberOfBedrooms field is required for UK in Property and Property Light objects
livingArea field is optional for UK for Exclusive Transaction creation

2023-03-30#

Added Cadastre support for BE.

2023-03-21#

market section in Templates is now international, and will display the new version of the market trends graphs.

2023-03-13#

Add new Override environment scores endpoint

2023-03-06#

Added hasSolarPanels field to both Exclusive Offers and Exclusive Transactions
Added heatingGenerationType & heatingDistributionType fields to Exclusive Offers
Dropped support for heatingType & heatingSource in Exclusive Offers

2023-02-22#

Added priceStrategyStrength and priceStrategyWeakness fields to Dossier creation object

2023-01-19#

Added status, roomTourLink, hasBalcony, hasIndoorParkingSpaces & hasOutdoorParkingSpaces fields to Exclusive Offer object

2023-01-11#

Added the PATCH Dossier update endpoint

2022-12-27#

Deleted support Property for MFH in CH

2022-12-20#

Added Cadastre with support for FR.

2022-12-06#

Extended Offer search and Offer Statistics filters propertyCondition and numberOfFloorsInBuilding

2022-12-05#

Extended Property Info with FR support

2022-12-02#

Added support for heatingGenerationType and hasSolarPanels in CH in Property

2022-11-22#

Extended Division Children endpoint with pagination support (added parameters offset and limit)

2022-11-21#

Extended Property Info with UK support

2022-11-10#

Extended Offer search and Offer Statistics filters energyLabel, floorNumber, numberOfBathrooms

2022-11-04#

Added the Property Pages endpoint

2022-10-28#

Added label field to Exclusive Transaction object

2022-10-14#

Increased max items for offerIds in Offer & Exclusive Offer search endpoints
Increased max items for selectedSaleOffers, selectedRentOffers, selectedTransactions in Dossier Save Comparables endpoint

2022-10-13#

Added Dossier Regulations endpoint in FR.

2022-10-07#

Extended Location scores endpoint to support noise for all countries except JP

2022-09-19#

Added support for hasPool, numberOfFloorsInBuilding & energyLabel + increased landArea limits in BE in Property and Property Light

2022-09-16#

Extended Administrative Divisions endpoint with UK support
Extended Division Children endpoint with UK support
Extended Socio-Economics endpoint with UK support
Extended Socio-Economics Types endpoint with UK support

2022-08-23#

Building Projects added new response fields energyLabel, numberOfRoomsRange, livingAreaRange and unitPriceRange for AT
Building Projects removed response fields buildingPermitRequestedDate, buildingPermitIssuedDate, numberOfHouses, numberOfBuildings and numberOfFloorsInBuilding for AT

2022-08-31#

Added the Dossier Save Comparables endpoint
Added two undocumented fields useSelectedOffers & useSelectedTransactions in Dossier read

2022-08-03#

Added new values isBungalow for house, isLeasehold, leaseDurationYears for apartment and house in Property and updated existing fields limits for UK in Property Light and Property

2022-07-28#

Added documentation on Covers
Added documentation on Templates.

2022-07-20#

Added fields for CZ gardenArea, buildingStructure, hasCellar, hasLift, numberOfFloorsInBuilding, ownership, numberOfIndoorParkingSpaces, numberOfOutdoorParkingSpaces in Property
Modified field for CZ subcode in PropertyType

2022-07-15#

Valuation and Valuation Light are enabled for Spain for dealType=sale.

2022-06-29#

Points of Interest enabled for United Kingdom
Location scores enabled for United Kingdom

2022-06-06#

Increased max value for FR landArea in Property and Property Light

2022-06-02#

Exclusive Offer search Offers & Transactions are enabled in UK.
Offer search updated isFurnished search & response fields for United Kingdom on Rent offers.
AT properties now support renovationYear & subcode

2022-05-31#

Extended Property Info with livingArea & buildingYear fields

2022-05-26#

Property added energyLabel field for France
Offer search Offers & Transactions are enabled in UK.
Offers enabled for United Kingdom.
Transactions enabled for United Kingdom.

2022-05-18#

Exclusive Offer search added isFurnished search & response fields for Germany and France on Rent offers.
Offer search added isFurnished search & response fields for Germany and France on Rent offers.

2022-05-02#

Added the Dossier Valuation Override endpoint

2022-04-26#

Added support for French remote territories in [Dossier creation], [Valuation] and [Valuation light]

2022-04-22#

Added the Dossier Transfer endpoint

2022-04-12#

Offer search added renovationYear, numberOfBathrooms, propertyCondition and domesticEquipmentQuality response fields for Germany.

2022-04-08#

Added the Property Info endpoint

2022-03-24#

Added the Dossier Valuation endpoint
Extended Location scores endpoint with overridden scores support
Deprecate family, location, noise, nuisance, shopping, view, catering, health, leisure fields in Location scores endpoint
Add new Override amenities scores endpoint

2022-02-21#

dealType is no longer required in Dossier creation, update, read.
Dossier update added selectedSaleOffers and selectedRentOffers fields. Marked selectedOffers field deprecated.

2022-02-16#

Use Authorization HTTP header to transmit access_token in sample requests, deprecate passing the access_token in query parameter.

2022-02-01#

Offer search added facilityItems response field for Japan.

2022-01-31#

Offer search added energyLabel response field for Germany, France and Netherlands.

2022-01-04#

Offer search and Offer Statistics added isPrivate filter and response fields.

2021-12-17#

Offer search added salePricePerSqm, rentGrossPerSqm and rentNetPerSqm ordering and in response.
Transaction search added salePricePerSqm ordering and in response.

2021-12-16#

BREAKING CHANGE:

As of December 2021 this endpoint's parameter buildingStructure has changed of type and now accept an array of strings.

Offer Search switched buildingStructure type from string to array.

2021-12-15#

Property added buildingStructure and hasCellar fields for Slovakia
Offer search added hasCellar response fields for Slovakia.
Offer search added divisionLevel4 and divisionLevel9 location filter fields for Slovakia.

2021-11-11#

Offer search added roomConfiguration filter and response fields for Japan.

2021-11-05#

Offer search added buildingStructure filter and response fields for Japan.

2021-10-28#

Added canGeneratePdf request field to Dossier Sharing endpoint

2021-08-24#

Warning

As of September 2021, some endpoints such a Socio-Economics will use an updated version of the division data. For this reason you should provide the target endpoint in your Division requests to be sure to get back the correct specific division data for your usage.

Not providing the target will return data that should be mostly backward compatible but might fail in specific regions.

2021-08-17#

Dossier creation and Dossier update endpoints updated:

Removed deprecated valuationOverrideReasonFreetext field.

2021-08-10#

Property, Property Light, Dossier creation, Dossier search, Dossier update, Valuation, Valuation Light updated:

Changed balconyArea field type from integer to float.
Changed gardenArea field type from integer to float.
Changed landArea field type from integer to float.
Changed volume field type from integer to float.

2021-07-28#

Offer search added numberOfBedrooms filter and response fields for Belgium.

2021-06-07#

Building Projects added isPreciselyLocated response field.

2021-05-06#

Authentication access_tokens are now valid for 12h

2021-04-12#

Added the Dossier read endpoint
Added daysOnMarket filter on Offer search and Offer statistics endpoints
Removed scores.quality and scores.condition response fields on Valuation endpoint

2021-03-18#

Changed the type of Property's livingArea from integer to float

2021-03-12#

Removed deprecated Valuation Light & Shared Valuation endpoints

2021-01-15#

Removed deprecated Valuation Basic endpoint.

2020-10-28#

divisionsLevel100 request field on Socio-Economics endpoint is no longer supported in DE

2020-10-26#

Added landArea filter on Offer search endpoint

2020-08-19#

Added Dossier Logos endpoint
Added logo to Dossier Creation endpoint
Added logo to Dossier Update endpoint

2020-07-09#

Added renovationYear for CH to the Property type (used by the Valuation, Dossier Creation and Dossier Update endpoints)

2020-07-06#

Added offerIds filter on Offer search endpoint

2020-06-30#

Dossier search endpoint updated:

Removed deprecated coverImage response field.

2020-06-04#

Removed deprecated Location Information endpoint

2020-05-27#

Added Offer Statistics Light endpoint

2020-05-18#

Added Dossier search endpoint

2020-05-14#

Extended Administrative Divisions endpoint with AT support

2020-04-03#

Added Buildings endpoint

2020-03-20#

Added Dossier update endpoint
Added Dossier deletion endpoint

2020-03-13#

Added Dossier images endpoint
Added images to Dossier Creation endpoint
Added Dossier image type object

2020-03-11#

Added description to Dossier Creation endpoint
Added askingSalePrice to Dossier Creation endpoint

2019-09-23#

Added buildingYear and hasParkingSpaces filters on Transaction search endpoint

2019-09-20#

Added Transaction Statistics endpoint

2019-09-17#

Added buildingYear filter on Offer search endpoint
Added coordinates, radius, numberOfRooms, livingArea, salePrice, rentGross, isActive, buildingYear filters on Offer Statistics endpoint

2019-08-06#

Offer search endpoint updated:

Added noise request filter and response field.
Added slope request filter and response field.
Added distanceHospital request filter and response field.
Added distanceGroceryStore request filter and response field.
Added distancePublicTransport request filter and response field.
Added isWheelchairAccessible request filter and response field.

2019-07-10#

Added Socio-Economics Types endpoint

2019-07-05#

Added Socio-Economics endpoint

2019-07-02#

Added Division Children endpoint

2019-05-20#

Extended Valuation endpoint to return also the net rent value (in CH)

2019-05-10#

Added Transaction Search endpoint

2019-04-18#

Added Building Projects endpoint

2019-03-22#

Added Isochrones endpoint

2019-03-15#

Added International Valuation Light endpoint and deprecated CH Valuation Light

2019-03-14#

Extended Location scores endpoint with international support

2019-03-08#

Removed locale parameter from endpoints that do not need it

2019-02-15#

Added Points of Interest endpoint

2019-01-14#

Removed deprecated Property match endpoint

2019-01-07#

Added Offer Statistics endpoint

2018-11-23#

Added Valuation endpoint

2018-11-19#

Updated the Offer search specs with new offset & limit max values

2018-11-16#

Added Dossier Creation endpoint
Added Dossier Sharing endpoint
Added Property type object

2018-10-26#

Added Location scores endpoint
Marked Location Information endpoint as been deprecated.

2018-10-05#

Offer search endpoint updated:

Removed filters.propertyType.subcode request field option house_row
Changed filters.livingArea.min request field type from float to integer.
Changed filters.livingArea.max request field type from float to integer.
Changed landArea response field type from float to integer.
Changed livingArea response field type from float to integer.
Changed volume response field type from float to integer.

2018-09-03#

Marked Shared Valuation endpoint as deprecated.

2018-08-20#

Added Offer search endpoint and marked Property match endpoint as deprecated.

2018-06-06#

Added documentation for (German) Appraisals.

2018-05-03#

Valuation Light: Increased max limit of livingArea from 400.0 to 500.0.