Mapping output data
Description of the output data structure for Search By Attribute, Full Search By Attribute and Comparable Detail services. The Full Search By Attribute service corresponds to the union Search By Attribute and Comparable Detail, but it is available exclusively for Asking data, not for Sales data.
For Projects, a dedicated Comparable Detail endpoint is provided, accessible using a project uuid obtained via Search By Attribute.
Fields that are guaranteed to be available are marked with an asterisk (*). All other fields are not always available: if a value is missing, the returned value will be NULL.
General Mapping
| /comparables/searchByAttribute | "/comparable/ | Description | Type |
|---|---|---|---|
| agencyID | ID of the agency managing the listing – field available on request | int | |
| coverImage | attachments.coverImage | Cover image | str |
| image | attachments.image | Image gallery | str[] |
| cadastralData.cadastralMapSheetNumber | Cadastral sheet only for comparable type Sale | str | |
| cadastralData.cadastralMunicipality | Cadastral municipality only for comparable type Sale | str | |
| cadastralData.cadastralParcelNumber | Cadastral parcel only for comparable type Sale | str | |
| cadastralData.cadastralParceSubParcelNumber | Cadastral subunit only for comparable type Sale | str | |
| cadastralData.cadastralPropertyType | Cadastral category only for comparable type Sale | str | |
| cadastralData.cadastralRegistry | Type of cadastral registry only for comparable type Sale | str | |
| cadastralData.cadastralClass | Cadastral class only for comparable type Sale | str | |
| cadastralData.cadastralCompartments | Spaces within a property which are enclosed by walls. Only for comparable type Sale | int | |
| cadastralData.cadastralIncome | Cadastral income only for comparable type Sale | numeric | |
| collectionDate | Listing creation date | str | |
| comparableType | comparableType | Comparable type: Asking or Sale (with varying levels of completeness) | str |
| duplicates | Size of any duplicate cluster | int | |
| duplicatesParent | Indicates whether the listing is the oldest within a duplicate cluster | bool | |
| extra.broadbandInternet | Broadband internet availability | bool | |
| extra.chimneyFlue | Chimney flue included | bool | |
| extra.condoFees | Condominium fees | numeric | |
| extra.disabledPeopleAccess | Disabled access availability | bool | |
| extra.fumeAspiration | Fume aspiration included | bool | |
| extra.garageDoorWidth | Garage entrance width | numeric | |
| extra.lastCommercialUse | Information on previous intended use, if its a commercial property | str | |
| extra.reception | doorman included | bool | |
| extra.securityAlarm | Alarm system | bool | |
| extra.shedHeight | Shed height | numeric | |
| extra.showCases | Number of shop windows, if its a commercial property | numeric | |
| extra.showCasesSize | Size of shop windows, if its a commercial property | numeric | |
| feature.centralityBelt | OMI zone | str | |
| feature.facilityList | Any tags assigned to the listing e.g., alarm system, security door, video intercom | str[] | |
| heatingSystem | feature.heatingSystem | Heating system | str |
| feature.occupancyStatus | Occupancy status of the property, Free or Rented | str | |
| feature.propertyQuality | Property quality, e.g., High-end, Luxury… | str | |
| box_auto | features.box | Information about garage or parking spaces | str |
| features.constructionYear | Year of construction | int | |
| features.description * | Description | str | |
| elevator | features.elevator | Elevator | bool |
| energyClass | features.energyClass | Energy efficiency class | str |
| maintenanceStatus | features.maintenanceStatus | Maintenance status of the property | str |
| features.numberOfBalconies | Number of Balconies | int | |
| numberOfBathrooms | features.numberOfBathrooms | Number of bathrooms | int |
| numberOfBuildingFloor | features.numberOfBuildingFloor | Total number of floors | int |
| features.numberOfGarages | Number of garages | int | |
| unitFloor | features.unitFloor | Floor | numeric |
| grossSquareFootage | grossSquareFootage * | Surface area | int |
| salesDate | lastUpdateDate | Listing removal date if Asking, or Sale date only for comparable type Sale | str |
| address | location.address | Address | str |
| location.latitude | Latitude with 0.5 thousandths of a degree precision | numeric | |
| location.longitude | Longitude with 0.5 thousandths of a degree precision | numeric | |
| location.municipality | Municipality | str | |
| location.province | Province | str | |
| location.region | Region | str | |
| propertyType | propertyType * | Property type | str |
| pubblicationStatus | pubblicationStatus * | Listing publication status | str |
| realEstateRegisters.deedDate | Reference: Deed date (year-month format) only for comparable type Sale | str | |
| realEstateRegisters.notary | Notary name only for comparable type Sale | str | |
| realEstateRegisters.particularNumber | Reference: Document number only for comparable type Sale | str | |
| rooms | rooms | Number of rooms | int |
| unitGrossSquareFootage | List of surface details (if available on the listing), commercial surface value could be computed for each surface as "total_surface" * "surface_percentage" / 100 | json[] | |
| unitGrossSquareFootage.floor | Floor (i.e. "1" for first floor or "piano terra" for ground floor) | str | |
| unitGrossSquareFootage.main_surface | Main surface or extra surface, could be True or False | bool | |
| unitGrossSquareFootage.surface_percentage | Percentage to be used to calculate the commercial surface (max 100) | int | |
| unitGrossSquareFootage.total_surface | Surface to be used to calculate the commercial surface | int | |
| unitGrossSquareFootage.type | Surface typology (i.e. "Abitazione", "Appartamento", "Altro", "Balcone", "Garage - box", "Giardino", "Terrazzo", "Capannone", "Piazzale", ...) | str | |
| uuid | uuid * | Unique identifier of the comparable | str |
| askingPrice | value.askingPrice | Price if comparable type Asking | int |
| askingPricePsm | value.askingPricePsm | Price per sqm if comparable type Asking | int |
| price | value.price | Price only for comparable type Sale | int |
| pricePsm | value.pricePsm | Price per sqm only for comparable type Sale | int |
| uri * | URL to request comparable detail | str | |
| distanceFromPoi | Distance from a POI (point of interest), calculable if POI latitude and longitude are provided | int | |
| projUuid | Project identifier, only for type Project, used to access the Project detail sheet | str |
Projects mapping
| /comparables/searchByAttributes (Only if groupProject = true) | /comparable/project/ | Description | Tipo |
|---|---|---|---|
| project.projAddress | Project address, only for Project type | str | |
| projAgencyIDList | project.projAgencyIDList | IDs of the agencies publishing the Project | int[] |
| project.projAttachments.coverImage | Project cover image | str | |
| project.projAttachments.image | Project image gallery | str[] | |
| projCommercialUnits | project.projCommercialUnits | Number of possible commercial units | int |
| project.projDescription | Project description | str | |
| project.projMarketZone | Project area | str | |
| projMaxAskingPrice | project.projMaxAskingPrice | Maximum asking price of the residential units planned in the project | int |
| projMaxAskingPricePsm | project.projMaxAskingPricePsm | Maximum price per sqm of the residential units planned in the project | int |
| projMaxCollectionDate | project.projMaxCollectionDate | Creation date of the most recent listing related to the project | str |
| projMaxEnergyClass | project.projMaxEnergyClass | Maximum expected energy class among the residential units in the project | str |
| projMaxGrossSquareFootage | project.projMaxGrossSquareFootage | Maximum expected square footage among the residential units in the project | int |
| projMaxNumberOfBathrooms | project.projMaxNumberOfBathrooms | Maximum expected number of bathrooms among the residential units in the project | int |
| projMaxRooms | project.projMaxRooms | Maximum expected number of rooms among the residential units in the project | int |
| projMinAskingPrice | project.projMinAskingPrice | Minimum asking price of the residential units planned in the project | int |
| projMinAskingPricePsm | project.projMinAskingPricePsm | Minimum asking price per sqm of the residential units planned in the project | int |
| projMinCollectionDate | project.projMinCollectionDate | Creation date of the oldest listing related to the project | str |
| projMinEnergyClass | project.projMinEnergyClass | Minimum expected energy class among the residential units in the project | str |
| projMinGrossSquareFootage | project.projMinGrossSquareFootage | Minimum expected surface area among the residential units in the project | int |
| projMinNumberOfBathrooms | project.projMinNumberOfBathrooms | Minimum expected number of bathrooms among the residential units in the project | int |
| projMinRooms | project.projMinRooms | Minimum expected number of rooms among the residential units in the project | int |
| project.projMunicipality | Municipality of the Project | str | |
| projName | project.projName | Assigned project name | str |
| project.projNrGarage | Number of garages | int | |
| project.projNrParking | Number of parking spaces | int | |
| project.projNumberOfBuildingFloor | Number of floors | int | |
| projPropertyTypeList | project.projPropertyTypeList | Types of residential units in the project | str[] |
| project.projPubblicationStatus | Publication status | str | |
| projResidentialUnits | project.projResidentialUnits | Number of residential units in the project | int |
| projUriList | project.projUriList | URLs of the detailed listing pages in the project | str[] |
| projUuidList | project.projUuidList | UUIDs of the listings in the project | str[] |
| projWorkEndDate | project.projWorkEndDate | Expected project end date | str |
| projWorkStartDate | project.projWorkStartDate | Expected project start date | str |