> ## 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.

# Estimation lite (V2)

> Estimation rapide du prix d'un bien (modèle V2 production).

## À quoi ça sert

`POST /v2/protected/estimate/property/lite` retourne une estimation AVM (*Automated Valuation Model*) du prix d'un bien immobilier en France, en quelques centaines de millisecondes. C'est le modèle V2 de production de Fluximmo, entraîné sur l'historique d'annonces et de transactions agrégé par la plateforme.

L'endpoint accepte un payload synthétique : **localisation** (`location.locationCoordinate.location` au format `[lng, lat]`), **caractéristiques du bien** (`habitation.surface.total`, `habitation.roomCount`, `habitation.bedroomCount`), **type de bien** (`CLASS_FLAT` ou `CLASS_HOUSE`) et **type d'offre** (`OFFER_BUY`). Il retourne un prix central (`data.price`), un intervalle (`data.priceRange.lower` / `upper`) et des métadonnées optionnelles indiquant la qualité de l'estimation pour la zone considérée.

**Cas d'usage typiques** : pricing automatique côté agent, peer comparison (comparer un bien à son marché local), pré-qualification d'opportunité, alimentation d'une UI d'estimation grand public, scoring de portefeuille.

## Exemples

### E1 — Appartement Paris (75001)

<CodeGroup>
  ```bash curl theme={null}
  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": { "surface": { "total": 60 }, "roomCount": 3, "bedroomCount": 2 },
      "type": "CLASS_FLAT",
      "offer": { "type": "OFFER_BUY" }
    }'
  ```

  ```python Python theme={null}
  import os, requests

  resp = requests.post(
      "https://api.fluximmo.io/v2/protected/estimate/property/lite",
      headers={"x-api-key": os.environ["FLUXIMMO_API_KEY"]},
      json={
          "location": {"locationCoordinate": {"location": [2.3376, 48.8606]}},
          "habitation": {"surface": {"total": 60}, "roomCount": 3, "bedroomCount": 2},
          "type": "CLASS_FLAT",
          "offer": {"type": "OFFER_BUY"},
      },
      timeout=30,
  )
  print(resp.json())
  ```

  ```javascript Node theme={null}
  const resp = await fetch("https://api.fluximmo.io/v2/protected/estimate/property/lite", {
    method: "POST",
    headers: {
      "x-api-key": process.env.FLUXIMMO_API_KEY,
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      location: { locationCoordinate: { location: [2.3376, 48.8606] } },
      habitation: { surface: { total: 60 }, roomCount: 3, bedroomCount: 2 },
      type: "CLASS_FLAT",
      offer: { type: "OFFER_BUY" },
    }),
  });
  console.log(await resp.json());
  ```
</CodeGroup>

### E2 — Maison Bretagne (110m², 4 pièces)

<CodeGroup>
  ```bash curl theme={null}
  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": [-4.4861, 48.3904] } },
      "habitation": { "surface": { "total": 110 }, "roomCount": 4, "bedroomCount": 3 },
      "land": { "surface": 350 },
      "type": "CLASS_HOUSE",
      "offer": { "type": "OFFER_BUY" }
    }'
  ```

  ```python Python theme={null}
  import os, requests

  resp = requests.post(
      "https://api.fluximmo.io/v2/protected/estimate/property/lite",
      headers={"x-api-key": os.environ["FLUXIMMO_API_KEY"]},
      json={
          "location": {"locationCoordinate": {"location": [-4.4861, 48.3904]}},
          "habitation": {"surface": {"total": 110}, "roomCount": 4, "bedroomCount": 3},
          "land": {"surface": 350},
          "type": "CLASS_HOUSE",
          "offer": {"type": "OFFER_BUY"},
      },
      timeout=30,
  )
  print(resp.json())
  ```

  ```javascript Node theme={null}
  const resp = await fetch("https://api.fluximmo.io/v2/protected/estimate/property/lite", {
    method: "POST",
    headers: {
      "x-api-key": process.env.FLUXIMMO_API_KEY,
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      location: { locationCoordinate: { location: [-4.4861, 48.3904] } },
      habitation: { surface: { total: 110 }, roomCount: 4, bedroomCount: 3 },
      land: { surface: 350 },
      type: "CLASS_HOUSE",
      offer: { type: "OFFER_BUY" },
    }),
  });
  console.log(await resp.json());
  ```
