Documentation de l'API
153 opérations servies dans 17 domaines, en REST sous https://pillr.fr/api/v1 et en outils MCP, avec une clé et en crédits. Tout ici est tiré du même registre que le contrat OpenAPI 3.1.
/
Premier appel
Marché d'une commune : 1 crédit par appel réussi. Avec une clé de test pk_test_, la réponse vient du bac à sable, sans débit. Démarrer en cinq minutes
curl https://pillr.fr/api/v1/communes/76540 \
-H "Authorization: Bearer $PILLR_CLE"Guides
- Démarrer en cinq minutesCréer une clé de test, faire un premier appel et lire sa réponse.
- AuthentificationL'en-tête Authorization, les clés de production et de test, les portées, le plafond par clé.
- Crédits et facturationLe barème des crédits, ce qui est débité et ce qui ne l'est pas, les trois façons de payer.
- ErreursLe format problem+json, les erreurs à réessayer, et la liste complète des codes.
- Pagination et champsLes listes, les champs rendus, les valeurs absentes et la mise en cache côté client.
- LotsTraiter une liste d'entrées en respectant le débit par minute et les délais de réessai.
- Asynchrone et webhooksLes délais de calcul de chaque opération, les tâches asynchrones et les webhooks.
- Qualité des donnéesL'âge de chaque donnée, la mémoire des réponses, le contrôle de chaque réponse avant l'envoi.
- LimitesDébit par minute, plafonds, taille des corps, délais et créneau du soir.
Référence par domaine
Annonces
21 opérations- Annonce par lien ou identifiantGET
/api/v1/annonces/{id}3 crédits par appel réussi - Annonce par lien ou identifiant, en lotPOST
/api/v1/annonces/lot3 crédits par élément rendu - Recherche d'annonces analyséesGET
/api/v1/annonces1 crédit par élément rendu - Recherche d'annonces en langage naturelGET
/api/v1/annonces/recherche-naturelle15 crédits par appel réussi - Biens semblables à une annonceGET
/api/v1/annonces/{id}/similaires1 crédit par élément rendu - Vie d'une annonce : prix, diffusion, fatigue vendeurGET
/api/v1/annonces/{id}/vie2 crédits par appel réussi - Bien dédoublonné et toutes ses annoncesGET
/api/v1/biens/{bien_uid}3 crédits par appel réussi - Pige complète : annonces actives et retirées du lacGET
/api/v1/annonces/archives1 crédit par élément rendu - Annonces dans une emprise de carteGET
/api/v1/annonces/carte1 crédit par tranche de 10 lignes rendues - Écart au marché, anomalies et ventes du rayonGET
/api/v1/annonces/{id}/ecart-marche3 crédits par appel réussi - Recommandation de négociation et lettre d'offrePOST
/api/v1/annonces/{id}/negociation20 crédits par appel réussi - Potentiel de division d'un bienGET
/api/v1/annonces/{id}/division3 crédits par appel réussi - Adresse retrouvée d'une annonceGET
/api/v1/annonces/{id}/adresse5 crédits par appel réussi - Localisation pas à pas (étapes déterministes)GET
/api/v1/annonces/{id}/localisation5 crédits par appel réussi - Indices de localisation lus sur les photosGET
/api/v1/annonces/{id}/localisation/indices-photos20 crédits par appel réussi - Lieu réel d'un indice par Google MapsGET
/api/v1/annonces/{id}/localisation/lieux40 crédits par appel réussi - Comparaison de façade avec Street ViewPOST
/api/v1/annonces/{id}/localisation/street-view40 crédits par appel réussi - Dossier d'un immeuble de rapportGET
/api/v1/annonces/{id}/immeuble10 crédits par appel réussi - Dossier d'un immeuble pas encore analyséPOST
/api/v1/immeubles/analyses10 crédits par appel réussi - Audit d'une liste de biens face au marchéPOST
/api/v1/portefeuilles/audit1 crédit par élément rendu - Annonces recommandées pour le compteGET
/api/v1/compte/recommandations1 crédit par élément rendu
Analyse des photos
3 opérationsCompte et personnalisation
8 opérations- Enregistrer l'adresse validée d'une annoncePOST
/api/v1/annonces/{id}/adresse-validee0 crédit par appel réussi - Mémoire du compteGET
/api/v1/compte/memoire0 crédit par appel réussi - Ajouter des faits à la mémoirePOST
/api/v1/compte/memoire0 crédit par appel réussi - Profil investisseur du compteGET
/api/v1/compte/profil0 crédit par appel réussi - Modifier le profil investisseurPOST
/api/v1/compte/profil0 crédit par appel réussi - Favoris du compteGET
/api/v1/compte/favoris0 crédit par appel réussi - Ajouter un favoriPOST
/api/v1/compte/favoris0 crédit par appel réussi - Retirer un favoriPOST
/api/v1/compte/favoris/{id}/retrait0 crédit par appel réussi
Adresse et DPE
17 opérations- Résoudre une adresse ou un pointGET
/api/v1/adresses/recherche0 crédit par appel réussi - Faits complets d'une adresseGET
/api/v1/adresses/{cle_ban}/faits5 crédits par appel réussi - Histoire datée d'une adresseGET
/api/v1/adresses/{cle_ban}/histoire10 crédits par appel réussi - Annonces vues à une adresseGET
/api/v1/adresses/{cle_ban}/annonces3 crédits par appel réussi - Parcelle cadastrale et ce qui s'y rattacheGET
/api/v1/parcelles/{id_parcelle}3 crédits par appel réussi - Bâtiments autour d'un point ou sur une parcelleGET
/api/v1/batiments2 crédits par appel réussi - Copropriétés du Registre nationalGET
/api/v1/coproprietes1 crédit par élément rendu - DVF à l'adresse : toutes les mutationsGET
/api/v1/adresses/{cle_ban}/ventes5 crédits par appel réussi - Ventes DVF autour d'un point, dans une commune ou par mutationGET
/api/v1/ventes1 crédit par élément rendu - Ventes d'une rue ou d'une communeGET
/api/v1/ventes/rue5 crédits par appel réussi - Tous les DPE d'une adresse, logement par logementGET
/api/v1/adresses/{cle_ban}/dpe3 crédits par appel réussi - Un DPE par son numéro, ou les DPE d'un disque ou d'une communeGET
/api/v1/dpe1 crédit par élément rendu - Audits énergétiques et leurs scénariosGET
/api/v1/audits/{n_audit}3 crédits par élément rendu - Échéance de location et coût de sortie de passoirePOST
/api/v1/energie/sortie-passoire1 crédit par appel réussi - Autorisations d'urbanisme d'une adresse ou d'une parcelleGET
/api/v1/adresses/{cle_ban}/permis3 crédits par appel réussi - Sociétés civiles domiciliées à une adresseGET
/api/v1/adresses/{cle_ban}/societes-civiles3 crédits par appel réussi - Lots d'un immeuble établis par ses DPEGET
/api/v1/adresses/{cle_ban}/lots3 crédits par appel réussi
Marché des communes
35 opérations- Volumes et prix des ventes d'une communeGET
/api/v1/communes/{insee}/ventes2 crédits par appel réussi - Mon secteur en 30 secondesGET
/api/v1/codes-postaux/{cp}/secteur2 crédits par appel réussi - Marché d'une communeGET
/api/v1/communes/{insee}1 crédit par appel réussi - Synthèse complète d'une communeGET
/api/v1/communes/{insee}/synthese3 crédits par appel réussi - Score Pillr et scores d'une communeGET
/api/v1/communes/{insee}/scores2 crédits par appel réussi - Profil socio-démographique et politiqueGET
/api/v1/communes/{insee}/profil2 crédits par appel réussi - Parc de logements d'une communeGET
/api/v1/communes/{insee}/parc2 crédits par appel réussi - Prix au m² d'une commune : barème, série, évolutionsGET
/api/v1/communes/{insee}/prix2 crédits par appel réussi - Prix au m² par quartier IRISGET
/api/v1/iris/{code_iris}1 crédit par élément rendu - Prix d'un département ou d'une régionGET
/api/v1/departements/{departement}/prix1 crédit par appel réussi - Vie des annonces d'une zoneGET
/api/v1/communes/{insee}/vie-annonces5 crédits par appel réussi - Tableau mensuel des signaux d'une communeGET
/api/v1/communes/{insee}/signaux3 crédits par appel réussi - Classement de communes (screener)GET
/api/v1/communes/classement1 crédit par élément rendu - Analyse rédigée d'une communeGET
/api/v1/communes/{insee}/analyse-ia2 crédits par appel réussi - Signaux de valorisation d'une communeGET
/api/v1/communes/{insee}/gentrification3 crédits par appel réussi - Contours, centre et voisins d'un territoireGET
/api/v1/communes/{insee}/geographie1 crédit par appel réussi - Tuiles vectorielles de la carte des prixGET
/api/v1/tuiles/prix/{z}/{x}/{y}1 crédit par appel réussi - Référentiels de communes et de codes postauxGET
/api/v1/referentiels/communes0 crédit par appel réussi - Verdict d'investissement d'une communeGET
/api/v1/communes/{insee}/verdict1 crédit par appel réussi - Comparaison de communesGET
/api/v1/communes/comparaison1 crédit par élément rendu - Palmarès de communes par indicateurGET
/api/v1/communes/palmares1 crédit par élément rendu - Avis des investisseurs sur une communeGET
/api/v1/communes/{insee}/avis1 crédit par appel réussi - Publier un avis sur une communePOST
/api/v1/communes/{insee}/avis0 crédit par appel réussi - Voter pour l'utilité d'un avisPOST
/api/v1/avis/{id}/vote0 crédit par appel réussi - Loyer de marché d'un logementGET
/api/v1/communes/{insee}/loyers1 crédit par appel réussi - Encadrement des loyersGET
/api/v1/encadrement-loyers1 crédit par appel réussi - Zonage ABC, plafonds et contraintes localesGET
/api/v1/communes/{insee}/zonage1 crédit par appel réussi - Marché de la courte durée d'une communeGET
/api/v1/communes/{insee}/courte-duree2 crédits par appel réussi - Risques naturels et technologiquesGET
/api/v1/communes/{insee}/risques2 crédits par appel réussi - Équipements, accès, délinquance et cadre de vieGET
/api/v1/communes/{insee}/mesures2 crédits par appel réussi - Prime de division d'une communeGET
/api/v1/communes/{insee}/prime-division2 crédits par appel réussi - BaromètreGET
/api/v1/barometre/{edition}1 crédit par appel réussi - Baromètre, en lotPOST
/api/v1/barometre/lot1 crédit par élément rendu - Dossier du baromètre sur demandePOST
/api/v1/barometre/dossiers20 crédits par appel réussi - Constantes réglementaires et fiscales de référenceGET
/api/v1/referentiels/constantes0 crédit par appel réussi
Pré-marché
8 opérations- Pré-marché d'une adresseGET
/api/v1/adresses/{cle_ban}/pre-marche10 crédits par appel réussi - Adresses à prospecter d'un secteurGET
/api/v1/pre-marche10 crédits par élément rendu - Radar de prospection d'une commune ou d'un départementGET
/api/v1/communes/{insee}/radar3 crédits par élément rendu - Plan de prospection rédigéPOST
/api/v1/communes/{insee}/radar/plan20 crédits par appel réussi - Créer un suivi de zonePOST
/api/v1/alertes/zones0 crédit par appel réussi - Créer une veille pré-marchéPOST
/api/v1/alertes/pre-marche0 crédit par appel réussi - Alertes du compteGET
/api/v1/alertes0 crédit par appel réussi - Supprimer une alerteDELETE
/api/v1/alertes/{id}0 crédit par appel réussi
Estimation
7 opérations- Estimation affinée par IAPOST
/api/v1/estimations/affinees30 crédits par appel réussi - Terrain de référence d'une maisonGET
/api/v1/communes/{insee}/terrain-reference1 crédit par appel réussi - Rendement, cash-flow et créditPOST
/api/v1/simulations/rendement2 crédits par appel réussi - Taux de crédit du momentGET
/api/v1/taux-credit1 crédit par appel réussi - Simulation fiscale sur l'horizon de détentionPOST
/api/v1/fiscal/simulations2 crédits par appel réussi - Plus-value immobilière à la reventePOST
/api/v1/fiscal/plus-value1 crédit par appel réussi - Revenu de courte durée d'un logementPOST
/api/v1/courte-duree/estimations2 crédits par appel réussi
Urbanisme
13 opérations- Taxe d'aménagement d'un projetPOST
/api/v1/fiscal/taxe-amenagement1 crédit par appel réussi - Urbanisme à l'adresseGET
/api/v1/adresses/{cle_ban}/urbanisme2 crédits par appel réussi - Documents d'urbanisme d'une communeGET
/api/v1/communes/{insee}/urbanisme2 crédits par appel réussi - Objets d'urbanisme dans une empriseGET
/api/v1/urbanisme/objets1 crédit par élément rendu - Recherche d'autorisations d'urbanismeGET
/api/v1/permis1 crédit par élément rendu - Démarche d'urbanisme d'un projetPOST
/api/v1/urbanisme/demarche1 crédit par appel réussi - Plan de situation, plan de masse et implantationPOST
/api/v1/urbanisme/croquis20 crédits par appel réussi - Coupes, façades et toituresPOST
/api/v1/urbanisme/coupes20 crédits par appel réussi - Dossier de dépôtPOST
/api/v1/urbanisme/dossiers200 crédits par appel réussi - Résultat : dossier de dépôtGET
/api/v1/urbanisme/dossiers/{tache}0 crédit par appel réussi - Cerfa d'urbanisme pré-rempliPOST
/api/v1/urbanisme/cerfa/{numero}5 crédits par appel réussi - Échéances d'un dossier après dépôtPOST
/api/v1/urbanisme/echeances1 crédit par appel réussi - Rendu réaliste d'un projet sur la vue aériennePOST
/api/v1/urbanisme/rendus100 crédits par appel réussi
Règlement du PLU
2 opérationsEntreprises, agences et sociétés civiles
4 opérations- Agences actives et parts de marché d'une communeGET
/api/v1/communes/{insee}/agences3 crédits par appel réussi - Agences et réseaux immobiliersGET
/api/v1/agences2 crédits par élément rendu - Agents et mandatairesGET
/api/v1/agents1 crédit par élément rendu - Entreprise : avis BODACC et autorisationsGET
/api/v1/entreprises/{siren}3 crédits par appel réussi
Référentiels
3 opérationsFlux d'évènements
8 opérations- Flux d'évènements des annoncesGET
/api/v1/flux/annonces1 crédit par évènement livré - Flux de nouveautés à l'adresseGET
/api/v1/flux/adresses1 crédit par évènement livré - Créer un agent de veillePOST
/api/v1/veilles20 crédits par appel réussi ; 0 crédit par appel réussi avec des critères exacts (recherche) - Agents de veille du compteGET
/api/v1/veilles0 crédit par appel réussi - Modifier un agent de veillePATCH
/api/v1/veilles/{id}0 crédit par appel réussi - Résultats des veilles et des alertesGET
/api/v1/resultats1 crédit par évènement livré - Notifications du compteGET
/api/v1/compte/notifications1 crédit par évènement livré - Marquer une notificationPOST
/api/v1/compte/notifications/{id}0 crédit par appel réussi
Webhooks
4 opérations- Créer un abonnement webhookPOST
/api/v1/webhooks0 crédit par appel réussi - Abonnements webhook de l'organisationGET
/api/v1/webhooks0 crédit par appel réussi - Supprimer un abonnement webhookDELETE
/api/v1/webhooks/{id}0 crédit par appel réussi - Tester un abonnement webhookPOST
/api/v1/webhooks/{id}/test0 crédit par appel réussi
Hub et documents
14 opérations- Question à l'agent du HubPOST
/api/v1/hub/questions120 crédits par appel réussi - Conversations du HubGET
/api/v1/hub/conversations0 crédit par appel réussi - Une conversation du HubGET
/api/v1/hub/conversations/{id}0 crédit par appel réussi - Poursuivre une conversation du HubPOST
/api/v1/hub/conversations/{id}/questions120 crédits par appel réussi - Renommer, épingler ou rattacher une conversationPOST
/api/v1/hub/conversations/{id}0 crédit par appel réussi - Projets du compteGET
/api/v1/projets0 crédit par appel réussi - Créer un projetPOST
/api/v1/projets0 crédit par appel réussi - Un projet et son contexteGET
/api/v1/projets/{id}0 crédit par appel réussi - Modifier ou clore un projetPOST
/api/v1/projets/{id}0 crédit par appel réussi - Ranger un texte dans un projetPOST
/api/v1/projets/{id}/textes0 crédit par appel réussi - Retirer un texte d'un projetPOST
/api/v1/projets/{id}/textes/retrait0 crédit par appel réussi - Requêtes programmées du compteGET
/api/v1/briefs/programmes0 crédit par appel réussi - Briefs rédigésGET
/api/v1/briefs0 crédit par appel réussi - Un brief et ses résultats d'outilsGET
/api/v1/briefs/{id}0 crédit par appel réussi