Documentation

Book a call

Contact us

Real-estate data API - Fluximmo V2 (2.1.0)

Search and alerts

Analytics

My Account

Get your credit consumption for a given date range

Get your credit consumption

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

Combined - Obtains statistics by combining two fields with each others.

Count - Count the number of properties matching the given query.

GeneralAnalytics - Retrieve advanced statistics of historical immo's market.

TimeSeriesAnalytics - Retrieve statistical analysis on a time-series base of historical immo's market.

TrendAnalysis - Retrieve trends of historical immo's market.

GetLivePricesStatistics - Obtain city's live prices statistics.

GetSoldPricesStatistics - Obtain city's sold prices statistics.

GetMarketPrice - Obtain city's market prices.

GetMarketLiveStatistics - Obtain city's tension and listing statistics.

GetSummary - Obtain a summary of city statistics.

GetLivingArea - Obtain city-related living-area (or the so-called attractivity's area).

GetEmployementStatistics - Obtain city-related employment statistics.

GetPopulationInfo - Obtain city's population main information.

GetHealthStatistics - Obtain city-related health statistics.

GetSecurityStatistics - Obtain city's security statistics.

GetHousingInfo - Obtain city's housing main informations.

CombinedDvfAnalytics - Retrieve combined statistics.

GeneralDvfAnalytics - Retrieve advanced statistics of transactions.

getVersion

healthz

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


Get the list of real-estate platforms

Estimate the price of a property based on market data

Estimate the price of a property

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

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

Create Many alerts on a Property searchs. These alerts will be saved in the database and will be triggered when a new property is found.

Create Many new alert for 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

Get the search criteria of all your Property alerts

Get all your Property alerts

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

GetDvfTransactionsById - Retrieve DVF transaction based on the ID.

SearchDvfTransactions - Provide search capabilities for past real-estate transactions which have been officially registered on DVF.

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

Count adverts for given filters and fulltexts search terms

Count adverts for search

Search adverts with filters and fulltexts search terms

Search adverts

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

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

System

Properties

DVF

Adverts

Models

Get your credit consumption

Authorizations

Query Parameters

Response