Indicateurs - principaux endpoints
Permet d'interroger les indicateurs de consommation d'espace ainsi que les indicateurs de marché : accessibilité, activité, prix et valorisation.
📂 indicateurs.conso
Description
Renvoie les indicateurs de consommation d'espace pour la période comprise entre annee_min et annee_max, bornes incluses.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
code
|
(str, obligatoire)
|
Code INSEE communal ou départemental. |
required |
echelle
|
(str, obligatoire)
|
'communes' ou 'departements'. |
required |
annee
|
(int, optionnel)
|
Année spécifique. |
None
|
annee_min
|
(int, optionnel)
|
Année minimale. |
None
|
annee_max
|
(int, optionnel)
|
Année maximale. |
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'
|
fields
|
(str, optionnel)
|
'all' pour obtenir tous les champs, None sinon. |
required |
Returns:
| Type | Description |
|---|---|
Union[DataFrame, List[dict]]
|
DataFrame ou liste de dictionnaires avec les indicateurs de consommation d'espace. |
Source code in apifoncier\endpoints\indicateurs.py
Exemples d'utilisation
- Consommation d'espace pour une commune :
- Consommation d'espace pour un département :
- Consommation d'espace sur une période :
- Consommation d'espace avec tri :
📂 indicateurs.accessibilite
Description
Retourne les indicateurs d'accessibilité financière tri-annuels issus de DV3F.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
codes_aav
|
str ou List[str], obligatoire
|
Code(s) INSEE d'une aire d'attraction des villes (max 10). |
required |
annee
|
(str, optionnel)
|
Année. |
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'
|
fields
|
(str, optionnel)
|
'all' pour obtenir tous les champs, None sinon. |
required |
Returns:
| Type | Description |
|---|---|
Union[DataFrame, List[dict]]
|
DataFrame ou liste de dictionnaires avec les indicateurs d'accessibilité. |
Source code in apifoncier\endpoints\indicateurs.py
Exemples d'utilisation
- Accessibilité pour une AAV :
- Accessibilité pour plusieurs AAV :
- Accessibilité pour une année donnée :
📂 indicateurs.activite
Description
Renvoie les indicateurs d'activité du marché tri-annuels issus de DV3F.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
codes
|
str ou List[str], obligatoire
|
Code(s) INSEE géographique(s) associé(s) à l'échelle (max 10). |
required |
echelle
|
(str, obligatoire)
|
'communes', 'epci', 'aav', 'departements', 'regions', 'france'. |
required |
annee
|
(str, optionnel)
|
Année centrale de la période de 3 ans. |
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'
|
fields
|
(str, optionnel)
|
'all' pour obtenir tous les champs, None sinon. |
required |
Returns:
| Type | Description |
|---|---|
Union[DataFrame, List[dict]]
|
DataFrame ou liste de dictionnaires avec les indicateurs d'activité. |
Source code in apifoncier\endpoints\indicateurs.py
Exemples d'utilisation
- Activité pour une commune :
- Activité pour un EPCI :
- Activité pour plusieurs codes :
📂 indicateurs.prix
Description
Renvoie les indicateurs de prix et de volume annuels ou tri-annuels issus de DV3F.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
codes
|
str ou List[str], obligatoire
|
Code(s) INSEE géographique(s) associé(s) à l'échelle (max 10). |
required |
echelle
|
(str, obligatoire)
|
'communes', 'epci', 'aav', 'departements', 'regions', 'france'. |
required |
type_prix
|
(str, optionnel)
|
'annuel' ou 'triennal'. |
'annuel'
|
annee
|
(str, optionnel)
|
Année de mutation ou centrale pour triennal. |
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'
|
fields
|
(str, optionnel)
|
'all' pour obtenir tous les champs, None sinon. |
required |
Returns:
| Type | Description |
|---|---|
Union[DataFrame, List[dict]]
|
DataFrame ou liste de dictionnaires avec les indicateurs de prix. |
Source code in apifoncier\endpoints\indicateurs.py
Exemples d'utilisation
- Prix annuel pour une commune :
- Prix triennal pour un département :
- Prix avec tri et année :
📂 indicateurs.valorisation
Description
Renvoie les indicateurs tri-annuels de valorisation d'une commune dans son AAV ou EPCI issus de DV3F.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
code
|
(str, obligatoire)
|
Code INSEE de l'AAV ou de l'EPCI. |
required |
echelle
|
(str, obligatoire)
|
'aav' ou 'epci'. |
required |
annee
|
(str, optionnel)
|
Année centrale de la période de 3 ans. |
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'
|
fields
|
(str, optionnel)
|
'all' pour obtenir tous les champs, None sinon. |
required |
Returns:
| Type | Description |
|---|---|
Union[DataFrame, List[dict]]
|
DataFrame ou liste de dictionnaires avec les indicateurs de valorisation. |
Source code in apifoncier\endpoints\indicateurs.py
Exemples d'utilisation
- Valorisation pour une AAV :
- Valorisation pour un EPCI :
- Valorisation pour une année donnée :