Référence

Référence de l’API

Adresse de base : https://api.regroupe-immo.fr/v1. Chaque requête porte la clé dans l’en-tête Authorization: Bearer ri_live_… (voir Authentification). Les réponses sont en JSON ; les erreurs ont toutes la même forme (voir Erreurs).

Compte

GET/v1/meClé utilisée, limites et consommation du jour

Annonces

GET/v1/listingsRechercher des annonces dans un secteur
GET/v1/listings/{id}Fiche complète d’une annonce
GET/v1/listings/{id}/historyChronologie des modifications d’une annonce

Audit de prix

GET/v1/listings/{id}/valuationAudit de prix complet d’une annonce

Changements

GET/v1/changesFlux des changements depuis un curseur

Marché & DVF

GET/v1/market/communes/{code}Marché immobilier d’une commune
GET/v1/market/salesVentes DVF d’une commune ou autour d’un point

Contrat OpenAPI

Le contrat complet est publié au format OpenAPI 3.1 : https://api.regroupe-immo.fr/v1/openapi.json. Il permet de générer un client dans votre langage (par exemple avec openapi-generator).