import pandas as pd
from .config import get_param
from . import utils
[docs]
def aav(
code_insee=None,
ordering=None,
annee=None,
periode="annuel",
):
"""Retourne les indicateurs annuels ou triennaux de prix à l'aire d'attraction de la ville
Args:
**code_insee (str or list, required)**: Codes INSEE des AAV. Defaults to None.
**ordering (str, optional)**: Champs à utiliser pour ordonner le résultat. Defaults to None.
**annee (str, optional)**: Année. Defaults to None.
**periode (str, optional)**: Prend la valeur "annuel" ou "triennal". Defaults to annuel.
Returns:
dataframe: données sur les marchés immobiliers
Examples:
>>> import apifoncier.ind_prix as prix
>>> prix.aav(code_insee="001")
>>> prix.aav(code_insee=["001", "002"], annee="2020")
>>> prix.aav(code_insee=["001", "002"], periode="triennal")
"""
if not periode in ("annuel", "triennal"):
raise ValueError("Le paramètre periode doit valoir 'annuel' ou 'triennal'.")
result = utils.Resultat(f"/indicateurs/dv3f/aav/{periode}/", **locals())
df = result.get_dataframe(no_param_code=True)
return df
[docs]
def communes(
code_insee=None,
ordering=None,
annee=None,
periode="annuel",
):
"""Retourne les indicateurs annuels ou triennaux de prix à la commune
Args:
**code_insee (str or list, required)**: Codes INSEE communaux ou des arrondissements municipaux. Defaults to None.
**ordering (str, optional)**: Champs à utiliser pour ordonner le résultat. Defaults to None.
**annee (str, optional)**: Année. Defaults to None.
**periode (str, optional)**: Prend la valeur "annuel" ou "triennal". Defaults to annuel.
Returns:
dataframe: données sur les marchés immobiliers
Examples:
>>> import apifoncier.ind_prix as prix
>>> prix.communes(code_insee="59350")
>>> prix.communes(code_insee=["59350", "59646"], annee="2020")
>>> prix.communes(code_insee=["59350", "59646"], periode="triennal")
"""
if not periode in ("annuel", "triennal"):
raise ValueError("Le paramètre periode doit valoir 'annuel' ou 'triennal'.")
result = utils.Resultat(f"/indicateurs/dv3f/communes/{periode}/", **locals())
df = result.get_dataframe(no_param_code=True)
return df
[docs]
def departements(
coddep=None,
ordering=None,
annee=None,
periode="annuel",
):
"""Retourne les indicateurs annuels ou triennaux de prix à l'échelle du département
Args:
**coddep (str or list, required)**: Codes des départements. Defaults to None.
**ordering (str, optional)**: Champs à utiliser pour ordonner le résultat. Defaults to None.
**annee (str, optional)**: Année. Defaults to None.
**periode (str, optional)**: Prend la valeur "annuel" ou "triennal". Defaults to annuel.
Returns:
dataframe: données sur les marchés immobiliers
Examples:
>>> import apifoncier.ind_prix as prix
>>> prix.departements(coddep="59")
>>> prix.departements(coddep=["59", "62"], annee="2020")
>>> prix.departements(coddep=["59", "62"], periode="triennal")
"""
if not periode in ("annuel", "triennal"):
raise ValueError("Le paramètre periode doit valoir 'annuel' ou 'triennal'.")
result = utils.Resultat(f"/indicateurs/dv3f/departements/{periode}/", **locals())
df = result.get_dataframe(no_param_code=True)
return df
[docs]
def epci(
code_insee=None,
ordering=None,
annee=None,
periode="annuel",
):
"""Retourne les indicateurs annuels ou triennaux de prix à l'EPCI
Args:
**code_insee (str or list, optional)**: Codes INSEE des EPCI. Defaults to None.
**ordering (str, optional)**: Champs à utiliser pour ordonner le résultat. Defaults to None.
**annee (str, optional)**: Année. Defaults to None.
**periode (str, optional)**: Prend la valeur "annuel" ou "triennal". Defaults to annuel.
Returns:
dataframe: données sur les marchés immobiliers
Examples:
>>> import apifoncier.ind_prix as prix
>>> prix.epci(code_insee="200093201")
>>> prix.epci(code_insee="200093201", periode="triennal")
"""
if not periode in ("annuel", "triennal"):
raise ValueError("Le paramètre periode doit valoir 'annuel' ou 'triennal'.")
result = utils.Resultat(f"/indicateurs/dv3f/epci/{periode}/", **locals())
df = result.get_dataframe(no_param_code=True)
return df
[docs]
def regions(
code_insee=None,
ordering=None,
annee=None,
periode="annuel",
):
"""Retourne les indicateurs annuels ou triennaux de prix à l'échelle de la region
Args:
**code_insee (str or list, required)**: Codes des regions. Defaults to None.
**ordering (str, optional)**: Champs à utiliser pour ordonner le résultat. Defaults to None.
**annee (str, optional)**: Année. Defaults to None.
**periode (str, optional)**: Prend la valeur "annuel" ou "triennal". Defaults to annuel.
Returns:
dataframe: données sur les marchés immobiliers
Examples:
>>> import apifoncier.ind_prix as prix
>>> prix.regions(code_insee="32")
>>> prix.regions(code_insee=["32", "11"], annee="2020")
>>> prix.regions(code_insee=["32", "11"], periode="triennal")
"""
if not periode in ("annuel", "triennal"):
raise ValueError("Le paramètre periode doit valoir 'annuel' ou 'triennal'.")
result = utils.Resultat(f"/indicateurs/dv3f/regions/{periode}/", **locals())
df = result.get_dataframe(no_param_code=True)
return df