Obtenir une clé
Sommaire de la documentation

Démarrer

Présentation

L’API Regroupe Immo donne accès, par programme, aux annonces immobilières de toutes les plateformes réunies et dédoublonnées, à l’audit de prix de chaque bien, au marché de chaque commune et au flux des changements.

Ce que donne l’API

  • Les annonces, réunies et dédoublonnées. Portails, réseaux, agences, notaires, particuliers : un même bien diffusé sur plusieurs plateformes n’apparaît qu’une fois, avec la liste de ses plateformes. Voir Rechercher des annonces.
  • L’audit de prix. Pour chaque bien : un prix de marché estimé sur les ventes réelles (DVF), l’écart du prix demandé à ce prix, un libellé de TBA à TMA, la confiance de l’estimation et les ventes utilisées. Voir Lire l’audit de prix.
  • Le marché et les ventes DVF. Prix au m² des ventes d’une commune, indice de prix mensuel, annonces en vente, et les ventes une à une. Voir Marché et ventes DVF.
  • Le flux des changements. Nouveaux biens, changements de prix, modifications et retraits, dans l’ordre : de quoi tenir une copie à jour sans tout relire. Voir Synchroniser un secteur.

Un bien, une annonce

Chaque annonce de l’API est un bien. Son identifiant id est stable : il ne change pas quand le bien apparaît sur une nouvelle plateforme ou change de prix. Servez-vous-en comme clé dans votre base.

sources liste les plateformes où le bien est en ligne, chacune avec un identifiant normalisé (seloger, leboncoin…) et un nom lisible. Une plateforme que nous ne savons pas nommer porte l’identifiant autre. La fiche du bien détaille, plateforme par plateforme, le lien, le prix affiché et l’état de l’annonce (portals).

Quand deux fiches se révèlent être le même bien, elles sont fusionnées : l’une des deux disparaît, et le flux des changements l’annonce par un événement removed.

Délai de diffusion

Selon le plan de votre compte, un bien nouvellement repéré apparaît tout de suite ou après un délai. Ce délai s’applique partout : recherche, fiche, flux des changements et annonces comptées par le marché d’une commune. GET /v1/me donne votre plan (account.plan) et le délai en minutes (account.diffusion_delay_minutes, 0 : aucun délai).

Les règles des données

  • Le prix de marché ne vient jamais d’une IA. Il est calculé par notre moteur statistique à partir des ventes DVF comparables, les ventes réelles publiées par l’administration fiscale. Chaque estimation donne les ventes utilisées, leur poids et la version du moteur (engine_version).
  • Sans vente comparable, pas d’estimation. Le statut vaut alors INSUFFICIENT_DATA : ni prix de marché, ni écart, ni libellé. Les ventes hors marché (moins de 200 € ou plus de 50 000 € du m²) ne servent jamais de comparables.
  • Prix affichés ≠ prix actés. Les ventes DVF donnent des prix signés, les annonces des prix demandés, en général plus hauts. Le moteur passe des uns aux autres par une calibration propre à chaque commune et type de bien : estimated_price est en base prix affichés, directement comparable au prix demandé.
  • Une bonne affaire s’explique. Une bonne affaire apparente sans facteur de décote identifié (travaux, DPE, occupation…) porte decote_unexplained: true : c’est un point à vérifier, pas une opportunité confirmée.

Conventions

  • Adresse de base : https://api.regroupe-immo.fr/v1. Réponses en JSON (UTF-8).
  • Prix en euros, surfaces en m², horodatages en ISO 8601 (UTC), dates de vente au format AAAA-MM-JJ, coordonnées en WGS84.
  • Une donnée inconnue vaut null. Un champ n’est absent que dans les cas documentés : audit sans le droit valuations:read, total après la première page…
  • Le contrat complet se lit sans clé, au format OpenAPI 3.1 : https://api.regroupe-immo.fr/v1/openapi.json. Chaque point d’entrée est détaillé dans la Référence.

Bêta

L’API est en bêta, ouverte sur demande. Les contrats de la v1 peuvent encore évoluer ; tout changement incompatible sera annoncé dans les Nouveautés. L’ajout d’un champ n’est pas un changement incompatible : écrivez votre code pour qu’il ignore les champs qu’il ne connaît pas.