POST
/
v2
/
protected
/
properties
/
similars
const request = require('request');

const options = {
  method: 'POST',
  url: 'https://api.fluximmo.io/v2/protected/properties/similars',
  headers: {'content-type': 'application/json', 'x_api_key': 'REPLACE_KEY_VALUE'},
  body: {flxId: 'string', similarityStrategy: 'SEARCH', size: 10},
  json: true
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
{
  "data": [
    {
      "adverts": [
        {
          "description": "<string>",
          "firstSeenAt": "2022-10-21T11:31:33.593Z",
          "flxId": "<string>",
          "hasAnomaly": true,
          "isExclusive": true,
          "isOnline": true,
          "isPro": true,
          "lastSeenAt": "2022-10-21T11:31:33.593Z",
          "location": [
            123
          ],
          "medias": {
            "images": [
              {
                "url": "<string>"
              }
            ],
            "virtualVisitExternalUrl": [
              "<string>"
            ]
          },
          "offlineAt": "2022-10-21T11:31:33.593Z",
          "price": {
            "currency": "CURRENCY_EUR",
            "initial": {
              "source": {
                "flxId": "<string>",
                "url": "<string>",
                "website": "<string>"
              },
              "value": 123,
              "valuePerArea": 123
            },
            "isAuction": true,
            "latest": {
              "source": {
                "flxId": "<string>",
                "url": "<string>",
                "website": "<string>"
              },
              "value": 123,
              "valuePerArea": 123
            },
            "scope": "PRICING_ONE_OFF",
            "variation": {
              "absoluteSinceLastModified": 123,
              "absoluteSincePublished": 123,
              "sinceLastModified": 123,
              "sincePublished": 123
            },
            "warrantyDeposit": 123
          },
          "seller": {
            "flxId": "<string>",
            "name": "<string>",
            "siren": "<string>",
            "type": "SELLER_TYPE_UNKNOWN"
          },
          "source": {
            "flxId": "<string>",
            "url": "<string>",
            "website": "<string>"
          },
          "title": "<string>"
        }
      ],
      "description": "<string>",
      "flxId": "<string>",
      "habitation": {
        "bathroomCount": 123,
        "bedroomCount": 123,
        "characteristics": {
          "hasAlarm": true,
          "hasBalcony": true,
          "hasCellar": true,
          "hasConcierge": true,
          "hasDigicode": true,
          "hasFireplace": true,
          "hasGarage": true,
          "hasGarden": true,
          "hasGrenier": true,
          "hasInterphone": true,
          "hasJacuzzi": true,
          "hasLand": true,
          "hasLift": true,
          "hasMezzanine": true,
          "hasParking": true,
          "hasPool": true,
          "hasTerrace": true,
          "hasVisAVis": true,
          "isPeaceful": true
        },
        "climate": {
          "epcClimate": "GREENHOUSE_CLASSIFICATION_UNKNOWN",
          "epcClimateDate": "2022-10-21T11:31:33.593Z",
          "epcClimateScore": 123,
          "epcEnergy": "ENERGY_CLASSIFICATION_UNKNOWN",
          "epcEnergyDate": "2022-10-21T11:31:33.593Z",
          "epcEnergyScore": 123
        },
        "features": {
          "constructionMaterials": "MATERIAL_UNKNOWN",
          "exposure": "EXPOSURE_UNKNOWN",
          "furniture": "UNKNOWN_FURNITURE",
          "hasThroughExposure": true,
          "propertyFloor": 123,
          "propertyTotalFloor": 123,
          "viewOns": "VIEW_ON_UNKNOWN",
          "viewTypes": "VIEW_TYPE_UNKNOWN"
        },
        "heatTypeDetails": [
          "HEAT_DETAIL_UNKNOWN"
        ],
        "heatTypes": [
          "HEAT_TYPE_UNKNOWN"
        ],
        "heatings": [
          "HEATING_UNKNOWN"
        ],
        "propertyCondition": {
          "constructionYear": 123,
          "generalConditions": "GENERAL_CONDITION_UNKNOWN",
          "interiorCondition": "INTERIOR_CONDITION_UNKNOWN",
          "renovationYear": 123
        },
        "roomCount": 123,
        "surface": {
          "balconies": 123,
          "floorSpace": 123,
          "gardens": 123,
          "groundFloor": 123,
          "kitchen": 123,
          "livingRoom": 123,
          "livingSpace": 123,
          "terraces": 123,
          "total": 123
        },
        "type": "PROPERTY_TYPE_UNKNOWN",
        "wcCount": 123
      },
      "hasAnomaly": true,
      "isUrgent": true,
      "land": {
        "canConstruct": true,
        "hasBuildingPermit": true,
        "hasElectricity": true,
        "hasTelecom": true,
        "hasWater": true,
        "isServiced": true,
        "surface": 123,
        "surfaceConstructable": 123,
        "type": "LAND_UNKNOWN"
      },
      "location": {
        "city": "<string>",
        "cityCoordinate": {
          "location": [
            123
          ]
        },
        "department": "<string>",
        "inseeCode": "<string>",
        "irisCode": "<string>",
        "locationCoordinate": {
          "location": [
            123
          ]
        },
        "postalCode": "<string>"
      },
      "medias": {
        "images": [
          {
            "url": "<string>"
          }
        ],
        "virtualVisitExternalUrl": [
          "<string>"
        ]
      },
      "meta": {
        "firstSeenAt": "2022-10-21T11:31:33.593Z",
        "isTotallyOffline": true,
        "lastPublishedAt": "2023-11-07T05:31:56Z",
        "lastSeenAt": "2022-10-21T11:31:33.593Z",
        "lastUpdatedAt": "2022-10-21T11:31:33.593Z",
        "totallyOfflineAt": "2022-10-21T11:31:33.593Z"
      },
      "offer": {
        "isCurrentlyOccupied": true,
        "renting": {
          "isColocation": true,
          "isLongTerm": true,
          "isShortTerm": true,
          "isSubLease": true
        },
        "type": "OFFER_UNKNOWN"
      },
      "parking": {
        "count": 123,
        "numberOfCars": 123,
        "surface": 123,
        "type": "PARKING_UNKNOWN"
      },
      "price": {
        "currency": "CURRENCY_EUR",
        "initial": {
          "source": {
            "flxId": "<string>",
            "url": "<string>",
            "website": "<string>"
          },
          "value": 123,
          "valuePerArea": 123
        },
        "isAuction": true,
        "latest": {
          "source": {
            "flxId": "<string>",
            "url": "<string>",
            "website": "<string>"
          },
          "value": 123,
          "valuePerArea": 123
        },
        "scope": "PRICING_ONE_OFF",
        "variation": {
          "absoluteSinceLastModified": 123,
          "absoluteSincePublished": 123,
          "sinceLastModified": 123,
          "sincePublished": 123
        },
        "warrantyDeposit": 123
      },
      "tags": [
        "<string>"
      ],
      "title": "<string>",
      "type": "CLASS_UNKNOWN"
    }
  ]
}

Authorizations

x-api-key
string
headerrequired

Body

application/json
flxId
string
required

FlxId of the property to find similar properties for

similarityStrategy
enum<string>
required
Available options:
SEARCH
size
number
default: 10required

Response

200 - application/json
data
object[]

Was this page helpful?