Référence de l'API Locameublé

L'API de Locameublé lit et écrit dans votre foyer : biens, locataires, baux, loyers, emprunts, banque, écritures, résultat et clôture de l'exercice. Chaque commande de l'application y a son adresse, et les mêmes commandes servent au serveur MCP et à la ligne de commande.

L'adresse de base est https://app.locameuble.fr/api/v1. Une lecture se fait en GET, une écriture en POST, et chaque réponse est du JSON.

Démarrage

Il vous faut un compte Locameublé et une clé d'API. Comptez cinq minutes pour le premier appel.

1. Créez une clé

Dans l'application, ouvrez Connecteurs et créez une clé. Elle commence par lm_ et ne s'affiche qu'une fois : gardez-la dans un gestionnaire de mots de passe. Une clé agit avec le rôle de la personne qui l'a créée.

2. Faites un premier appel

Envoyez la clé dans l'en-tête Authorization :

curl https://app.locameuble.fr/api/v1/lister_biens \
  -H "Authorization: Bearer lm_…"

3. Écrivez une seule fois

Chaque écriture demande un en-tête Idempotency-Key, une valeur de 1 à 255 caractères que vous choisissez. Si le réseau coupe, renvoyez la requête avec la même clé : le serveur rend la même réponse sans écrire deux fois.

curl -X POST https://app.locameuble.fr/api/v1/marquer_loyer_recu \
  -H "Authorization: Bearer lm_…" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"loyerId": "…", "date": "2026-11-05"}'

Montants

Tous les montants sont en centimes d'euro, en nombres entiers : 82000 vaut 820,00 €.

Erreurs

Une erreur garde toujours la même forme. Lisez code, qui ne change pas : le message est fait pour être lu par une personne.

{
  "error": {
    "code": "idempotency_key_required",
    "message": "Une écriture demande un en-tête Idempotency-Key de 1 à 255 caractères.",
    "docs": "https://app.locameuble.fr/api/v1/contract#idempotency_key_required"
  }
}

La liste des codes et de leur statut HTTP est dans le contrat.

Claude et ChatGPT

Locameublé est un serveur MCP distant : https://app.locameuble.fr/mcp. Ajoutez-le comme connecteur personnalisé dans Claude ou dans ChatGPT, puis connectez-vous à votre compte Locameublé quand la fenêtre s'ouvre. La connexion passe par OAuth : vous n'avez aucune clé à copier, et vous la retirez quand vous voulez depuis l'application.

Chaque commande de l'API devient un outil. Pour une écriture qui engage votre foyer, comme l'envoi d'une quittance, l'invitation d'un membre, la demande de clôture ou la clôture elle-même, l'outil demande à l'assistant d'obtenir votre accord avant chaque appel.

Claude Code

Une ligne dans le terminal :

claude mcp add --transport http locameuble https://app.locameuble.fr/mcp

Lancez ensuite /mcp dans Claude Code pour vous connecter.

CLI

La commande locameuble tourne avec Node 22 ou plus récent, sans installation :

npx -y locameuble login
npx -y locameuble doctor
npx -y locameuble biens

login demande votre clé lm_… et la garde sur votre ordinateur. doctor vérifie le serveur, la version du contrat et la clé. Chaque commande de l'API est un verbe : npx -y locameuble --help les liste.

MCP local

Pour un client MCP qui lance ses serveurs lui-même, comme Claude Desktop ou Cursor, la CLI sert de serveur MCP avec la clé de login :

{ "mcpServers": { "locameuble": { "command": "npx", "args": ["-y", "locameuble", "mcp"] } } }

Commandes

