Skip to main content
Lite Property Estimation
curl --request POST \
  --url https://api.fluximmo.io/v2/protected/estimate/property/lite \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "habitation": {
    "roomCount": 2,
    "bedroomCount": 1,
    "surface": {
      "total": 100
    },
    "propertyCondition": {
      "constructionYear": 123,
      "generalConditions": []
    },
    "characteristics": {
      "hasBalcony": true,
      "hasCellar": true,
      "hasGarage": true,
      "hasLift": true,
      "hasParking": true,
      "hasPool": true,
      "hasTerrace": true
    },
    "climate": {
      "epcClimate": "GREENHOUSE_CLASSIFICATION_C",
      "epcEnergy": "ENERGY_CLASSIFICATION_C"
    },
    "features": {
      "furniture": null,
      "propertyFloor": 1,
      "propertyTotalFloor": 1
    }
  },
  "location": {
    "locationCoordinate": {
      "location": [
        6.374338,
        43.474648
      ]
    }
  },
  "type": "CLASS_HOUSE",
  "offer": {
    "type": "OFFER_BUY"
  },
  "land": {
    "surface": 123
  }
}
'
{
  "error": {
    "message": "<string>",
    "code": 123
  }
}

Documentation Index

Fetch the complete documentation index at: https://doc.fluximmo.io/llms.txt

Use this file to discover all available pages before exploring further.

À quoi ça sert

POST /v2/protected/estimate/property/lite retourne une estimation du prix d’un bien immobilier en France (prix central + intervalle) à partir d’un payload minimal (localisation + habitation + type + offre). L’endpoint est synchrone et peut être appelé depuis votre app (UI, worker batch, scoring de portefeuille). Vous pouvez cacher côté client par hash des champs métier pour économiser du quota.

Payload

ChampTypeObligatoireSens
location.locationCoordinate.location[number, number]OuiCoordonnées WGS84 au format [lng, lat]. À obtenir via le géocodage.
habitation.surface.totalnumberOuiSurface habitable totale en m².
habitation.roomCountintegerOuiNombre de pièces (T1 = 1, T2 = 2, etc.).
habitation.bedroomCountintegerOuiNombre de chambres.
land.surfacenumberSi maisonSurface du terrain en m² (objet land racine, optionnel).
typeenumOuiCLASS_FLAT ou CLASS_HOUSE.
offer.typeenumOuiOFFER_BUY (l’endpoint lite ne supporte pas OFFER_RENT).

Réponse

L’API retourne un prix central, un intervalle (priceRange) et un objet metadata. Le contrat exact est documenté plus bas par le bloc OpenAPI (POST /v2/protected/estimate/property/lite). Pour un appel pratique de bout en bout (géocodage + estimation + cache), suivez le playbook Estimer un bien.

Exemple

curl -X POST https://api.fluximmo.io/v2/protected/estimate/property/lite \
  -H "x-api-key: $FLUXIMMO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "location": {
      "locationCoordinate": { "location": [2.3376, 48.8606] }
    },
    "habitation": {
      "roomCount": 3,
      "bedroomCount": 2,
      "surface": { "total": 60 }
    },
    "type": "CLASS_FLAT",
    "offer": { "type": "OFFER_BUY" }
  }'

Liens utiles

Clé test gratuite — 1 semaine

Créez un compte sur my.fluximmo.io pour récupérer une clé API test gratuite (1 semaine, accès limité). Aucun paiement requis.

Authorizations

x-api-key
string
header
required

Body

application/json
habitation
object
required

Habitation characteristics of the property

location
object
required

Location details of the property

type
enum<string>
required

Type of the property

Available options:
CLASS_HOUSE,
CLASS_FLAT
Example:

"CLASS_HOUSE"

offer
object
required

Offer information of the property

land
object

Land details of the property

Response

error
object
required

Error object