Skip to content

Search By Property

POST /comparables/searchByProperty

Search for comparables by similarity with a comparison property.

Example Request

curl -X POST --location 'https://comparables-gr.realitycs.it/comparables/searchByProperty' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "filters": {
        "comparableTypeID": 1,
        "contractTypeID": 1,
        "propertyTypeID": [
            101
        ],
        "latitude": 38.002655740556705,
        "longitude": 23.707122802734375,
        "rooms": "0",
        "maintenanceStatusID": null,
        "grossSquareFootage": 42.0,
        "unitFloor": "0",
        "pubblicationStatusID": [
            1,
            2
        ],
        "agency": null
    },
    "pagination": {
        "page": 1,
        "limit": 2
    },
    "sorting": {
        "by": "ranking",
        "direction": "desc"
    }
}'

Example Response

{
    "_metadata": {
        "limit": 2,
        "page": 1,
        "pages": {
            "first": 1,
            "last": 7,
            "next": 2,
            "previous": null,
            "self": 1
        },
        "query": {
            "comparableType": "Listings",
            "contractType": "Sale",
            "grossSquareFootage": 42,
            "latitude": 38.002655740556705,
            "longitude": 23.707122802734375,
            "propertyType": [
                "apartment"
            ],
            "pubblicationStatus": [
                "New",
                "Published"
            ],
            "sorting": {
                "by": "ranking",
                "direction": "desc"
            },
            "unitFloor": 0.0
        },
        "total_count": 13,
        "request_id": "38eb0d2d-809c-42f5-bd92-ae15811739d9"
    },
    "items": [
        {
            "_metadata": [
                "comparabili_maintenancestatus_2",
                "comparabili_comparabletype_1",
                "comparabili_propertytype_101"
            ],
            "agencyID": null,
            "askingPrice": 79000,
            "askingPricePsm": 1179,
            "cadastralPropertyType": null,
            "collectionDate": null,
            "comparableType": "Listings",
            "coverImage": "https://m2.spitogatos.gr/252476936_1600x1200.jpg",
            "dataOwnership": "realitycs",
            "distance": 303,
            "distanceFromPoi": null,
            "duplicates": null,
            "duplicatesParent": null,
            "elevator": null,
            "energyClass": null,
            "grossSquareFootage": 67,
            "grossSquareFootageDelta": 59.52,
            "lastUpdateDate": null,
            "latitude": "38.000271",
            "longitude": "23.705599",
            "maintenanceStatus": null,
            "marketParentZone": true,
            "marketZone": null,
            "municipality": null,
            "municipalityID": 6010,
            "numberOfBathrooms": null,
            "numberOfGarages": null,
            "numberofbuildingfloor": null,
            "price": null,
            "pricePsm": null,
            "propertyType": "apartment",
            "propertyTypeID": null,
            "province": null,
            "pubblicationStatus": "Published",
            "region": null,
            "rooms": null,
            "salesDate": null,
            "similarityRanking": 87.96,
            "unitFloor": null,
            "uri": "/comparable/a3ccec95-1100-4957-9a2c-e42d3e96bb5c",
            "uuid": "a3ccec95-1100-4957-9a2c-e42d3e96bb5c",
            "value": null,
            "valuePsm": null
        },
        {
            "_metadata": [
                "comparabili_maintenancestatus_2",
                "comparabili_comparabletype_1",
                "comparabili_propertytype_101"
            ],
            "agencyID": null,
            "askingPrice": 200000,
            "askingPricePsm": 2353,
            "cadastralPropertyType": null,
            "collectionDate": null,
            "comparableType": "Listings",
            "coverImage": "https://m2.spitogatos.gr/282553180_1600x1200.jpg",
            "dataOwnership": "realitycs",
            "distance": 226,
            "distanceFromPoi": null,
            "duplicates": null,
            "duplicatesParent": null,
            "elevator": null,
            "energyClass": null,
            "grossSquareFootage": 85,
            "grossSquareFootageDelta": 102.38,
            "lastUpdateDate": null,
            "latitude": "38.000759",
            "longitude": "23.70789",
            "maintenanceStatus": null,
            "marketParentZone": true,
            "marketZone": null,
            "municipality": null,
            "municipalityID": 6010,
            "numberOfBathrooms": null,
            "numberOfGarages": null,
            "numberofbuildingfloor": null,
            "price": null,
            "pricePsm": null,
            "propertyType": "apartment",
            "propertyTypeID": null,
            "province": null,
            "pubblicationStatus": "New",
            "region": null,
            "rooms": null,
            "salesDate": null,
            "similarityRanking": 87.38,
            "unitFloor": null,
            "uri": "/comparable/ede4e30d-eac1-430d-8b8a-daaa22259e26",
            "uuid": "ede4e30d-eac1-430d-8b8a-daaa22259e26",
            "value": null,
            "valuePsm": null
        }
    ]
}

Request Fields

Required column Meaning
* mandatory in the input
** at least one of these parameters is mandatory in the input
* mandatory based on the value of another parameter
*** optional parameter recommended for the reference property

Request fields

Field Required Type Example Notes
comparableTypeID * int / list[int] 1 Check Taxonomies General
contractTypeID * int 2 depends on comparableTypeID
propertyTypeID * int / list[int] 1 Check Taxonomies General
latitude * float 45.11
longitude * float 12.3
rooms *** int 3
constructionYear int 1987
bathrooms int 2
elevator bool false
maintenanceStatusID *** int 3 Check Taxonomies General
grossSquareFootage *** int 120
unitFloor *** float 1.0
energyClassID int 5 Check Taxonomies General
heatingSystemID int 2 Check Taxonomies General

Pagination example usage

{
   "Filters": {
       ... filters ...
    },
"Pagination": {
    "page": 1,
    "limit": 10
    }
}
N.B. The pagination object can be omitted from the json body, and if so, the default limit and page will be used (see below)

Pagination filters

filter default Type Description
page 1 int Shows results in the indicated page
limit 5 int Sets the maximum number of results per page (can be configured differently if requested through sales)

Sorting example usage

{
   "Filters": {
       ... filters ...
    },
"Sorting": {
    "by": "date",
    "direction": "desc"
    }
}
N.B. The sorting object can be omitted from the json body, and if so, the default by and direction will be used (see below)

Sorting filters

filter default Type Description
by date str Orders the results by either ranking,energyclass or distance relative to a POI
direction desc str List the results by ascending (asc) or descending (desc) order