Cartofriches - principaux endpoints
Permet d'interroger les friches et leurs géométries.
📂 cartofriches.friches
Description
Retourne les friches issues de Cartofriches pour la commune, le département ou l'emprise rectangulaire 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). |
None
|
codes_insee
|
(List[str], optionnel)
|
Liste de codes INSEE. |
None
|
coddep
|
(str, obligatoire)
|
Code INSEE départemental. |
None
|
in_bbox
|
(List[float], obligatoire)
|
[xmin, ymin, xmax, ymax], max 1.0° x 1.0°. |
None
|
lon_lat
|
(List[float], optionnel)
|
Coordonnées [lon, lat]. |
None
|
contains_lon_lat
|
(List[float], optionnel)
|
Coordonnées à contenir [lon, lat]. |
None
|
surface_min
|
(float, optionnel)
|
Surface minimale de l'unité foncière. |
None
|
surface_max
|
(float, optionnel)
|
Surface maximale de l'unité foncière. |
None
|
urba_zone_type
|
(str, optionnel)
|
Type de zone d'urbanisme. |
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 friches. |
Source code in apifoncier\endpoints\cartofriches.py
Exemples d'utilisation
-
Friches d'une commune :
-
Friches d'un département :
-
Friches dans une emprise géographique :
-
Friches autour d'un point
-
Friches avec filtres - surface entre 1000 et 5000 m², zone urbaine de type "U" :
📂 cartofriches.geofriches
Description
Retourne, en GeoJSON, les friches issues de Cartofriches pour la commune, le département ou l'emprise rectangulaire 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). |
None
|
codes_insee
|
(List[str], optionnel)
|
Liste de codes INSEE. |
None
|
coddep
|
(str, obligatoire)
|
Code INSEE départemental. |
None
|
in_bbox
|
(List[float], obligatoire)
|
[xmin, ymin, xmax, ymax], max 1.0° x 1.0°. |
None
|
lon_lat
|
(List[float], optionnel)
|
Coordonnées [lon, lat]. |
None
|
contains_lon_lat
|
(List[float], optionnel)
|
Coordonnées à contenir [lon, lat]. |
None
|
surface_min
|
(float, optionnel)
|
Surface minimale de l'unité foncière. |
None
|
surface_max
|
(float, optionnel)
|
Surface maximale de l'unité foncière. |
None
|
urba_zone_type
|
(str, optionnel)
|
Type de zone d'urbanisme. |
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 friches géolocalisées. |
Source code in apifoncier\endpoints\cartofriches.py
Exemples d'utilisation
- Friches géolocalisées d'une commune :
- Friches géolocalisées d'un département :
- Friches géolocalisées avec filtre sur zone urbaine :
📂 cartofriches.friche_by_id
Description
Retourne la friche pour l'identifiant de site demandé.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
site_id
|
(str, obligatoire)
|
Identifiant unique du site. |
required |
format_output
|
(str, optionnel)
|
'dict'. |
'dict'
|
Returns:
| Type | Description |
|---|---|
Union[dict, List[dict]]
|
Détails de la friche. |
Source code in apifoncier\endpoints\cartofriches.py
Exemples d'utilisation
- Friche par identifiant :