Documentation

Book a call

Contact us

Real-estate data API - Fluximmo V2 (2.1.0)

Search and alerts

Analytics

My Account

Get the search criteria of all your Property alerts

Get all your Property alerts

The classification value of the greenhouse gas emission classification - GES

The value of the greenhouse gas emission classification - GES in kgCO2/m²/year

The classification value of the energy classification - DPE

The value of the energy classification - DPE in kWhEP/m²/year

Date filter - Date should be in ISO format (ex: `2022-10-21T11:31:33.593Z`)

An anomaly or incoherence have been detected

The surface of the balconies in m² - we rarely have this information

The surface of the total floors in m² - we rarely have this information

The surface of the gardens in m² - we rarely have this information

The surface of the ground floor in m² - we rarely have this information

The surface of the kitchen in m² - we rarely have this information

The surface of the living space in m² - we rarely have this information

The surface of the living room in m² - we rarely have this information

The surface of the terraces in m² - we rarely have this information

The total habitable surface of the property in m²

Search terms for full text search. We'll search in title, description, and keywords for terms similar to these (typically, we'll use a fuzzy search).

Search terms for keyword search. We'll search in title, description, and keywords for exact matches to these terms (typically, we'll use a term search).

x api key

Real estate data to power workflows, business applications and decision-making

Introduction

To get started using the Fluximmo API, you'll need to get an API-KEY

Authentification

Real-estate market can be conceptualized in different ways. We offer two different conceptualization depending on your needs: Properties & Adverts.

Properties & Adverts

Webhooks are a lightweight solution for delivering real-time notifications and data updates, eliminating the need for a comprehensive API.

Webhooks

Our BaaS philosophy centers on furnishing you with a complete suite of tools and APIs designed to fulfill your unique requirements solely through our services.

BaaS Engines

Count properties for given search filters

Count properties for search filters

Retrieve advanced statistics of historical immo's market

Properties General Analytics for search filters

Obtain city's live prices per area statistics.

Prices per area statistics

Tension city statistics

Non exhaustive list of real-estate ad platforms - New platform can be added on specific request


Get the list of real-estate platforms

Get your credit consumption for a given date range

Get your credit consumption

Estimate the price of a property based on market data

Lite Property Estimation

Get a sample of properties

Sample of an alert webhook body for Properties

Sample Properties webhook body

Get a property by it's flx_id (flx_id is the id of the property in the database)

Get a property by it's flx_id

Get a list of properties by their flx_id (flx_id is the id of the property in the database)

Retreive properties by their flx_ids

Retrieve a property by one of it's advert flxId

Retrieve a property by advert flxId

Retrieve a property by one of it's advert URL

Retrieve a property by url

Search properties with filters and fulltexts search terms

Search properties

Lite Search properties with filters and fulltexts search terms

Lite Search properties

RaisePropertyIssue - Raise an issue for a given property

Create a new alert on a Property search. The alert will be saved in the database and will be triggered when a new property is found.

Create a new alert for this Property search

Get the search criteria of a Property alert by its id (alertId)

Get the search criteria of a Propertyalert

Deactivate a Property search alert by its id (alertId)

Deactivate a Property search alert

Update the search criteria of a Property alert by its id (alertId) and return the new alertId

Update the search criteria of a Property alert

Activate a Property search alert by its id (alertId)

Activate a Property search alert

Get history of the properties matched to a saved search by its flxId. The history is composed of all the properties that have been match for this saved search.

Get history of match properties by its saved search flxId

Get a sample of ads

Sample of an alert webhook body for Adverts

Sample advert webhook body

RaiseADIssue - Raise an issue for a given ad

Get adverts by their flx_id (flx_id is the id of the adverts in the database)

Get adverts byt their flx_id

Retrieve advert by url

Create a new alert on a Advert search. The alert will be saved in the database and will be triggered when a new Advert is found.

Create a new Advert alert for this search

Get the search criteria of an Advert alert by its id (alertId)

Get the search criteria of an Advert alert

Deactivate a search Advert alert by its id (alertId)

Deactivate a search Advert alert

Update the search criteria of an Advert alert by its id (alertId) and return the new alertId

Update the search criteria of an Advert alert

Get the search criteria of all your Advert alerts

Get all your Advert alerts

Activate a search Advert alert by its id (alertId)

Activate a search Advert alert

Retrieve a realestate company from it's official identifier

System

Properties

Adverts

RealEstate Companies

Models

Get all your Property alerts

Authorizations

Response