Fichiers fonciers¶
Présentation¶
apifoncier permet d’interroger les parcelles, tup, locaux, propriétaires issues des Fichiers fonciers,
base de données enrichie par le Cerema.
Plus de détails sur Fichiers fonciers
Les données proposées sont disponibles sous forme de dataframe ou geodataframe, accessible soit via le code insee de la commune, du département ou une emprise geographique.
Note
L’accès aux données Fichiers fonciers nécessite d’appartenir à une structure publique bénéficiaire et d’avoir prélablement obtenu un jeton API. Rendez-vous sur ConsultDF pour plus d’informations.
Import¶
Pour importer le module correspondant :
## Configuration préalable du jeton API
import apifoncier
API_TOKEN = "<MON_TOKEN_API>"
apifoncier.configure(TOKEN=API_TOKEN)
import apifoncier.ff as ff
Description des fonctions¶
Parcelles¶
- apifoncier.ff.parcelles(code_insee=None, in_bbox=None, lon_lat=None, fields=None, ordering=None, catpro3=None, ctpdl=None, dcntarti_min=None, dcntarti_max=None, dcntnaf_min=None, dcntnaf_max=None, dcntpa_min=None, dcntpa_max=None, idcomtxt=None, idpar=None, jannathmin_min=None, jannathmin_max=None, nlocal_min=None, nlocal_max=None, nlogh_min=None, nlogh_max=None, slocal_min=None, slocal_max=None, sprincp_min=None, sprincp_max=None, stoth_min=None, stoth_max=None)[source]¶
Retourne les parcelles issues des Fichiers fonciers pour le périmètre demandé sous forme d’un dataframe
- Args:
code_insee (str or list, optional): Codes INSEE communaux ou des arrondissements municipaux. Defaults to None.
coddep (str or list, optional): Codes INSEE des départements. Defaults to None.
in_bbox (list, optional): Emprise rectangulaire sous la forme d’une liste [longitude_min, latitude_min, longitude_min, latitude_max] - Maximum 0.02 deg x 0.02 deg. Defaults to None.
lon_lat (list, optional): Coordonnée du point au sein de la ou des parcelles renvoyées [longitude, latitude]. Defaults to None.
fields (str, optional): Mettre à « all » pour obtenir tous les champs associés. Defaults to None.
ordering (str, optional): Champs à utiliser pour ordonner le résultat. Defaults to None.
- catpro3 (str, optional): Chaîne(s) de caractères contenue dans le code de catégorie de
propriétaire (il est possible de ne specifier que les premiers niveaux et de séparer par une virgule). Defaults to None.
ctpdl (str, optional): Type de pdl (type de copropriété). Defaults to None.
dcntarti_min (int, optional): Surface artificialisée minimale de la parcelle (m2). Defaults to None.
dcntarti_max (int, optional): Surface artificialisée maximale de la parcelle (m2). Defaults to None.
dcntnaf_min (int, optional): Surface NAF minimale de la parcelle (m2). Defaults to None.
dcntnaf_max (int, optional): Surface NAF maximale de la parcelle (m2). Defaults to None.
dcntpa_min (int, optional): Surface minimale de la parcelle (m2). Defaults to None.
dcntpa_max (int, optional): Surface maximale de la parcelle (m2). Defaults to None.
idcomtxt (str, optional): Chaine de caractères contenue dans le libellé de la commune. Defaults to None.
idpar (str, optional): Identifiants de parcelle (séparés par une virgule). Defaults to None.
jannathmin_min (int, optional): Année minimale de construction du local le plus ancien. Defaults to None.
jannathmin_max (int, optional): Année maximale de construction du local le plus ancien. Defaults to None.
nlocal_min (int, optional): Nombre de locaux minimal sur la parcelle. Defaults to None.
nlocal_max (int, optional): Nombre de locaux maximal sur la parcelle. Defaults to None.
nlogh_min (int, optional): Nombre de logements minimal sur la parcelle. Defaults to None.
nlogh_max (int, optional):Nombre de logements maximal sur la parcelle. Defaults to None.
slocal_min (int, optional): Surface minimale des parties d’évaluation (m2). Defaults to None.
slocal_max (int, optional): Surface maximale des parties d’évaluation (m2). Defaults to None.
sprincp_min (int, optional):Surface minimale des pièces principales professionnelles (m2). Defaults to None.
sprincp_max (int, optional): Surface maximale des pièces principales professionnelles (m2). Defaults to None.
stoth_min (int, optional):Surface minimale des pièces d’habitation (m2). Defaults to None.
stoth_max (int, optional): Surface maximale des pièces d’habitation (m2). Defaults to None.
- Returns:
dataframe: données sur les parcelles issues des Fichiers fonciers
- Examples:
>>> import apifoncier.ff as ff >>> ff.parcelles(code_insee="59350", dcntpa_min=3000) >>> ff.parcelles(in_bbox=[3,50,3.01,50.01])
- apifoncier.ff.geoparcelles(code_insee=None, in_bbox=None, lon_lat=None, fields=None, ordering=None, catpro3=None, ctpdl=None, dcntarti_min=None, dcntarti_max=None, dcntnaf_min=None, dcntnaf_max=None, dcntpa_min=None, dcntpa_max=None, idcomtxt=None, idpar=None, jannathmin_min=None, jannathmin_max=None, nlocal_min=None, nlocal_max=None, nlogh_min=None, nlogh_max=None, slocal_min=None, slocal_max=None, sprincp_min=None, sprincp_max=None, stoth_min=None, stoth_max=None)[source]¶
Retourne les parcelles issues des Fichiers fonciers pour le périmètre demandé sous forme d’un geodataframe integrant les contours géométriques
- Args:
code_insee (str or list, optional): Codes INSEE communaux ou des arrondissements municipaux. Defaults to None.
coddep (str or list, optional): Codes INSEE des départements. Defaults to None.
in_bbox (list, optional): Emprise rectangulaire sous la forme d’une liste [longitude_min, latitude_min, longitude_min, latitude_max] - Maximum 0.02 deg x 0.02 deg. Defaults to None.
lon_lat (list, optional): Coordonnée du point au sein de la ou des parcelles renvoyées [longitude, latitude]. Defaults to None.
fields (str, optional): Mettre à « all » pour obtenir tous les champs associés. Defaults to None.
ordering (str, optional): Champs à utiliser pour ordonner le résultat. Defaults to None.
- catpro3 (str, optional): Chaîne(s) de caractères contenue dans le code de catégorie de
propriétaire (il est possible de ne specifier que les premiers niveaux et de séparer par une virgule). Defaults to None.
ctpdl (str, optional): Type de pdl (type de copropriété). Defaults to None.
dcntarti_min (int, optional): Surface artificialisée minimale de la parcelle (m2). Defaults to None.
dcntarti_max (int, optional): Surface artificialisée maximale de la parcelle (m2). Defaults to None.
dcntnaf_min (int, optional): Surface NAF minimale de la parcelle (m2). Defaults to None.
dcntnaf_max (int, optional): Surface NAF maximale de la parcelle (m2). Defaults to None.
dcntpa_min (int, optional): Surface minimale de la parcelle (m2). Defaults to None.
dcntpa_max (int, optional): Surface maximale de la parcelle (m2). Defaults to None.
idcomtxt (str, optional): Chaine de caractères contenue dans le libellé de la commune. Defaults to None.
idpar (str, optional): Identifiants de parcelle (séparés par une virgule). Defaults to None.
jannathmin_min (int, optional): Année minimale de construction du local le plus ancien. Defaults to None.
jannathmin_max (int, optional): Année maximale de construction du local le plus ancien. Defaults to None.
nlocal_min (int, optional): Nombre de locaux minimal sur la parcelle. Defaults to None.
nlocal_max (int, optional): Nombre de locaux maximal sur la parcelle. Defaults to None.
nlogh_min (int, optional): Nombre de logements minimal sur la parcelle. Defaults to None.
nlogh_max (int, optional):Nombre de logements maximal sur la parcelle. Defaults to None.
slocal_min (int, optional): Surface minimale des parties d’évaluation (m2). Defaults to None.
slocal_max (int, optional): Surface maximale des parties d’évaluation (m2). Defaults to None.
sprincp_min (int, optional):Surface minimale des pièces principales professionnelles (m2). Defaults to None.
sprincp_max (int, optional): Surface maximale des pièces principales professionnelles (m2). Defaults to None.
stoth_min (int, optional):Surface minimale des pièces d’habitation (m2). Defaults to None.
stoth_max (int, optional): Surface maximale des pièces d’habitation (m2). Defaults to None.
- Returns:
geodataframe: données sur les parcelles issues des Fichiers fonciers
- Examples:
>>> import apifoncier.ff as ff >>> ff.geoparcelles(code_insee="59350", dcntpa_min=3000) >>> ff.geoparcelles(in_bbox=[3,50,3.01,50.01])
TUP¶
- apifoncier.ff.tups(code_insee=None, in_bbox=None, lon_lat=None, fields=None, ordering=None, catpro3=None, idtup=None, typetup=None)[source]¶
Retourne les tup issues des Fichiers fonciers pour le périmètre demandé sous forme d’un dataframe
- Args:
code_insee (str or list, optional): Codes INSEE communaux ou des arrondissements municipaux. Defaults to None.
coddep (str or list, optional): Codes INSEE des départements. Defaults to None.
in_bbox (list, optional): Emprise rectangulaire sous la forme d’une liste [longitude_min, latitude_min, longitude_min, latitude_max] - Maximum 0.02 deg x 0.02 deg. Defaults to None.
lon_lat (list, optional): Coordonnée du point au sein de la ou des tup renvoyées [longitude, latitude]. Defaults to None.
fields (str, optional): Mettre à « all » pour obtenir tous les champs associés. Defaults to None.
ordering (str, optional): Champs à utiliser pour ordonner le résultat. Defaults to None.
- catpro3 (str, optional): Chaîne(s) de caractères contenue dans le code de catégorie de
propriétaire (il est possible de ne specifier que les premiers niveaux et de séparer par une virgule). Defaults to None.
idtup (str, optional): Identifiants de tup (séparés par une virgule). Defaults to None.
typetup (str, optional): Type de pdl (type de copropriété). Defaults to None.
- Returns:
dataframe: données sur les tup issues des Fichiers fonciers
- Examples:
>>> import apifoncier.ff as ff >>> ff.tups(code_insee="59350", catpro3='P') >>> ff.tups(in_bbox=[3,50,3.01,50.01])
- apifoncier.ff.geotups(code_insee=None, in_bbox=None, lon_lat=None, fields=None, ordering=None, catpro3=None, idtup=None, typetup=None)[source]¶
Retourne les tup issues des Fichiers fonciers pour le périmètre demandé sous forme d’un geodataframe integrant les contours géométriques
- Args:
code_insee (str or list, optional): Codes INSEE communaux ou des arrondissements municipaux. Defaults to None.
coddep (str or list, optional): Codes INSEE des départements. Defaults to None.
in_bbox (list, optional): Emprise rectangulaire sous la forme d’une liste [longitude_min, latitude_min, longitude_min, latitude_max] - Maximum 0.02 deg x 0.02 deg. Defaults to None.
lon_lat (list, optional): Coordonnée du point au sein de la ou des tup renvoyées [longitude, latitude]. Defaults to None.
fields (str, optional): Mettre à « all » pour obtenir tous les champs associés. Defaults to None.
ordering (str, optional): Champs à utiliser pour ordonner le résultat. Defaults to None.
- catpro3 (str, optional): Chaîne(s) de caractères contenue dans le code de catégorie de
propriétaire (il est possible de ne specifier que les premiers niveaux et de séparer par une virgule). Defaults to None.
idtup (str, optional): Identifiants de tup (séparés par une virgule). Defaults to None.
typetup (str, optional): Type de pdl (type de copropriété). Defaults to None.
- Returns:
geodataframe: données sur les tup issues des Fichiers fonciers
- Examples:
>>> import apifoncier.ff as ff >>> ff.geotups(code_insee="59350", catpro3='P') >>> ff.geotups(in_bbox=[3,50,3.01,50.01])
Locaux¶
- apifoncier.ff.locaux(code_insee=None, fields=None, ordering=None, catpro3=None, dteloc=None, idpar=None, idprocpte=None, idsec=None, locprop=None, loghlls=None, proba_rprs=None, slocal_min=None, slocal_max=None, typeact=None)[source]¶
Retourne les locaux des Fichiers fonciers pour le périmètre demandé sous forme d’un dataframe
- Args:
code_insee (str or list, optional): Codes INSEE communaux ou des arrondissements municipaux. Defaults to None.
fields (str, optional): Mettre à « all » pour obtenir tous les champs associés. Defaults to None.
ordering (str, optional): Champs à utiliser pour ordonner le résultat. Defaults to None.
- catpro3 (str or list, optional): Chaîne(s) de caractères contenue dans le code de catégorie de
propriétaire (il est possible de ne specifier que les premiers niveaux et de séparer par une virgule). Defaults to None.
- dteloc (str or list, optional): Type(s) de local (il est possible de spécifier plusieurs types
et de séparer par une virgule). Defaults to None.
idpar (str, optional): Identifiant de parcelle. Defaults to None.
idprocpte (str, optional): Identifiant de compte communal. Defaults to None.
idsec (str, optional): Identifiant de section cadastrale_. Defaults to None.
locprop (str_, optional):Localisation généralisée du propriétaire recevant la Taxe Foncière. Defaults to None.
loghlls (str, optional): Logement d’habitation de type logement social repéré par exonération. Defaults to None.
- proba_rprs (str, optional): Probabilité de résidence principale ou secondaire (il est possible
de spécifier plusieurs types et de séparer par une virgule). Defaults to None.
slocal_min (int, optional): Surface minimale des parties d’évaluation (m2). Defaults to None.
slocal_max (int, optional): Surface maximale des parties d’évaluation (m2). Defaults to None.
- typeact (str, optional): Chaîne(s) de caractères contenue dans le classement du local
selon le type d””activité (Code catégorie du local d’activité) (il est possible de ne specifier que les premiers niveaux et de séparer par une virgule). Defaults to None.
- Returns:
dataframe: données sur les locaux issues des Fichiers fonciers
Propriétaires¶
- apifoncier.ff.proprios(code_insee=None, fields=None, ordering=None, catpro3=None, ccodro=None, gtoper=None, idprocpte=None, locprop=None, typedroit=None)[source]¶
Retourne les droits de propriétés des Fichiers fonciers pour le périmètre demandé sous forme d’un dataframe
- Args:
code_insee (str or list, optional): Codes INSEE communaux ou des arrondissements municipaux. Defaults to None.
fields (str, optional): Mettre à « all » pour obtenir tous les champs associés. Defaults to None.
ordering (str, optional): Champs à utiliser pour ordonner le résultat. Defaults to None.
- catpro3 (str, optional): Chaîne(s) de caractères contenue dans le code de catégorie de
propriétaire (il est possible de ne specifier que les premiers niveaux et de séparer par une virgule). Defaults to None.
- ccodro (str, optional): Code(s) du droit réel ou particulier (il est possible de spécifier
plusieurs valeurs et de séparer par une virgule). Defaults to None.
gtoper (str, optional): Indicateur de personne physique ou moral. Defaults to None.
idprocpte (str, optional): Identifiant de compte communal. Defaults to None.
locprop (str, optional):Localisation généralisée du propriétaire recevant la Taxe Foncière. Defaults to None.
typedroit (str, optional): Type de droit : propriétaire ou gestionnaire. Defaults to None.
- Returns:
dataframe: données sur les locaux issues des Fichiers fonciers