Aller au contenu

Documentation

Règlement du PLU

2 opérations servies.

Règlement du PLU lu et cité

POST/api/v1/urbanisme/reglements

Les règles écrites du règlement de la zone du PLU ou du PLUi d'une adresse (clé BAN, adresse en texte ou point), par thème : voies, limites séparatives, distances entre constructions, emprise au sol, hauteur, piscines, annexes, stationnement, espaces verts, aspect et clôtures. Chaque règle porte sa valeur ou sa formule, son article, sa page et la citation exacte retrouvée dans le texte du PDF ; une règle dont la citation n'est pas retrouvée est écartée, jamais affirmée. La réponse donne aussi les définitions du lexique, les renvois et les thèmes non trouvés. Une zone déjà lue vient du cache des lectures de Pillr ; sinon le règlement est lu par un modèle, ce qui prend de l'ordre d'une minute : la réponse est une tâche (202) dont le résultat se lit ensuite. Une lecture nouvelle est bornée par le débit du serveur. Sans règlement à lire (commune au RNU, carte communale, aucun PDF publié), rien n'est débité. Seul un certificat d'urbanisme engage la commune.

Coût
60 crédits par appel réussi
Accès
À l'usage ou avec l'abonnement Data
Portée
plu
Outil MCP
lire_plu
Bac à sable
Non
Mémoire
Jamais gardée
Délai
300 s

Essayer en direct

Paramètres

  • cle_bantexte

    Clé d'interopérabilité de la Base Adresse Nationale, ex. 69383_1234_00012.

  • qtexte

    Adresse en texte, numéro compris, géocodée par la Base Adresse Nationale.

    de 5 à 200 caractères

  • code_postaltexte

    Code postal, pour départager une adresse homonyme (avec q).

  • latnombre

    Latitude d'un point, avec lon.

    de -90 à 90

  • lonnombre

    Longitude d'un point, avec lat.

    de -180 à 180

  • themesliste de textes

    Thèmes à rendre ; par défaut, tous.

    Valeurs : voies, limites_separatives, entre_constructions, emprise_sol, hauteur, piscines, annexes, stationnement, espaces_verts, aspect_clotures

    10 éléments au plus

  • nature_projettexte

    Nature du projet : les règles propres à cet objet d'abord, puis celles de toutes les constructions.

    Valeurs : maison, extension, veranda, annexe, abri, garage, carport, piscine, terrasse, cloture, autre

  • attendreentier

    Secondes d'attente de la fin de la tâche avant de répondre (60 au plus).

    de 0 à 60 ; par défaut 0

  • webhooktexte

    URL https appelée à la fin de la tâche, signée (Pillr-Signature).

    500 caractères au plus

Exemple d'appel

curl -X POST https://pillr.fr/api/v1/urbanisme/reglements \
  -H "Authorization: Bearer $PILLR_CLE" \
  -H "Content-Type: application/json" \
  -d '{}'

