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
def conso(
    self,
    code: str,
    echelle: str,
    annee: Optional[int] = None,
    annee_min: Optional[int] = None,
    annee_max: Optional[int] = None,
    ordering: Optional[str] = None,
    page: Optional[int] = None,
    page_size: Optional[int] = 500,
    paginate: bool = True,
    format_output: str = "dataframe",
) -> Union[pd.DataFrame, List[dict]]:
    """
    Renvoie les indicateurs de consommation d'espace pour la période comprise entre annee_min et annee_max, bornes incluses.

    Args:
        code (str, obligatoire): Code INSEE communal ou départemental.
        echelle (str, obligatoire): 'communes' ou 'departements'.
        annee (int, optionnel): Année spécifique.
        annee_min (int, optionnel): Année minimale.
        annee_max (int, optionnel): Année maximale.
        ordering (str, optionnel): Champ de tri.
        page (int, optionnel): Page de résultats.
        page_size (int, optionnel): Nombre de résultats par page.
        paginate (bool, optionnel): Pagination automatique.
        format_output (str, optionnel): 'dataframe' ou 'dict'.
        fields (str, optionnel): 'all' pour obtenir tous les champs, None sinon.

    Returns:
        DataFrame ou liste de dictionnaires avec les indicateurs de consommation d'espace.
    """
    if not code:
        raise ValidationError("Le paramètre 'code' est obligatoire")
    if echelle not in ["communes", "departements"]:
        raise ValidationError("L'échelle doit être 'communes' ou 'departements'")

    params = self._build_params(
        annee=annee,
        annee_min=annee_min,
        annee_max=annee_max,
        ordering=ordering,
        page=page,
        page_size=page_size,
    )

    return self._fetch(
        endpoint=f"/indicateurs/conso_espace/{echelle}/{code}",
        params=params,
        format_output=format_output,
        geo=False,
        paginate=paginate,
    )

Exemples d'utilisation

  • Consommation d'espace pour une commune :
    client.indicateurs.conso(code="59001", echelle="communes")
    
  • Consommation d'espace pour un département :
    client.indicateurs.conso(code="62", echelle="departements")
    
  • Consommation d'espace sur une période :
    client.indicateurs.conso(code="59001", echelle="communes", annee_min=2015, annee_max=2022)
    
  • Consommation d'espace avec tri :
    client.indicateurs.conso(code="59001", echelle="communes", ordering="-annee")
    

📂 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
def accessibilite(
    self,
    codes_aav: Union[str, List[str]],
    annee: Optional[str] = None,
    ordering: Optional[str] = None,
    page: Optional[int] = None,
    page_size: Optional[int] = 500,
    paginate: bool = True,
    format_output: str = "dataframe",
) -> Union[pd.DataFrame, List[dict]]:
    """
    Retourne les indicateurs d'accessibilité financière tri-annuels issus de DV3F.

    Args:
        codes_aav (str ou List[str], obligatoire): Code(s) INSEE d'une aire d'attraction des villes (max 10).
        annee (str, optionnel): Année.
        ordering (str, optionnel): Champ de tri.
        page (int, optionnel): Page de résultats.
        page_size (int, optionnel): Nombre de résultats par page.
        paginate (bool, optionnel): Pagination automatique.
        format_output (str, optionnel): 'dataframe' ou 'dict'.
        fields (str, optionnel): 'all' pour obtenir tous les champs, None sinon.

    Returns:
        DataFrame ou liste de dictionnaires avec les indicateurs d'accessibilité.
    """
    if not codes_aav:
        raise ValidationError("Le paramètre 'codes_aav' est obligatoire")

    processed_codes = self._process_codes(codes_aav, max_codes=10)

    params = self._build_params(
        code=processed_codes,
        annee=annee,
        ordering=ordering,
        page=page,
        page_size=page_size,
    )

    return self._fetch(
        endpoint="/indicateurs/dv3f/accessibilite",
        params=params,
        format_output=format_output,
        geo=False,
        paginate=paginate,
    )