</CodeGroup>

## Liens utiles

* [Concept · Property vs Advert](/concepts/property-vs-advert)
* [Géocoder une adresse avant estimation](/api-geocoding-reference/search/recherche-par-géocodage-direct)
* [Playbook · Estimer un bien](/playbooks/estimer-un-bien)

<Card title="Clé test gratuite — 1 semaine" icon="key" href="https://my.fluximmo.io">
  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.
</Card>


## OpenAPI

````yaml post /v2/protected/estimate/property/lite
openapi: 3.0.0
info:
  title: Real-estate data API - Fluximmo V2
  description: >+
    ## Fluximmo

    ##### Real-time real estate data: Power workflows, business applications and
    decision-making.


    Real estate expert since 2017, Fluximmo aggregates, exploits, enriches &
    analyzes the 


    real-estate market in real time to offer data flows, APIs and innovative
    services to real estate professionals.


    ## Authentification

    You'll need to be authenticated with an active subscription to access our
    REST endpoints.


    To get an API-KEY please contact us at contact@fluximmo.com or book a call
    with our team: https://calendly.com/fluximmo/meet-fluximmo

    ##### How to use your API KEY

    Simply add to your HTTP request your API KEY in the headers:
    `{'x_api_key':'randomApiKey'}`


    ## Properties and Adverts

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

    #### Properties (BAAS)

    A property is a real-estate habitation/land/commercial/building to which is
    attached adverts.


    We gather all the adverts offering (selling or renting) this real-estate
    asset and consolidate all the information into one Property.


    A Property is by definition `de-duplicated` and can gather 1 to x adverts:
    these adverts are either duplicates from different portals or with mandates
    from different agencies or republication of the same advertising with a
    price update or not.


    The concept of property is in constant mutation until the real-estate asset
    is sold: We'll keep merging new adverts within the Property concept and
    update the price if needed.


    By it's nature in constant mutation, we do not offer the possibility to
    receive these Properties on webhooks. You'll need to use our APIs as a
    Backend As A Service (BaaS).


    #### Adverts (BAAS and WEBHOOK)

    Adverts are advertising of a real-estate property. Adverts can come from
    many sources: Agencies websites, Aggregation real-estate portals,
    Social-Networks, NewsPaper etc...


    After gathering all these adverts our proprietary AI algorithms will
    de-duplicate these adverts and associate them to a Property


    An advert have a unique URL. Meaning that the same advertising re-published
    twice (with our without any change, on the same website or not, by the same
    agency or not) is considered as 2 ads.


    You can choose either to retrieve all the Adverts or only the non duplicated
    ones. Adverts can be retrieved either by API (Search or Alerts) or Webhook

    ## Webhooks

    We offer the possibility to receive our real-estate Adverts data in
    real-time using webhooks. As soon as we gather the data, you'll receive it
    few moments later.


    Using ALERTS, you can receive new adverts matching your criteria on a
    webhook.


    ##### Webhook differences between Adverts and Properties

    As Properties are by nature in perpetual evolutions (new duplicated ads will
    be merged, new data to be consolidated etc..), we do not offer the
    possibility to receive through Webhooks the full body of the properties.
    Properties webhook will only send you the list of the properties FlxIds
    matching your search.


    You'll find below the schema of the data you would receive on your webhook
    (`/v2/sample/webhook/properties`, `/v2/sample/webhook/adverts`)

    ##### What is a webhook

    A webhook can be thought of as a type of API that is driven by events rather
    than requests


    .Instead of one application making a request to another to receive a
    response, a webhook is a service that allows one program to send data to
    another as soon as a particular event takes place.


    Webhooks are sometimes referred to as “reverse APIs,” because communication
    is initiated by the application sending the data rather than the one
    receiving it.


    With web services becoming increasingly interconnected, webhooks are seeing
    more action as a lightweight solution for enabling real-time notifications
    and data updates without the need to develop a full-scale API.

    ##### When to use a webhook instead of the REST API

    You're supposed to receive a high volume of data (frequently or not), you're
    looking for real-time data, you just have to relax and wait (no cron, no
    call on our API etc..)

    ##### Webhook implementation examples

    A webhook is simply a POST endpoint we can request

    * Python:
    https://gist.github.com/aloysius-tim/293772256526efa20d5c625c6ace036a

    * Node:
    https://gist.github.com/aloysius-tim/ea1d9feb2c527b5b09ffc356b662d14b

  version: 2.0.0
  contact: {}
  x-logo:
    url: https://www.fluximmo.com/assets/images/logo_text.png
    backgroundColor: '#F31051'
    altText: Fluximmo logo
