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.
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[] |
| 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.condoFees | Condominium fees | numeric | |
| extra.lastCommercialUse | Information on previous intended use, if its a commercial property | str | |
| 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 |
| rooms | rooms | Number of rooms | int |
| 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 |