Exemples d'utilisation

  • Accessibilité pour une AAV :
    client.indicateurs.accessibilite(codes_aav="001")
    
  • Accessibilité pour plusieurs AAV :
    client.indicateurs.accessibilite(codes_aav=["004", "005"])
    
  • Accessibilité pour une année donnée :
    client.indicateurs.accessibilite(codes_aav="004", annee="2021")
    

📂 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
def activite(
    self,
    codes: Union[str, List[str]],
    echelle: str,
    annee: Optional[str] = None,
    ordering: Optional[str] = None,
    page: Optional[int] = None,
    page_size: Optional[int] = 500,
    paginate: bool = True,
    format_output: str = "dataframe",
) -> Union[pd.DataFrame, List[dict]]:
    """
    Renvoie les indicateurs d'activité du marché tri-annuels issus de DV3F.

    Args:
        codes (str ou List[str], obligatoire): Code(s) INSEE géographique(s) associé(s) à l'échelle (max 10).
        echelle (str, obligatoire): 'communes', 'epci', 'aav', 'departements', 'regions', 'france'.
        annee (str, optionnel): Année centrale de la période de 3 ans.
        ordering (str, optionnel): Champ de tri.
        page (int, optionnel): Page de résultats.
        page_size (int, optionnel): Nombre de résultats par page.
        paginate (bool, optionnel): Pagination automatique.
        format_output (str, optionnel): 'dataframe' ou 'dict'.
        fields (str, optionnel): 'all' pour obtenir tous les champs, None sinon.

    Returns:
        DataFrame ou liste de dictionnaires avec les indicateurs d'activité.
    """
    if not codes:
        raise ValidationError("Le paramètre 'codes' est obligatoire")
    if not echelle:
        raise ValidationError("Le paramètre 'echelle' est obligatoire")

    echelles_valides = [
        "communes",
        "epci",
        "aav",
        "departements",
        "regions",
        "france",
    ]
    if echelle not in echelles_valides:
        raise ValidationError(
            f"L'échelle doit être parmi : {', '.join(echelles_valides)}"
        )

    processed_codes = self._process_codes(codes, max_codes=10)

    params = self._build_params(
        code=processed_codes,
        echelle=echelle,
        annee=annee,
        ordering=ordering,
        page=page,
        page_size=page_size,
    )

    return self._fetch(
        endpoint="/indicateurs/dv3f/activite",
        params=params,
        format_output=format_output,
        geo=False,
        paginate=paginate,
    )

Exemples d'utilisation

  • Activité pour une commune :
    client.indicateurs.activite(codes="59001", echelle="communes")
    
  • Activité pour un EPCI :
    client.indicateurs.activite(codes="243500139", echelle="epci")
    
  • Activité pour plusieurs codes :
    client.indicateurs.activite(codes=["59001", "59002"], echelle="communes")
    