servers:
  - url: https://api.fluximmo.io
security: []
tags:
  - name: PropertyModel
    description: <SchemaDefinition schemaRef="#/components/schemas/PropertyDto" />
  - name: AdvertModel
    description: <SchemaDefinition schemaRef="#/components/schemas/AdvertDto" />
paths:
  /v2/protected/estimate/property/lite:
    post:
      tags:
        - Estimations
      summary: Lite Property Estimation
      description: Estimate the price of a property based on market data
      operationId: EstimationLiteController_estimate
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PropertyEstimateLiteDto'
      responses:
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExceptionDto'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExceptionDto'
        default:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EstimationResponseDto'
      security:
        - x_api_key: []
components:
  schemas:
    PropertyEstimateLiteDto:
      type: object
      properties:
        habitation:
          description: Habitation characteristics of the property
          allOf:
            - $ref: '#/components/schemas/TypeHabitationEstimationLiteDto'
        land:
          description: Land details of the property
          allOf:
            - $ref: '#/components/schemas/TypeLandEstimationLiteDto'
        location:
          description: Location details of the property
          allOf:
            - $ref: '#/components/schemas/LocationEstimationLiteDto'
        type:
          $ref: '#/components/schemas/EnumPropertyClassHabitationDto'
          example: CLASS_HOUSE
          description: Type of the property
        offer:
          description: Offer information of the property
          allOf:
            - $ref: '#/components/schemas/OfferEstimationLiteDto'
      required:
        - habitation
        - location
        - type
        - offer
    ExceptionDto:
      type: object
      properties:
        error:
          description: Error object
          allOf:
            - $ref: '#/components/schemas/ErrorDto'
      required:
        - error
    EstimationResponseDto:
      properties:
        data:
          type: object
          properties:
            price:
              type: number
            priceRange:
              $ref: '#/components/schemas/EstimationPriceRange'
            metadata:
              type: object
              description: Optional metadata
          required:
            - price
            - priceRange
      required:
        - data
      type: object
    TypeHabitationEstimationLiteDto:
      type: object
      properties:
        propertyCondition:
          $ref: '#/components/schemas/PropertyConditionEstimationLiteDto'
        roomCount:
          type: number
          example: 2
        bedroomCount:
          type: number
          example: 1
        surface:
          $ref: '#/components/schemas/SurfaceEstimationLiteDto'
        characteristics:
          $ref: '#/components/schemas/CharacteristicsEstimationLiteDto'
        climate:
          description: The energetic classes of the property (DPE/GES)
          allOf:
            - $ref: '#/components/schemas/ClimateEstimationLiteDto'
        features:
          $ref: '#/components/schemas/FeaturesEstimationLiteDto'
      required:
        - roomCount
        - bedroomCount
        - surface
    TypeLandEstimationLiteDto:
      type: object
      properties:
        surface:
          type: number
    LocationEstimationLiteDto:
      type: object
      properties:
        locationCoordinate:
          description: >-
            Coordinates of the property - could not be accurate or precise
            enough
          allOf:
            - $ref: '#/components/schemas/CompleteLatLngEstimationLiteDto'
      required:
        - locationCoordinate
    EnumPropertyClassHabitationDto:
      type: string
      enum:
        - CLASS_HOUSE
        - CLASS_FLAT
    OfferEstimationLiteDto:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/EnumPropertyOfferTypeLiteDto'
          example: OFFER_BUY
      required:
        - type
    ErrorDto:
      type: object
      properties:
        message:
          type: string
          description: Error message
        code:
          type: number
          description: Error code
      required:
        - message
        - code
    EstimationPriceRange:
      type: object
      properties:
        lower:
          type: number
        upper:
          type: number
    PropertyConditionEstimationLiteDto:
      type: object
      properties:
        constructionYear:
          type: number
        generalConditions:
          type: array
          example: []
          items:
            $ref: '#/components/schemas/EnumPropertyGeneralConditionDto'
    SurfaceEstimationLiteDto:
      type: object
      properties:
        total:
          type: number
          description: The total habitable surface of the property in m²
          example: 100
      required:
        - total
    CharacteristicsEstimationLiteDto:
      type: object
      properties:
        hasBalcony:
          type: boolean
        hasCellar:
          type: boolean
        hasGarage:
          type: boolean
        hasLift:
          type: boolean
        hasParking:
          type: boolean
        hasPool:
          type: boolean
        hasTerrace:
          type: boolean
    ClimateEstimationLiteDto:
      type: object
      properties:
        epcClimate:
          $ref: '#/components/schemas/EnumGreenhouseClassificationDto'
          example: GREENHOUSE_CLASSIFICATION_C
          description: >-
            The classification value of the greenhouse gas emission
            classification - GES
        epcEnergy:
          $ref: '#/components/schemas/EnumEnergyClassificationDto'
          example: ENERGY_CLASSIFICATION_C
          description: The classification value of the energy classification - DPE
    FeaturesEstimationLiteDto:
      type: object
      properties:
        furniture:
          $ref: '#/components/schemas/EnumFurnitureDto'
          example: null
        propertyFloor:
          type: number
          example: 1
        propertyTotalFloor:
          type: number
          example: 1
    CompleteLatLngEstimationLiteDto:
      type: object
      properties:
        location:
          example:
            - 6.374338
            - 43.474648
          description: >-
            Longitude and latitude as an array of number, first longitude then
            latitude [lng, lat]
          type: array
          items:
            type: array
      required:
        - location
    EnumPropertyOfferTypeLiteDto:
      type: string
      enum:
        - OFFER_BUY
    EnumPropertyGeneralConditionDto:
      type: string
      enum:
        - GENERAL_CONDITION_UNKNOWN
        - GENERAL_CONDITION_TO_BE_RENOVATED
        - GENERAL_CONDITION_BRAND_NEW
        - GENERAL_CONDITION_RENOVATED
        - GENERAL_CONDITION_TO_BE_REFRESHED
        - GENERAL_CONDITION_GOOD
        - GENERAL_CONDITION_EXCELLENT
        - GENERAL_CONDITION_DECREPIT
        - GENERAL_CONDITION_TO_BE_BUILT
    EnumGreenhouseClassificationDto:
      type: string
      enum:
        - GREENHOUSE_CLASSIFICATION_UNKNOWN
        - GREENHOUSE_CLASSIFICATION_G
        - GREENHOUSE_CLASSIFICATION_F
        - GREENHOUSE_CLASSIFICATION_E
        - GREENHOUSE_CLASSIFICATION_D
        - GREENHOUSE_CLASSIFICATION_C
        - GREENHOUSE_CLASSIFICATION_B
        - GREENHOUSE_CLASSIFICATION_A
        - GREENHOUSE_CLASSIFICATION_NC
    EnumEnergyClassificationDto:
      type: string
      enum:
        - ENERGY_CLASSIFICATION_UNKNOWN
        - ENERGY_CLASSIFICATION_G
        - ENERGY_CLASSIFICATION_F
        - ENERGY_CLASSIFICATION_E
        - ENERGY_CLASSIFICATION_D
        - ENERGY_CLASSIFICATION_C
        - ENERGY_CLASSIFICATION_B
        - ENERGY_CLASSIFICATION_A
        - ENERGY_CLASSIFICATION_NC
    EnumFurnitureDto:
      type: string
      enum:
        - UNKNOWN_FURNITURE
        - UNFURNISHED
        - PARTIALLY_FURNISHED
        - FULLY_FURNISHED
  securitySchemes:
    x_api_key:
      type: apiKey
      in: header
      name: x-api-key

````