Fichiers Fonciers - principaux endpoints
Permet d'interroger les parcelles, locaux, TUPs, droits de propriété et leurs géométries.
Clef API
Une clé API est requise pour accéder aux endpoints FF. Vous pouvez obtenir une clé via le Portail Données foncières.
from apifoncier.client import ApiFoncierClient
api_key = "VOTRE_CLE_API" # Clé API requise pour accéder aux endpoints FF
client = ApiFoncierClient({"api_key": api_key})
📂 ff.parcelles
Description
Retourne les parcelles issues des Fichiers Fonciers pour la commune ou l'emprise rectangulaire demandée.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
code_insee
|
(str, optionnel)
|
Code INSEE communal ou d'arrondissement municipal (max 10, séparés par virgule). |
None
|
codes_insee
|
(List[str], optionnel)
|
Liste de codes INSEE. |
None
|
in_bbox
|
(List[float], optionnel)
|
[xmin, ymin, xmax, ymax], max 0.02° x 0.02°. |
None
|
lon_lat
|
(List[float], optionnel)
|
Coordonnées [lon, lat]. |
None
|
contains_lon_lat
|
(List[float], optionnel)
|
Coordonnées à contenir [lon, lat]. |
None
|
catpro3
|
(str, optionnel)
|
Catégorie propriétaire. |
None
|
ctpdl
|
(str, optionnel)
|
Type de pdl (copropriété). |
None
|
dcntarti_min
|
(int, optionnel)
|
Surface artificialisée minimale (m2). |
None
|
dcntarti_max
|
(int, optionnel)
|
Surface artificialisée maximale (m2). |
None
|
dcntnaf_min
|
(float, optionnel)
|
Surface NAF minimale (m2). |
None
|
dcntnaf_max
|
(float, optionnel)
|
Surface NAF maximale (m2). |
None
|
dcntpa_min
|
(int, optionnel)
|
Surface parcelle minimale (m2). |
None
|
dcntpa_max
|
(int, optionnel)
|
Surface parcelle maximale (m2). |
None
|
idcomtxt
|
(str, optionnel)
|
Libellé commune (recherche texte). |
None
|
idpar
|
(List[str], optionnel)
|
Identifiants de parcelle (max 10, séparés par virgule). |
None
|
jannatmin_min
|
(int, optionnel)
|
Année construction minimale. |
None
|
jannatmin_max
|
(int, optionnel)
|
Année construction maximale. |
None
|
nlocal_min
|
(int, optionnel)
|
Nombre de locaux minimal. |
None
|
nlocal_max
|
(int, optionnel)
|
Nombre de locaux maximal. |
None
|
nlogh_min
|
(int, optionnel)
|
Nombre de logements minimal. |
None
|
nlogh_max
|
(int, optionnel)
|
Nombre de logements maximal. |
None
|
slocal_min
|
(int, optionnel)
|
Surface parties d'évaluation minimale (m2). |
None
|
slocal_max
|
(int, optionnel)
|
Surface parties d'évaluation maximale (m2). |
None
|
sprincp_min
|
(int, optionnel)
|
Surface pièces principales pro minimale (m2). |
None
|
sprincp_max
|
(int, optionnel)
|
Surface pièces principales pro maximale (m2). |
None
|
stoth_min
|
(int, optionnel)
|
Surface pièces d'habitation minimale (m2). |
None
|
stoth_max
|
(int, optionnel)
|
Surface pièces d'habitation maximale (m2). |
None
|
fields
|
(str, optionnel)
|
'all' pour obtenir tous les champs, None sinon. |
None
|
ordering
|
(str, optionnel)
|
Champ de tri. |
None
|
page
|
(int, optionnel)
|
Page de résultats. |
None
|
page_size
|
(int, optionnel)
|
Nombre de résultats par page. |
500
|
paginate
|
(bool, optionnel)
|
Pagination automatique. |
True
|
format_output
|
(str, optionnel)
|
'dataframe' ou 'dict'. |
'dataframe'
|
Returns:
| Type | Description |
|---|---|
Union[DataFrame, List[dict]]
|
DataFrame ou liste de dictionnaires des parcelles. |
Source code in apifoncier\endpoints\ff.py
27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 | |
Exemples d'utilisation
- Parcelles d'une commune :
- Parcelles dans une emprise géographique :
- Parcelles avec plusieurs codes INSEE et une surface minimale de 1000 m² :
-
Parcelles avec filtre centrée sur une coordonnée (lon, lat) :
-
Parcelles appartenant à des propriétaires personnes physiques (catpro3="X"), avec au moins un local (nlocal_min=1) et construites après 2010 (jannatmin_min=2010) dans la commune dont le code insee est 59001 :
📂 ff.parcelle_by_id
Description
Retourne la parcelle des Fichiers fonciers pour l'identifiant idparcelle demandé.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
idparcelle
|
(str, obligatoire)
|
Identifiant de la parcelle. |
required |
format_output
|
(str, optionnel)
|
'dict'. |
'dict'
|
Returns:
| Type | Description |
|---|---|
Union[dict, List[dict]]
|
Dictionnaire de la parcelle. |
Source code in apifoncier\endpoints\ff.py
Exemples d'utilisation
- Parcelle par identifiant :
📂 ff.geoparcelles
Description
Retourne, en GeoJSON, les parcelles issues des Fichiers Fonciers pour la commune ou l'emprise rectangulaire demandée.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
code_insee
|
(str, optionnel)
|
Code INSEE communal ou d'arrondissement municipal (max 10, séparés par virgule). |
None
|
codes_insee
|
(List[str], optionnel)
|
Liste de codes INSEE. |
None
|
in_bbox
|
(List[float], optionnel)
|
[xmin, ymin, xmax, ymax], max 0.02° x 0.02°. |
None
|
lon_lat
|
(List[float], optionnel)
|
Coordonnées [lon, lat]. |
None
|
contains_lon_lat
|
(List[float], optionnel)
|
Coordonnées à contenir [lon, lat]. |
None
|
catpro3
|
(str, optionnel)
|
Catégorie propriétaire. |
None
|
ctpdl
|
(str, optionnel)
|
Type de pdl (copropriété). |
None
|
dcntarti_min
|
(int, optionnel)
|
Surface artificialisée minimale (m2). |
None
|
dcntarti_max
|
(int, optionnel)
|
Surface artificialisée maximale (m2). |
None
|
dcntnaf_min
|
(float, optionnel)
|
Surface NAF minimale (m2). |
None
|
dcntnaf_max
|
(float, optionnel)
|
Surface NAF maximale (m2). |
None
|
dcntpa_min
|
(int, optionnel)
|
Surface parcelle minimale (m2). |
None
|
dcntpa_max
|
(int, optionnel)
|
Surface parcelle maximale (m2). |
None
|
idcomtxt
|
(str, optionnel)
|
Libellé commune (recherche texte). |
None
|
idpar
|
(List[str], optionnel)
|
Identifiants de parcelle (max 10, séparés par virgule). |
None
|
jannatmin_min
|
(int, optionnel)
|
Année construction minimale. |
None
|
jannatmin_max
|
(int, optionnel)
|
Année construction maximale. |
None
|
nlocal_min
|
(int, optionnel)
|
Nombre de locaux minimal. |
None
|
nlocal_max
|
(int, optionnel)
|
Nombre de locaux maximal. |
None
|
nlogh_min
|
(int, optionnel)
|
Nombre de logements minimal. |
None
|
nlogh_max
|
(int, optionnel)
|
Nombre de logements maximal. |
None
|
slocal_min
|
(int, optionnel)
|
Surface parties d'évaluation minimale (m2). |
None
|
slocal_max
|
(int, optionnel)
|
Surface parties d'évaluation maximale (m2). |
None
|
sprincp_min
|
(int, optionnel)
|
Surface pièces principales pro minimale (m2). |
None
|
sprincp_max
|
(int, optionnel)
|
Surface pièces principales pro maximale (m2). |
None
|
stoth_min
|
(int, optionnel)
|
Surface pièces d'habitation minimale (m2). |
None
|
stoth_max
|
(int, optionnel)
|
Surface pièces d'habitation maximale (m2). |
None
|
fields
|
(str, optionnel)
|
'all' pour obtenir tous les champs, None sinon. |
None
|
page
|
(int, optionnel)
|
Page de résultats. |
None
|
page_size
|
(int, optionnel)
|
Nombre de résultats par page. |
500
|
paginate
|
(bool, optionnel)
|
Pagination automatique. |
True
|
format_output
|
(str, optionnel)
|
'dataframe' ou 'dict'. |
'dataframe'
|
Returns:
| Type | Description |
|---|---|
GeoDataFrame
|
GeoDataFrame des parcelles géolocalisées. |
Source code in apifoncier\endpoints\ff.py
184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 | |
Exemples d'utilisation
- Parcelles géolocalisées d'une commune :
- Parcelles géolocalisées dans une emprise :
- Parcelles géolocalisées avec un propriétaire public :
📂 ff.locaux
Description
Retourne les locaux issus des Fichiers Fonciers pour la commune demandée.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
code_insee
|
(str, obligatoire)
|
Code INSEE communal ou d'arrondissement municipal (max 10, séparés par virgule). |
required |
catpro3
|
(str, optionnel)
|
Catégorie propriétaire. |
None
|
dteloc
|
(str, optionnel)
|
Type(s) de local (séparés par virgule). |
None
|
idpar
|
(str, optionnel)
|
Identifiant de parcelle. |
None
|
idprocpte
|
(str, optionnel)
|
Identifiant de compte communal. |
None
|
idsec
|
(str, optionnel)
|
Identifiant de section cadastrale. |
None
|
locprop
|
(List[str], optionnel)
|
Localisation généralisée du propriétaire (séparés par virgule). |
None
|
loghlls
|
(str, optionnel)
|
Logement social repéré par exonération. |
None
|
proba_rprs
|
(str, optionnel)
|
Probabilité résidence principale/secondaire. |
None
|
slocal_min
|
(int, optionnel)
|
Surface parties d'évaluation minimale (m2). |
None
|
slocal_max
|
(int, optionnel)
|
Surface parties d'évaluation maximale (m2). |
None
|
typeact
|
(str, optionnel)
|
Type d'activité. |
None
|
fields
|
(str, optionnel)
|
'all' pour obtenir tous les champs, None sinon. |
None
|
ordering
|
(str, optionnel)
|
Champ de tri. |
None
|
page
|
(int, optionnel)
|
Page de résultats. |
None
|
page_size
|
(int, optionnel)
|
Nombre de résultats par page. |
500
|
paginate
|
(bool, optionnel)
|
Pagination automatique. |
True
|
format_output
|
(str, optionnel)
|
'dataframe' ou 'dict'. |
'dataframe'
|
Returns:
| Type | Description |
|---|---|
Union[DataFrame, List[dict]]
|
DataFrame ou liste de dictionnaires des locaux. |
Source code in apifoncier\endpoints\ff.py
314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 | |
Exemples d'utilisation
- Locaux d'une commune :
- Locaux de type "appartement" (dteloc="2") dans la commune de Lille (59350) avec une surface minimale de 180 m² :
📂 ff.local_by_id
Description
Retourne le local des Fichiers fonciers pour l'identifiant fiscal du local demandé.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
idlocal
|
(str, obligatoire)
|
Identifiant fiscal du local. |
required |
format_output
|
(str, optionnel)
|
'dict'. |
'dict'
|
Returns:
| Type | Description |
|---|---|
Union[dict, List[dict]]
|
Dictionnaire du local. |
Source code in apifoncier\endpoints\ff.py
Exemples d'utilisation
- Local par identifiant :
📂 ff.tups
Description
Retourne les TUPs issues des Fichiers Fonciers pour la commune ou l'emprise demandée.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
code_insee
|
(str, optionnel)
|
Code INSEE communal ou d'arrondissement municipal (max 10, séparés par virgule). |
None
|
codes_insee
|
(List[str], optionnel)
|
Liste de codes INSEE. |
None
|
in_bbox
|
(List[float], optionnel)
|
[xmin, ymin, xmax, ymax], max 0.02° x 0.02°. |
None
|
lon_lat
|
(List[float], optionnel)
|
Coordonnées [lon, lat]. |
None
|
contains_lon_lat
|
(List[float], optionnel)
|
Coordonnées à contenir [lon, lat]. |
None
|
catpro3
|
(str, optionnel)
|
Catégorie propriétaire. |
None
|
fields
|
(str, optionnel)
|
Champs à retourner. |
None
|
idtup
|
(List[str], optionnel)
|
Identifiants de TUP (max 10, séparés par virgule). |
None
|
typetup
|
(str, optionnel)
|
Type de TUP (SIMPLE, PDLMP, UF). |
None
|
ordering
|
(str, optionnel)
|
Champ de tri. |
None
|
page
|
(int, optionnel)
|
Page de résultats. |
None
|
page_size
|
(int, optionnel)
|
Nombre de résultats par page. |
500
|
paginate
|
(bool, optionnel)
|
Pagination automatique. |
True
|
format_output
|
(str, optionnel)
|
'dataframe' ou 'dict'. |
'dataframe'
|
Returns:
| Type | Description |
|---|---|
Union[DataFrame, List[dict]]
|
DataFrame ou liste de dictionnaires des TUPs. |
Source code in apifoncier\endpoints\ff.py
Exemples d'utilisation
- TUPs d'une commune :
- TUPs de type "unité foncière" (typetup="UF") appartenant à des propriétaires publics (catpro3="P") :
- TUPs avec plusieurs identifiants :
📂 ff.tup_by_id
Description
Retourne la TUP des Fichiers fonciers pour l'identifiant idtup demandé.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
idtup
|
(str, obligatoire)
|
Identifiant de la TUP. |
required |
format_output
|
(str, optionnel)
|
'dict'. |
'dict'
|
Returns:
| Type | Description |
|---|---|
Union[dict, List[dict]]
|
Dictionnaire de la TUP. |
Source code in apifoncier\endpoints\ff.py
Exemples d'utilisation
- TUP par identifiant :
📂 ff.geotups
Description
Retourne, en GeoJSON, les TUPs issues des Fichiers Fonciers pour la commune ou l'emprise demandée.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
code_insee
|
(str, optionnel)
|
Code INSEE communal ou d'arrondissement municipal (max 10, séparés par virgule). |
None
|
codes_insee
|
(List[str], optionnel)
|
Liste de codes INSEE. |
None
|
in_bbox
|
(List[float], optionnel)
|
[xmin, ymin, xmax, ymax], max 0.02° x 0.02°. |
None
|
lon_lat
|
(List[float], optionnel)
|
Coordonnées [lon, lat]. |
None
|
contains_lon_lat
|
(List[float], optionnel)
|
Coordonnées à contenir [lon, lat]. |
None
|
catpro3
|
(str, optionnel)
|
Catégorie propriétaire. |
None
|
fields
|
(str, optionnel)
|
Champs à retourner. |
None
|
idtup
|
(List[str], optionnel)
|
Identifiants de TUP (max 10, séparés par virgule). |
None
|
typetup
|
(str, optionnel)
|
Type de TUP (SIMPLE, PDLMP, UF). |
None
|
page
|
(int, optionnel)
|
Page de résultats. |
None
|
page_size
|
(int, optionnel)
|
Nombre de résultats par page. |
500
|
paginate
|
(bool, optionnel)
|
Pagination automatique. |
True
|
format_output
|
(str, optionnel)
|
'dataframe' ou 'dict'. |
'dataframe'
|
Returns:
| Type | Description |
|---|---|
GeoDataFrame
|
GeoDataFrame des TUPs géolocalisées. |
Source code in apifoncier\endpoints\ff.py
Exemples d'utilisation
- TUPs géolocalisées d'une commune :
- TUPs géolocalisées avec filtre propriétaire :
📂 ff.proprios
Description
Retourne les droits de propriété issus des Fichiers Fonciers pour la commune demandée.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
code_insee
|
(str, obligatoire)
|
Code INSEE communal ou d'arrondissement municipal (max 10, séparés par virgule). |
required |
catpro3
|
(str, optionnel)
|
Catégorie propriétaire. |
None
|
ccodro
|
(str, optionnel)
|
Code(s) du droit réel ou particulier (séparés par virgule). |
None
|
fields
|
(str, optionnel)
|
Champs à retourner. |
None
|
gtoper
|
(str, optionnel)
|
Indicateur personne physique/morale. |
None
|
idprocpte
|
(str, optionnel)
|
Identifiant de compte communal. |
None
|
locprop
|
(str, optionnel)
|
Localisation généralisée du propriétaire. |
None
|
ordering
|
(str, optionnel)
|
Champ de tri. |
None
|
page
|
(int, optionnel)
|
Page de résultats. |
None
|
page_size
|
(int, optionnel)
|
Nombre de résultats par page. |
500
|
typedroit
|
(str, optionnel)
|
Type de droit (propriétaire/gestionnaire). |
None
|
paginate
|
(bool, optionnel)
|
Pagination automatique. |
True
|
format_output
|
(str, optionnel)
|
'dataframe' ou 'dict'. |
'dataframe'
|
Returns:
| Type | Description |
|---|---|
Union[DataFrame, List[dict]]
|
DataFrame ou liste de dictionnaires des droits de propriété. |
Source code in apifoncier\endpoints\ff.py
Exemples d'utilisation
- Droits de propriété d'une commune :
- Droits de propriété avec filtre sur catégorie publique :
- Droits de propriété avec droit de propriété de type GERANT,MANDATAIRE (ccodro) :
📂 ff.proprio_by_id
Description
Retourne le droit de propriété des Fichiers fonciers pour l'identifiant idprodroit demandé.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
idprodroit
|
(str, obligatoire)
|
Identifiant du droit de propriété. |
required |
format_output
|
(str, optionnel)
|
'dict'. |
'dict'
|
Returns:
| Type | Description |
|---|---|
Union[dict, List[dict]]
|
Dictionnaire du droit de propriété. |
Source code in apifoncier\endpoints\ff.py
Exemples d'utilisation
- Droit de propriété par identifiant :