Aller au contenu principal
Accueil/Centre d'aide/API et embed/API publique RentaImmo (preview)
API et embed · 5 min

API publique RentaImmo (preview)

Une API REST pour analyser des biens depuis vos propres outils. Authentification, endpoints principaux et limites.

Une API REST en preview

L'API publique RentaImmo est en preview pour les utilisateurs du plan Expert. Elle permet de lancer des analyses, récupérer les résultats et gérer les biens suivis depuis vos propres scripts, applications ou intégrations CRM.

L'URL de base est https://renta-immo.fr/api/v1/. Toutes les requêtes utilisent HTTPS, le format JSON et les conventions REST classiques.

Obtenir une clé API

  1. Connectez-vous à RentaImmo (plan Expert requis).
  2. Paramètres > API > Clés API.
  3. Cliquez sur Générer une clé.
  4. Donnez-lui un nom descriptif (ex. Mon CRM, Script import).
  5. Choisissez les permissions : lecture seule, lecture/écriture, ou complet (avec gestion webhooks).
  6. La clé s'affiche une seule fois (préfixe rnt_ puis chaîne aléatoire). Copiez-la et stockez-la dans un gestionnaire de secrets.

Si vous perdez la clé, vous devez en générer une nouvelle (la précédente reste utilisable jusqu'à révocation explicite, mais elle n'est plus consultable côté UI). Les clés sont hashées côté serveur (SHA-256) ; nous ne pouvons pas vous la rappeler.

L'authentification

Toutes les requêtes incluent un header :

Authorization: Bearer rnt_votre_cle_api

Si la clé est invalide, l'API renvoie 401. Si la clé n'a pas la permission requise, 403.

Les endpoints principaux

Lister les analyses

GET /api/v1/simulations

Retourne vos analyses paginées (50 par page). Filtres possibles : ?city=Lyon&minYield=5&page=2.

Récupérer une analyse

GET /api/v1/simulations/{id}

Retourne le détail complet d'une analyse : inputs, résultats, régimes fiscaux, simulation crédit.

Créer une analyse par URL

POST /api/v1/simulations
Content-Type: application/json

{ "url": "https://www.leboncoin.fr/ad/ventes_immobilieres/2843910283" }

Retourne 202 Accepted avec un id et un statut queued. L'analyse s'exécute en arrière-plan (5 à 15 secondes) ; interrogez ensuite GET /simulations/{id} ou souscrivez à un webhook simulation.completed.

Créer une analyse manuelle

POST /api/v1/simulations
Content-Type: application/json

{
  "manual": true,
  "price": 200000,
  "surface": 50,
  "city": "Lyon",
  "rooms": 3,
  "rentEstimate": 800,
  "loanRate": 3.5,
  "loanDuration": 25
}

Le moteur calcule immédiatement (réponse synchrone, environ 1 seconde).

Supprimer une analyse

DELETE /api/v1/simulations/{id}

Le rate limiting

Le quota est de 60 requêtes par minute par clé. Les en-têtes de réponse incluent :

  • X-RateLimit-Limit: 60
  • X-RateLimit-Remaining: 47
  • X-RateLimit-Reset: 1730728800 (timestamp Unix de la prochaine fenêtre).

En cas de dépassement, l'API renvoie 429 Too Many Requests avec un header Retry-After: 12 (secondes à attendre).

Les webhooks

Pour éviter le polling, configurez un webhook dans Paramètres > API > Webhooks. Événements disponibles :

  • simulation.completed : analyse terminée.
  • simulation.updated : analyse modifiée.
  • tracked.price_change : changement de prix détecté.
  • tracked.price_drop : baisse de prix sous le seuil d'alerte.
  • tracked.removed : annonce retirée du site source.

Chaque webhook est un POST JSON signé HMAC-SHA256 avec un header X-RentaImmo-Signature. Vérifiez la signature côté serveur pour authentifier le payload.

Documentation et SDK

La documentation complète est sur /docs/api (OpenAPI 3.1, exemples curl, Postman collection téléchargeable). Pas de SDK officiel à ce jour, mais l'API est suffisamment standard pour fonctionner avec n'importe quel client HTTP (axios, fetch, requests, http.client, etc.).

Le statut preview

L'API est en preview : nous nous réservons le droit d'évoluer la structure des réponses sur les endpoints non encore stabilisés. Tout changement breaking est annoncé 30 jours à l'avance par email aux utilisateurs Expert. Une versioning v2 viendra quand l'API sortira de preview ; vous resterez en v1 sans rupture pendant la transition.

Pour rester informé, abonnez-vous au flux de changelog API : https://renta-immo.fr/docs/api/changelog.

Articles connexes