📂 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
def prix(
    self,
    codes: Union[str, List[str]],
    echelle: str,
    type_prix: str = "annuel",
    annee: Optional[str] = None,
    ordering: Optional[str] = None,
    page: Optional[int] = None,
    page_size: Optional[int] = 500,
    paginate: bool = True,
    format_output: str = "dataframe",
) -> Union[pd.DataFrame, List[dict]]:
    """
    Renvoie les indicateurs de prix et de volume annuels ou tri-annuels issus de DV3F.

    Args:
        codes (str ou List[str], obligatoire): Code(s) INSEE géographique(s) associé(s) à l'échelle (max 10).
        echelle (str, obligatoire): 'communes', 'epci', 'aav', 'departements', 'regions', 'france'.
        type_prix (str, optionnel): 'annuel' ou 'triennal'.
        annee (str, optionnel): Année de mutation ou centrale pour triennal.
        ordering (str, optionnel): Champ de tri.
        page (int, optionnel): Page de résultats.
        page_size (int, optionnel): Nombre de résultats par page.
        paginate (bool, optionnel): Pagination automatique.
        format_output (str, optionnel): 'dataframe' ou 'dict'.
        fields (str, optionnel): 'all' pour obtenir tous les champs, None sinon.

    Returns:
        DataFrame ou liste de dictionnaires avec les indicateurs de prix.
    """
    if not codes:
        raise ValidationError("Le paramètre 'codes' est obligatoire")
    if not echelle:
        raise ValidationError("Le paramètre 'echelle' est obligatoire")
    if type_prix not in ["annuel", "triennal"]:
        raise ValidationError("Le type_prix doit être 'annuel' ou 'triennal'")

    echelles_valides = [
        "communes",
        "epci",
        "aav",
        "departements",
        "regions",
        "france",
    ]
    if echelle not in echelles_valides:
        raise ValidationError(
            f"L'échelle doit être parmi : {', '.join(echelles_valides)}"
        )

    processed_codes = self._process_codes(codes, max_codes=10)

    params = self._build_params(
        code=processed_codes,
        echelle=echelle,
        annee=annee,
        ordering=ordering,
        page=page,
        page_size=page_size,
    )

    return self._fetch(
        endpoint=f"/indicateurs/dv3f/prix/{type_prix}",
        params=params,
        format_output=format_output,
        geo=False,
        paginate=paginate,
    )

Exemples d'utilisation

  • Prix annuel pour une commune :
    client.indicateurs.prix(codes="59001", echelle="communes", type_prix="annuel")
    
  • Prix triennal pour un département :
    client.indicateurs.prix(codes="62", echelle="departements", type_prix="triennal")
    
  • Prix avec tri et année :
    client.indicateurs.prix(codes=["59350", "59009"], echelle="communes", ordering="-annee")
    

📂 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
def valorisation(
    self,
    code: str,
    echelle: str,
    annee: Optional[str] = None,
    ordering: Optional[str] = None,
    page: Optional[int] = None,
    page_size: Optional[int] = 500,
    paginate: bool = True,
    format_output: str = "dataframe",
) -> Union[pd.DataFrame, List[dict]]:
    """
    Renvoie les indicateurs tri-annuels de valorisation d'une commune dans son AAV ou EPCI issus de DV3F.

    Args:
        code (str, obligatoire): Code INSEE de l'AAV ou de l'EPCI.
        echelle (str, obligatoire): 'aav' ou 'epci'.
        annee (str, optionnel): Année centrale de la période de 3 ans.
        ordering (str, optionnel): Champ de tri.
        page (int, optionnel): Page de résultats.
        page_size (int, optionnel): Nombre de résultats par page.
        paginate (bool, optionnel): Pagination automatique.
        format_output (str, optionnel): 'dataframe' ou 'dict'.
        fields (str, optionnel): 'all' pour obtenir tous les champs, None sinon.

    Returns:
        DataFrame ou liste de dictionnaires avec les indicateurs de valorisation.
    """
    if not code:
        raise ValidationError("Le paramètre 'code' est obligatoire")
    if echelle not in ["aav", "epci"]:
        raise ValidationError("L'échelle doit être 'aav' ou 'epci'")

    params = self._build_params(
        annee=annee,
        ordering=ordering,
        page=page,
        page_size=page_size,
    )

    return self._fetch(
        endpoint=f"/indicateurs/dv3f/valorisation/{echelle}/{code}",
        params=params,
        format_output=format_output,
        geo=False,
        paginate=paginate,
    )

Exemples d'utilisation

  • Valorisation pour une AAV :
    client.indicateurs.valorisation(code="004", echelle="aav")
    
  • Valorisation pour un EPCI :
    client.indicateurs.valorisation(code="243500139", echelle="epci")
    
  • Valorisation pour une année donnée :
    client.indicateurs.valorisation(code="005", echelle="aav", annee="2021")
    

Paramètres d’affichage

Choisissez un thème pour personnaliser l’apparence du site.