POST
/
v2
/
property
/
_similars
curl --request POST \
  --url https://api.f6o.co/v2/property/_similars \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "excludedFields": [
    "<string>"
  ],
  "flxId": "<string>",
  "includedFields": [
    "<string>"
  ],
  "similarityStrategy": "SEARCH",
  "size": 123
}'
{
  "apiVersion": "<string>",
  "context": "<string>",
  "data": [
    {
      "adverts": [
        {
          "anomalies": [
            "UNKNOWN_ANOMALY"
          ],
          "contactInCharge": {
            "email": "<string>",
            "firstName": "<string>",
            "lastName": "<string>",
            "phoneNumber": "<string>",
            "pseudonym": "<string>"
          },
          "description": "<string>",
          "firstPublishedAt": "2023-11-07T05:31:56Z",
          "firstSeenAt": "2023-11-07T05:31:56Z",
          "flxId": "<string>",
          "hasAnomaly": true,
          "isOnline": true,
          "isPro": true,
          "lastSeenAt": "2023-11-07T05:31:56Z",
          "lastUpdatedAt": "2023-11-07T05:31:56Z",
          "legacyId": "<string>",
          "location": [
            123
          ],
          "medias": {
            "images": [
              {
                "caption": "<string>",
                "gaussianHash": "<string>",
                "imageId": "<string>",
                "meanHash": "<string>",
                "perceptualHash": "<string>",
                "room": "ROOM_UNKNOWN",
                "s3Path": "<string>",
                "tags": [
                  "<string>"
                ],
                "url": "<string>"
              }
            ],
            "virtualVisitExternalUrl": [
              "<string>"
            ]
          },
          "offlineAt": "2023-11-07T05:31:56Z",
          "price": {
            "charges": {
              "monthlyRentSupplement": 123,
              "yearlyCondoniumFees": 123,
              "yearlyElectricityFees": 123,
              "yearlyHeatingFees": 123,
              "yearlyHousingTax": 123,
              "yearlyLivingTax": 123,
              "yearlyRentalFees": 123
            },
            "currency": "CURRENCY_EUR",
            "highest": {
              "source": {
                "flxId": "<string>",
                "url": "<string>",
                "website": "<string>"
              },
              "value": 123,
              "valuePerArea": 123
            },
            "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
            },
            "lowest": {
              "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>"
        }
      ],
      "advertsLength": 123,
      "anomalies": [
        "UNKNOWN_ANOMALY"
      ],
      "description": "<string>",
      "estimatedPrice": {
        "source": {
          "flxId": "<string>",
          "url": "<string>",
          "website": "<string>"
        },
        "value": 123,
        "valuePerArea": 123
      },
      "firstKnownAdFlxId": "<string>",
      "firstKnownAdLegacyId": "<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": "2023-11-07T05:31:56Z",
          "epcClimateScore": 123,
          "epcEnergy": "ENERGY_CLASSIFICATION_UNKNOWN",
          "epcEnergyDate": "2023-11-07T05:31:56Z",
          "epcEnergyScore": 123
        },
        "features": {
          "constructionMaterials": [
            "MATERIAL_UNKNOWN"
          ],
          "exposure": "EXPOSURE_UNKNOWN",
          "furniture": "UNKNOWN_FURNITURE",
          "glazingTypes": [
            "GLAZING_TYPE_UNKNOWN"
          ],
          "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"
        ],
        "kitchenEquipped": "KITCHEN_UNKNOWN_EQUIPPED",
        "propertyCondition": {
          "constructionYear": 123,
          "generalConditions": [
            "GENERAL_CONDITION_UNKNOWN"
          ],
          "interiorCondition": "INTERIOR_CONDITION_UNKNOWN",
          "renovationYear": 123
        },
        "roomCount": 123,
        "roomsDetails": [
          {
            "area": 123,
            "contextInfo": [
              "<string>"
            ],
            "floor": 123,
            "roomType": "ROOM_TYPE_UNKNOWN"
          }
        ],
        "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,
      "history": [
        {
          "daysSinceFirstSeen": 123,
          "price": 123,
          "pricePerArea": 123,
          "seenAt": "2023-11-07T05:31:56Z",
          "source": {
            "flxId": "<string>",
            "url": "<string>",
            "website": "<string>"
          }
        }
      ],
      "historyLength": 123,
      "imagesLength": 123,
      "indexTimestamp": "2023-11-07T05:31:56Z",
      "isCityCenter": true,
      "isUrgent": true,
      "land": {
        "canConstruct": true,
        "hasBuildingPermit": true,
        "hasElectricity": true,
        "hasTelecom": true,
        "hasWater": true,
        "isServiced": true,
        "surface": 123,
        "surfaceConstructable": 123,
        "type": "LAND_UNKNOWN"
      },
      "location": {
        "address": {
          "number": "<string>",
          "streetName": "<string>"
        },
        "city": "<string>",
        "cityCoordinate": {
          "h3Indices": {
            "h3Index1": "<string>",
            "h3Index10": "<string>",
            "h3Index11": "<string>",
            "h3Index12": "<string>",
            "h3Index2": "<string>",
            "h3Index3": "<string>",
            "h3Index4": "<string>",
            "h3Index5": "<string>",
            "h3Index6": "<string>",
            "h3Index7": "<string>",
            "h3Index8": "<string>",
            "h3Index9": "<string>"
          },
          "location": [
            123
          ]
        },
        "department": "<string>",
        "inseeCode": "<string>",
        "irisCode": "<string>",
        "locationCoordinate": {
          "h3Indices": {
            "h3Index1": "<string>",
            "h3Index10": "<string>",
            "h3Index11": "<string>",
            "h3Index12": "<string>",
            "h3Index2": "<string>",
            "h3Index3": "<string>",
            "h3Index4": "<string>",
            "h3Index5": "<string>",
            "h3Index6": "<string>",
            "h3Index7": "<string>",
            "h3Index8": "<string>",
            "h3Index9": "<string>"
          },
          "location": [
            123
          ]
        },
        "postalCode": "<string>"
      },
      "medias": {
        "images": [
          {
            "caption": "<string>",
            "gaussianHash": "<string>",
            "imageId": "<string>",
            "meanHash": "<string>",
            "perceptualHash": "<string>",
            "room": "ROOM_UNKNOWN",
            "s3Path": "<string>",
            "tags": [
              "<string>"
            ],
            "url": "<string>"
          }
        ],
        "virtualVisitExternalUrl": [
          "<string>"
        ]
      },
      "meta": {
        "firstPublishedAt": "2023-11-07T05:31:56Z",
        "firstSeenAt": "2023-11-07T05:31:56Z",
        "isTotallyOffline": true,
        "lastPublishedAt": "2023-11-07T05:31:56Z",
        "lastSeenAt": "2023-11-07T05:31:56Z",
        "lastUpdatedAt": "2023-11-07T05:31:56Z",
        "totallyOfflineAt": "2023-11-07T05:31:56Z"
      },
      "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": {
        "charges": {
          "monthlyRentSupplement": 123,
          "yearlyCondoniumFees": 123,
          "yearlyElectricityFees": 123,
          "yearlyHeatingFees": 123,
          "yearlyHousingTax": 123,
          "yearlyLivingTax": 123,
          "yearlyRentalFees": 123
        },
        "currency": "CURRENCY_EUR",
        "highest": {
          "source": {
            "flxId": "<string>",
            "url": "<string>",
            "website": "<string>"
          },
          "value": 123,
          "valuePerArea": 123
        },
        "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
        },
        "lowest": {
          "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
      },
      "process": "PROCESS_UNKNOWN",
      "tags": [
        "<string>"
      ],
      "title": "<string>",
      "type": "CLASS_UNKNOWN",
      "websiteRefs": [
        "<string>"
      ]
    }
  ],
  "internalDelay": 123
}

Authorizations

x-api-key
string
headerrequired

API Key used to be authentified to these APIs. Please contact Fluximmo to get one

Body

application/json
excludedFields
string[]
flxId
string
includedFields
string[]
similarityStrategy
enum<string>
default: SEARCH
Available options:
SEARCH
size
integer

Response

200 - application/json
apiVersion
string
context
string
data
object[]
internalDelay
integer

Was this page helpful?