POST
/
v2
/
protected
/
properties
/
search
curl --request POST \
  --url https://api.fluximmo.io/v2/protected/properties/search \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "orderBy": "DESC",
  "search": {
    "filterProperty": {
      "adverts": [],
      "habitation": {
        "bathroomCount": {
          "max": 123,
          "min": 123
        },
        "bedroomCount": {
          "max": 123,
          "min": 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": [],
          "epcClimateScore": {
            "max": 123,
            "min": 123
          },
          "epcEnergy": [],
          "epcEnergyScore": {
            "max": 123,
            "min": 123
          },
          "epcClimateDate": {
            "max": "2022-10-21T11:31:33.593Z",
            "min": "2022-10-21T11:31:33.593Z"
          },
          "epcEnergyDate": {
            "max": "2022-10-21T11:31:33.593Z",
            "min": "2022-10-21T11:31:33.593Z"
          }
        },
        "features": {
          "exposure": [],
          "furniture": [],
          "propertyFloor": {
            "max": 123,
            "min": 123
          },
          "propertyTotalFloor": {
            "max": 123,
            "min": 123
          },
          "constructionMaterials": [],
          "glazingTypes": [],
          "hasThroughExposure": true,
          "viewOns": [],
          "viewTypes": []
        },
        "heatTypes": [],
        "heatTypeDetails": [],
        "heatings": [],
        "propertyCondition": [
          {
            "constructionYear": 123,
            "interiorCondition": null,
            "renovationYear": 123,
            "generalConditions": []
          }
        ],
        "roomCount": {
          "max": 123,
          "min": 123
        },
        "surface": {
          "balconies": {
            "max": 123,
            "min": 123
          },
          "floorSpace": {
            "max": 123,
            "min": 123
          },
          "gardens": {
            "max": 123,
            "min": 123
          },
          "groundFloor": {
            "max": 123,
            "min": 123
          },
          "kitchen": {
            "max": 123,
            "min": 123
          },
          "livingSpace": {
            "max": 123,
            "min": 123
          },
          "livingroom": {
            "max": 123,
            "min": 123
          },
          "terraces": {
            "max": 123,
            "min": 123
          },
          "total": {
            "max": 123,
            "min": 123
          }
        },
        "type": "PROPERTY_TYPE_T1_T2",
        "wcCount": {
          "max": 123,
          "min": 123
        }
      },
      "isUrgent": true,
      "land": {
        "canConstruct": true,
        "isServiced": true,
        "surface": {
          "max": 123,
          "min": 123
        },
        "surfaceConstructable": {
          "max": 123,
          "min": 123
        },
        "type": [],
        "haveBuildingPermit": true,
        "haveElectricity": true,
        "haveTelecom": true,
        "haveWater": true
      },
      "location": [],
      "meta": {
        "firstSeenAt": {
          "max": "2022-10-21T11:31:33.593Z",
          "min": "2022-10-21T11:31:33.593Z"
        },
        "isTotallyOffline": true,
        "lastPublishedAt": {
          "max": "2022-10-21T11:31:33.593Z",
          "min": "2022-10-21T11:31:33.593Z"
        },
        "lastSeenAt": {
          "max": "2022-10-21T11:31:33.593Z",
          "min": "2022-10-21T11:31:33.593Z"
        },
        "lastUpdatedAt": {
          "max": "2022-10-21T11:31:33.593Z",
          "min": "2022-10-21T11:31:33.593Z"
        }
      },
      "parking": {
        "count": {
          "max": 123,
          "min": 123
        },
        "numberOfCars": {
          "max": 123,
          "min": 123
        },
        "surface": {
          "max": 123,
          "min": 123
        },
        "type": []
      },
      "price": {
        "currency": [],
        "initial": {
          "source": {
            "flxId": "<string>",
            "url": "<string>",
            "website": "<string>"
          },
          "value": {
            "max": 123,
            "min": 123
          },
          "valuePerArea": {
            "max": 123,
            "min": 123
          }
        },
        "isAuction": true,
        "latest": {
          "source": {
            "flxId": "<string>",
            "url": "<string>",
            "website": "<string>"
          },
          "value": {
            "max": 123,
            "min": 123
          },
          "valuePerArea": {
            "max": 123,
            "min": 123
          }
        },
        "scope": [],
        "warrantyDeposit": {
          "max": 123,
          "min": 123
        },
        "variation": []
      },
      "process": [],
      "tags": [
        "<string>"
      ],
      "type": [
        "CLASS_HOUSE"
      ],
      "hasAnomaly": true,
      "offer": []
    },
    "fullTexts": [
      "<string>"
    ],
    "keywords": [
      "<string>"
    ]
  },
  "searchAfterHash": "<string>",
  "size": 10,
  "sortBy": "FIRST_SEEN_AT"
}'
{
  "data": {
    "items": [
      {
        "adverts": [
          {
            "contactInCharge": {
              "email": "<string>",
              "firstName": "<string>",
              "lastName": "<string>",
              "phoneNumber": "<string>",
              "pseudonym": "<string>"
            },
            "description": "<string>",
            "firstSeenAt": "2022-10-21T11:31:33.593Z",
            "flxId": "<string>",
            "isOnline": true,
            "lastSeenAt": "2022-10-21T11:31:33.593Z",
            "location": [
              123
            ],
            "medias": {
              "images": [
                {
                  "gaussianHash": "<string>",
                  "imageId": "<string>",
                  "meanHash": "<string>",
                  "perceptualHash": "<string>",
                  "url": "<string>"
                }
              ],
              "virtualVisitExternalUrl": [
                "<string>"
              ]
            },
            "price": {
              "currency": null,
              "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": null,
              "warrantyDeposit": 123,
              "variation": {
                "sinceLastModified": 123,
                "sincePublished": 123,
                "absoluteSinceLastModified": 123,
                "absoluteSincePublished": 123
              }
            },
            "source": {
              "flxId": "<string>",
              "url": "<string>",
              "website": "<string>"
            },
            "title": "<string>",
            "offlineAt": "2022-10-21T11:31:33.593Z",
            "hasAnomaly": true,
            "isPro": true,
            "seller": {
              "flxId": "<string>",
              "name": "<string>",
              "siren": "<string>",
              "type": "SELLER_TYPE_AGENCY"
            },
            "isExclusive": true
          }
        ],
        "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_C",
            "epcClimateScore": 123,
            "epcEnergy": "ENERGY_CLASSIFICATION_C",
            "epcEnergyScore": 123,
            "epcClimateDate": "2022-10-21T11:31:33.593Z",
            "epcEnergyDate": "2022-10-21T11:31:33.593Z"
          },
          "features": {
            "exposure": null,
            "furniture": null,
            "propertyFloor": 123,
            "propertyTotalFloor": 123,
            "viewTypes": [],
            "constructionMaterials": [],
            "hasThroughExposure": true,
            "viewOns": []
          },
          "heatTypes": [],
          "heatTypeDetails": [],
          "heatings": [],
          "propertyCondition": {
            "constructionYear": 123,
            "interiorCondition": null,
            "renovationYear": 123,
            "generalConditions": []
          },
          "roomCount": 123,
          "surface": {
            "balconies": 123,
            "floorSpace": 123,
            "gardens": 123,
            "groundFloor": 123,
            "kitchen": 123,
            "livingSpace": 123,
            "livingRoom": 123,
            "terraces": 123,
            "total": 123
          },
          "type": [],
          "wcCount": 123
        },
        "hasAnomaly": true,
        "isUrgent": true,
        "land": {
          "canConstruct": true,
          "hasBuildingPermit": true,
          "hasElectricity": true,
          "hasTelecom": true,
          "hasWater": true,
          "isServiced": true,
          "surface": 123,
          "surfaceConstructable": 123,
          "type": null
        },
        "location": {
          "city": "<string>",
          "cityCoordinate": {
            "location": [
              2.3522,
              48.8566
            ]
          },
          "department": "<string>",
          "inseeCode": "<string>",
          "irisCode": "<string>",
          "locationCoordinate": {
            "location": [
              2.3522,
              48.8566
            ]
          },
          "postalCode": "<string>"
        },
        "medias": {
          "images": [
            {
              "gaussianHash": "<string>",
              "imageId": "<string>",
              "meanHash": "<string>",
              "perceptualHash": "<string>",
              "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"
        },
        "parking": {
          "count": 123,
          "numberOfCars": 123,
          "surface": 123,
          "type": null
        },
        "price": {
          "currency": null,
          "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": null,
          "warrantyDeposit": 123,
          "variation": {
            "sinceLastModified": 123,
            "sincePublished": 123,
            "absoluteSinceLastModified": 123,
            "absoluteSincePublished": 123
          }
        },
        "tags": [
          "<string>"
        ],
        "title": "<string>",
        "type": "CLASS_HOUSE",
        "offer": {
          "isCurrentlyOccupied": true,
          "renting": {
            "isColocation": true,
            "isLongTerm": true,
            "isShortTerm": true,
            "isSubLease": true
          },
          "type": "OFFER_BUY"
        }
      }
    ],
    "searchAfterHash": "<string>",
    "count": 123
  }
}

Authorizations

x-api-key
string
header
required

Body

application/json
orderBy
enum<string>
required
Available options:
ASC,
DESC
size
number
default:10
required
Example:

10

sortBy
enum<string>
required
Available options:
FIRST_SEEN_AT,
PRICE,
LAST_UPDATED_AT,
LAST_SEEN_AT,
RELEVANCE
searchAfterHash
string

The searchAfterHash parameter allows you to retrieve the next page of results by using the searchAfterHash value returned in the response from the previous page. This method eliminates the complexities of traditional pagination methods and ensures accurate results, regardless of insertions or deletions in the dataset.

Response

200
application/json
data
object
required