Réponse

  • tacheobjet

    La tâche asynchrone.

    Afficher les 7 champs
    • idtexte

      Identifiant de la tâche, à passer à l'opération de résultat.

    • operationtexte
    • statuttexte

      en_attente, en_cours, terminee (resultat rempli) ou echouee (erreur remplie, crédits rendus).

      Valeurs : en_attente, en_cours, terminee, echouee

    • cree_letexte
    • termine_letexte ou null
    • expire_letexte

      Date au-delà de laquelle le résultat n'est plus conservé.

    • resultat_urltexte

      Chemin de lecture du résultat (GET).

  • resultatobjet ou null

    La sortie de l'opération, quand la tâche est terminée ; null sinon.

    Afficher les 15 champs
    • adresseobjet
      Afficher les 5 champs
      • libelletexte
      • inseetexte ou null
      • precisiontexte

        Précision du point (numero, voie, lieu_dit, point, autre).

      • latnombre
      • lonnombre
    • statuttexte

      lu : règles extraites et vérifiées ; scanne : PDF sans texte, rien n'est affirmé ; zone_absente : la zone n'est pas dans ce règlement.

      Valeurs : lu, scanne, zone_absente

    • messagetexte ou null
    • zoneobjet
      Afficher les 5 champs
      • codetexte ou null
      • libelletexte ou null
      • type_documenttexte ou null
      • documenttexte ou null
      • approuve_letexte ou null
    • autres_zonesliste de textes

      Autres zones qui touchent le point : une parcelle en limite peut relever de plusieurs règlements.

    • reglement_urltexte ou null
    • filtreobjet
      Afficher les 2 champs
      • themesliste de textes

        Valeurs : voies, limites_separatives, entre_constructions, emprise_sol, hauteur, piscines, annexes, stationnement, espaces_verts, aspect_clotures

      • nature_projettexte ou null

        Valeurs : maison, extension, veranda, annexe, abri, garage, carport, piscine, terrasse, cloture, autre

    • reglesliste d'objets
      Afficher les 19 champs
      • themetexte

        Valeurs : voies, limites_separatives, entre_constructions, emprise_sol, hauteur, piscines, annexes, stationnement, espaces_verts, aspect_clotures

      • objetsliste de textes

        Ce que vise la règle ; vide : toutes les constructions.

      • secteursliste de textes

        Secteurs visés, tels qu'écrits ; vide : toute la zone.

      • exceptionstexte ou null
      • formetexte

        distance_min, formule_hauteur, limite_ou_recul, plafond, pourcentage_max, pourcentage_min, minimum, interdit, non_reglemente, qualitatif.

      • valeurnombre ou null
      • unitetexte ou null
      • diviseurnombre ou null

        Formule : distance au moins égale à la hauteur divisée par ce nombre.

      • minimum_mnombre ou null
      • conditionstexte ou null
      • mesuretexte ou null

        Comment la valeur se mesure (à l'égout du toit, au faîtage...).

      • resumetexte
      • citationtexte

        Le passage exact du règlement, retrouvé dans le texte du PDF.

      • articletexte ou null
      • pageentier

        Page du PDF où la citation a été retrouvée (1 : première page du fichier).

      • a_confirmerbooléen

        Citation retrouvée hors du chapitre de la zone : règle à confirmer dans le règlement.

      • reservesliste de textes

        Ce que la citation ne prouve pas.

      • lientexte ou null

        Lien qui ouvre le PDF du règlement à la page de la citation.

      • porteetexte ou null

        Pour une nature de projet : règle propre à cet objet, ou valable pour toutes les constructions.

        Valeurs : specifique, generale

    • definitionsliste d'objets
      Afficher les 6 champs
      • termetexte
      • resumetexte
      • citationtexte

        Le passage exact du règlement, retrouvé dans le texte du PDF.

      • pageentier
      • a_confirmerbooléen
      • lientexte ou null

        Lien qui ouvre le PDF du règlement à la page de la citation.

    • renvoisliste d'objets
      Afficher les 6 champs
      • verstexte
      • objettexte
      • citationtexte

        Le passage exact du règlement, retrouvé dans le texte du PDF.

      • pageentier
      • a_confirmerbooléen
      • lientexte ou null

        Lien qui ouvre le PDF du règlement à la page de la citation.

    • non_trouveliste d'objets
      Afficher les 2 champs
      • themetexte

        Valeurs : voies, limites_separatives, entre_constructions, emprise_sol, hauteur, piscines, annexes, stationnement, espaces_verts, aspect_clotures

      • raisontexte
    • citations_ecarteesentier

      Règles, définitions et renvois écartés : citation introuvable dans le texte, ou valeur absente de la citation.

    • lectureobjet ou null
      Afficher les 4 champs
      • modeletexte
      • extrait_letexte
      • pages_pdfentier
      • depuis_cachebooléen
    • limitesliste de textes
    • qualiteobjet

      Ce qui permet de juger la valeur : nombre, provenance, incertitude, drapeaux, date et source.

      Afficher les 7 champs
      • nentier ou null

        Nombre d'observations derrière la valeur ; null si sans objet.

        0 au moins

      • provenancetexte ou null

        mesure : observé sur la donnée ; estime : modèle, barème ou imputation ; null : sans objet.

        Valeurs : mesure, estime

      • incertitudeobjet ou null

        Incertitude de la valeur : fourchette et demi-largeur.

        Afficher les 3 champs
        • demi_largeur_pctnombre ou null

          Demi-largeur de la fourchette, en % de la valeur.

        • basnombre ou null
        • hautnombre ou null
      • drapeauxliste de textes

        Ce qui doit faire lire la valeur avec prudence ; vide si rien.

        Valeurs : prix_atypique, surface_atypique, vente_en_bloc, doublon_probable, date_estimee, peu_d_observations, valeur_imputee, rattachement_incertain, donnee_ancienne

      • methodetexte ou null

        Méthode de calcul ou de rattachement, en clair.

      • donnees_dutexte ou null

        Date de la donnée (AAAA-MM-JJ ou horodatage ISO 8601).

      • sourcetexte

        Source publique ou moteur Pillr, en clair.

  • erreurobjet ou null

    Pourquoi la tâche a échoué ; null sinon.

    Afficher les 2 champs
    • codetexte
    • detailtexte
  • creditsobjet

    Crédits débités par cet appel (réservés, pour une tâche en cours), et crédits encore utilisables ce mois avant la coupure : crédits offerts, crédits inclus du mois et crédits facturables sous le plafond de dépense (null si inconnus ou en bac à sable).

    Afficher les 2 champs
    • debitesentier

      0 au moins

    • restantsentier ou null

Erreurs possibles

Une ressource absente répond par un code de la famille des ressources absentes, propre à l'opération, sans débit.

Résultat : règlement du PLU lu et cité

GET/api/v1/urbanisme/reglements/{tache}

État et résultat d'une tâche lancée par POST /urbanisme/reglements (outil lire_plu) : statut, sortie complète quand elle est terminée, erreur quand elle a échoué (ses crédits sont alors rendus). Le paramètre attendre patiente jusqu'à 60 s.

Coût
0 crédit par appel réussi
Accès
À l'usage ou avec l'abonnement Data
Portée
plu
Outil MCP
resultat_lire_plu
Bac à sable
Oui, sans débit, sur un jeu figé
Mémoire
Jamais gardée
Délai
5 s

Essayer en direct

Paramètres

  • tachetexteobligatoire

    Identifiant de la tâche rendu au lancement (tache.id).

  • attendreentier

    Secondes d'attente de la fin de la tâche avant de répondre (60 au plus).

    de 0 à 60 ; par défaut 0

Exemple d'appel

curl https://pillr.fr/api/v1/urbanisme/reglements/{tache} \
  -H "Authorization: Bearer $PILLR_CLE"

Réponse

  • tacheobjet

    La tâche asynchrone.

    Afficher les 7 champs
    • idtexte

      Identifiant de la tâche, à passer à l'opération de résultat.

    • operationtexte
    • statuttexte

      en_attente, en_cours, terminee (resultat rempli) ou echouee (erreur remplie, crédits rendus).

      Valeurs : en_attente, en_cours, terminee, echouee

    • cree_letexte
    • termine_letexte ou null
    • expire_letexte

      Date au-delà de laquelle le résultat n'est plus conservé.

    • resultat_urltexte

      Chemin de lecture du résultat (GET).

  • resultatobjet ou null

    La sortie de l'opération, quand la tâche est terminée ; null sinon.

    Afficher les 15 champs
    • adresseobjet
      Afficher les 5 champs
      • libelletexte
      • inseetexte ou null
      • precisiontexte

        Précision du point (numero, voie, lieu_dit, point, autre).

      • latnombre
      • lonnombre
    • statuttexte

      lu : règles extraites et vérifiées ; scanne : PDF sans texte, rien n'est affirmé ; zone_absente : la zone n'est pas dans ce règlement.

      Valeurs : lu, scanne, zone_absente

    • messagetexte ou null
    • zoneobjet
      Afficher les 5 champs
      • codetexte ou null
      • libelletexte ou null
      • type_documenttexte ou null
      • documenttexte ou null
      • approuve_letexte ou null
    • autres_zonesliste de textes

      Autres zones qui touchent le point : une parcelle en limite peut relever de plusieurs règlements.

    • reglement_urltexte ou null
    • filtreobjet
      Afficher les 2 champs
      • themesliste de textes

        Valeurs : voies, limites_separatives, entre_constructions, emprise_sol, hauteur, piscines, annexes, stationnement, espaces_verts, aspect_clotures

      • nature_projettexte ou null

        Valeurs : maison, extension, veranda, annexe, abri, garage, carport, piscine, terrasse, cloture, autre

    • reglesliste d'objets
      Afficher les 19 champs
      • themetexte

        Valeurs : voies, limites_separatives, entre_constructions, emprise_sol, hauteur, piscines, annexes, stationnement, espaces_verts, aspect_clotures

      • objetsliste de textes

        Ce que vise la règle ; vide : toutes les constructions.

      • secteursliste de textes

        Secteurs visés, tels qu'écrits ; vide : toute la zone.

      • exceptionstexte ou null
      • formetexte

        distance_min, formule_hauteur, limite_ou_recul, plafond, pourcentage_max, pourcentage_min, minimum, interdit, non_reglemente, qualitatif.

      • valeurnombre ou null
      • unitetexte ou null
      • diviseurnombre ou null

        Formule : distance au moins égale à la hauteur divisée par ce nombre.

      • minimum_mnombre ou null
      • conditionstexte ou null
      • mesuretexte ou null

        Comment la valeur se mesure (à l'égout du toit, au faîtage...).

      • resumetexte
      • citationtexte

        Le passage exact du règlement, retrouvé dans le texte du PDF.

      • articletexte ou null
      • pageentier

        Page du PDF où la citation a été retrouvée (1 : première page du fichier).

      • a_confirmerbooléen

        Citation retrouvée hors du chapitre de la zone : règle à confirmer dans le règlement.

      • reservesliste de textes

        Ce que la citation ne prouve pas.

      • lientexte ou null

        Lien qui ouvre le PDF du règlement à la page de la citation.

      • porteetexte ou null

        Pour une nature de projet : règle propre à cet objet, ou valable pour toutes les constructions.

        Valeurs : specifique, generale

    • definitionsliste d'objets
      Afficher les 6 champs
      • termetexte
      • resumetexte
      • citationtexte

        Le passage exact du règlement, retrouvé dans le texte du PDF.

      • pageentier
      • a_confirmerbooléen
      • lientexte ou null

        Lien qui ouvre le PDF du règlement à la page de la citation.

    • renvoisliste d'objets
      Afficher les 6 champs
      • verstexte
      • objettexte
      • citationtexte

        Le passage exact du règlement, retrouvé dans le texte du PDF.

      • pageentier
      • a_confirmerbooléen
      • lientexte ou null

        Lien qui ouvre le PDF du règlement à la page de la citation.

    • non_trouveliste d'objets
      Afficher les 2 champs
      • themetexte

        Valeurs : voies, limites_separatives, entre_constructions, emprise_sol, hauteur, piscines, annexes, stationnement, espaces_verts, aspect_clotures

      • raisontexte
    • citations_ecarteesentier

      Règles, définitions et renvois écartés : citation introuvable dans le texte, ou valeur absente de la citation.

    • lectureobjet ou null
      Afficher les 4 champs
      • modeletexte
      • extrait_letexte
      • pages_pdfentier
      • depuis_cachebooléen
    • limitesliste de textes
    • qualiteobjet

      Ce qui permet de juger la valeur : nombre, provenance, incertitude, drapeaux, date et source.

      Afficher les 7 champs
      • nentier ou null

        Nombre d'observations derrière la valeur ; null si sans objet.

        0 au moins

      • provenancetexte ou null

        mesure : observé sur la donnée ; estime : modèle, barème ou imputation ; null : sans objet.

        Valeurs : mesure, estime

      • incertitudeobjet ou null

        Incertitude de la valeur : fourchette et demi-largeur.

        Afficher les 3 champs
        • demi_largeur_pctnombre ou null

          Demi-largeur de la fourchette, en % de la valeur.

        • basnombre ou null
        • hautnombre ou null
      • drapeauxliste de textes

        Ce qui doit faire lire la valeur avec prudence ; vide si rien.

        Valeurs : prix_atypique, surface_atypique, vente_en_bloc, doublon_probable, date_estimee, peu_d_observations, valeur_imputee, rattachement_incertain, donnee_ancienne

      • methodetexte ou null

        Méthode de calcul ou de rattachement, en clair.

      • donnees_dutexte ou null

        Date de la donnée (AAAA-MM-JJ ou horodatage ISO 8601).

      • sourcetexte

        Source publique ou moteur Pillr, en clair.

  • erreurobjet ou null

    Pourquoi la tâche a échoué ; null sinon.

    Afficher les 2 champs
    • codetexte
    • detailtexte
  • creditsobjet

    Crédits débités par cet appel (réservés, pour une tâche en cours), et crédits encore utilisables ce mois avant la coupure : crédits offerts, crédits inclus du mois et crédits facturables sous le plafond de dépense (null si inconnus ou en bac à sable).

    Afficher les 2 champs
    • debitesentier

      0 au moins

    • restantsentier ou null

Erreurs possibles

Une ressource absente répond par un code de la famille des ressources absentes, propre à l'opération, sans débit.

    Règlement du PLU : référence de l'API | Pillr Data