• GET/api/v1/lire_accueilLire l'accueil
• GET/api/v1/lister_biensLister les biens
• GET/api/v1/lire_bienLire un bien
• GET/api/v1/lire_tableau_bienLire le tableau d'un bien
• GET/api/v1/lire_risquesLire l'état des risques d'un bien
• GET/api/v1/chercher_dpeChercher un DPE
• GET/api/v1/lister_bauxLister les baux
• GET/api/v1/lire_bailLire un bail
• GET/api/v1/lister_loyersLister les loyers
• GET/api/v1/lister_rapprochements_loyersLister les rapprochements proposés
• GET/api/v1/lister_exercicesLister les exercices
• GET/api/v1/lire_resultatLire le résultat
• GET/api/v1/lister_controlesLister les contrôles
• GET/api/v1/lire_amortissementsLire les amortissements
• GET/api/v1/lire_liasseLire la liasse
• GET/api/v1/lire_reglages_anneeLire les réglages d'une année
• GET/api/v1/lire_tresorerieLire la trésorerie
• GET/api/v1/lister_comptesLister les comptes bancaires
• GET/api/v1/lister_lignes_bancairesLister les lignes bancaires
• GET/api/v1/lister_tiersLister les tiers
• GET/api/v1/lister_lignes_semblablesLister les lignes semblables
• GET/api/v1/lister_revueLister la file de revue
• GET/api/v1/lister_reglesLister les règles de classement
• GET/api/v1/proposer_reglesProposer les classements des règles
• GET/api/v1/lire_repriseLire la reprise
• GET/api/v1/lister_ecrituresLister les écritures
• GET/api/v1/lister_empruntsLister les emprunts
• GET/api/v1/lire_empruntLire un emprunt
• GET/api/v1/lire_echeancier_empruntLire l'échéancier d'un emprunt
• GET/api/v1/lister_locatairesLister les locataires
• GET/api/v1/lire_locataireLire un locataire
• GET/api/v1/lister_documentsLister les documents
• GET/api/v1/lire_demarrageLire la mise en route et les tâches
• GET/api/v1/lire_foyerLire les réglages du foyer
• GET/api/v1/lire_abonnementLire l'abonnement
• GET/api/v1/chercher_entrepriseChercher une entreprise dans l'annuaire
• POST/api/v1/ajouter_ecritureAjouter une écriture
• POST/api/v1/modifier_ecritureModifier une écriture
• POST/api/v1/supprimer_ecritureSupprimer une écriture
• POST/api/v1/joindre_justificatifJoindre un justificatif
• POST/api/v1/detacher_justificatifDétacher un justificatif
• POST/api/v1/joindre_justificatif_ligneJoindre un justificatif à une ligne bancaire
• POST/api/v1/detacher_justificatif_ligneDétacher un justificatif d'une ligne bancaire
• POST/api/v1/lire_documentOuvrir un document
• POST/api/v1/creer_locataireCréer un locataire
• POST/api/v1/modifier_locataireModifier un locataire
• POST/api/v1/archiver_locataireArchiver un locataire
• POST/api/v1/restaurer_locataireRestaurer un locataire
• POST/api/v1/creer_bailCréer un bail
• POST/api/v1/modifier_bailModifier un bail
• POST/api/v1/regler_parts_bailRégler les parts d'une colocation
• POST/api/v1/preparer_loyersPréparer les loyers
• POST/api/v1/preparer_revision_irlPréparer la révision IRL d'un loyer
• POST/api/v1/terminer_bailTerminer un bail
• POST/api/v1/regler_envoi_automatiqueRégler l'envoi automatique d'un bail
• POST/api/v1/supprimer_bailSupprimer un bail
• POST/api/v1/enregistrer_depot_recuEnregistrer le dépôt de garantie reçu
• POST/api/v1/restituer_depotRestituer le dépôt de garantie
• POST/api/v1/annuler_restitutionAnnuler la restitution du dépôt
• POST/api/v1/creer_bienCréer un bien
• POST/api/v1/modifier_bienModifier un bien
• POST/api/v1/archiver_bienArchiver un bien
• POST/api/v1/ajouter_immobilisationAjouter une immobilisation
• POST/api/v1/modifier_immobilisationModifier une immobilisation
• POST/api/v1/retirer_immobilisationRetirer une immobilisation
• POST/api/v1/declarer_cessionDéclarer la vente d'un bien
• POST/api/v1/annuler_cessionAnnuler la vente d'un bien
• POST/api/v1/marquer_loyer_recuMarquer un loyer reçu
• POST/api/v1/annuler_encaissementAnnuler un encaissement
• POST/api/v1/marquer_loyer_perduPasser un loyer en perte
• POST/api/v1/rapprocher_loyerRapprocher un loyer d'un virement
• POST/api/v1/generer_loyersGénérer les loyers
• POST/api/v1/importer_releveImporter un relevé
• POST/api/v1/creer_empruntCréer un emprunt
• POST/api/v1/modifier_empruntModifier un emprunt
• POST/api/v1/archiver_empruntArchiver un emprunt
• POST/api/v1/ajouter_compteAjouter un compte bancaire
• POST/api/v1/modifier_compteModifier un compte bancaire
• POST/api/v1/suggerer_classementProposer le classement d'une ligne
• POST/api/v1/classer_ligneClasser une ligne bancaire
• POST/api/v1/classer_lignesClasser plusieurs lignes
• POST/api/v1/creer_regle_depuis_ligneToujours classer ainsi
• POST/api/v1/noter_ligneNoter une ligne bancaire
• POST/api/v1/ignorer_ligneIgnorer ou rétablir une ligne
• POST/api/v1/proposer_revueLire les lignes à classer
• POST/api/v1/valider_revueValider des propositions
• POST/api/v1/corriger_revueCorriger une proposition
• POST/api/v1/enregistrer_regleEnregistrer une règle de classement
• POST/api/v1/supprimer_regleSupprimer une règle de classement
• POST/api/v1/appliquer_reglesAppliquer les classements des règles
• POST/api/v1/importer_repriseImporter la liasse de l'an dernier
• POST/api/v1/relire_repriseRelire la liasse
• POST/api/v1/corriger_repriseCorriger la reprise
• POST/api/v1/confirmer_repriseConfirmer la reprise
• POST/api/v1/preparer_echeancier_empruntPréparer l'import d'un tableau d'amortissement
• POST/api/v1/confirmer_echeancier_empruntConfirmer l'import d'un tableau d'amortissement
• POST/api/v1/retirer_echeancier_empruntRetirer le tableau d'amortissement importé
• POST/api/v1/preparer_envoiPréparer un envoi
• POST/api/v1/confirmer_envoiConfirmer un envoi
• POST/api/v1/ouvrir_exerciceOuvrir un exercice
• POST/api/v1/valider_controleValider un contrôle
• POST/api/v1/devalider_controleAnnuler la validation d'un contrôle
• POST/api/v1/modifier_reglages_anneeModifier les réglages d'une année
• POST/api/v1/lire_justificatifLire un justificatif
• POST/api/v1/demander_clotureDemander la clôture
• POST/api/v1/annuler_demande_clotureAnnuler la demande de clôture
• POST/api/v1/confirmer_clotureConfirmer la clôture
• POST/api/v1/rouvrir_exerciceRouvrir un exercice clôturé
• POST/api/v1/exporterExporter la liasse, le FEC ou l'aide 2042
• POST/api/v1/signaler_problemeSignaler un problème ou proposer une idée
• POST/api/v1/modifier_foyerRenommer le foyer
• POST/api/v1/modifier_exploitantModifier un déclarant
• POST/api/v1/modifier_activiteModifier l'activité
• POST/api/v1/choisir_option_fiscaleChoisir l'option sur les frais d'acquisition
• POST/api/v1/regler_recapRégler le récap du lundi
• POST/api/v1/regler_classementRégler le classement automatique
• POST/api/v1/preparer_invitationPréparer une invitation
• POST/api/v1/inviter_membreInviter un membre
• POST/api/v1/regler_etape_demarragePasser ou reprendre une étape de mise en route
• POST/api/v1/regler_inscriptionAvancer l'inscription
• POST/api/v1/importer_logicielImporter un dossier JD2M ou Rentila
• POST/api/v1/importer_document_rentilaImporter un document Rentila
• POST/api/v1/exporter_donnees_foyerExporter toutes les données du foyer
• GET/api/v1/lister_factures_recuesLister les factures reçues
• GET/api/v1/lire_facture_recueLire une facture reçue
• POST/api/v1/preparer_facturation_electroniquePréparer la réception des factures électroniques
• POST/api/v1/activer_facturation_electroniqueActiver la réception des factures électroniques
• POST/api/v1/classer_facture_recueClasser une facture reçue
• POST/api/v1/ignorer_facture_recueIgnorer ou rétablir une facture reçue

Le schéma complet de chaque commande s'affiche avec JavaScript. Le même document est à https://app.locameuble.fr/api/v1/openapi.json.