Skip to content
Apihom Partner API

Calculer avec travaux

POST
/partners/dpe/calc
 
curl --request POST \
  --url https://api-demo.apihom.com/partners/dpe/calc \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "dpeId": "2575E3361224X", "customerId": "client-123", "userId": "user-456", "userName": "Jean Dupont", "customerName": "Agence Immobilière XYZ", "params": { "editablesChanges": [ { "referenceId": "mur:0", "editableKey": "ISOLATION", "editableValue": "IMurCC14" }, { "referenceId": "baie_vitree:0", "editableKey": "FENETRE", "editableValue": "PVC" } ] } }'

Recalcule le DPE avec les travaux sélectionnés (changement de chauffage, isolation, etc.).

Les editablesChanges décrivent les modifications à appliquer. Chaque entrée spécifie un élément du DPE (referenceId) et la valeur cible (editableValue).

Authorizations

Section titled “Authorizations ”

Request Body required

Section titled “Request Body required ”
Media type application/json
object
dpeId
required
string
/^[0-9]{4}E[0-9]{7}[A-Z]$/
customerId
required
string
userId
required
string
userName
required
string
customerName
required
string
query
object
coef2026

Mode coefficient 2026 (1.9) ou 2025 (2.3)

string
Allowed values: activated desactivated
forceNormalization

Forcer la normalisation pour les écarts entre 5% et 15%

boolean
expireInMinutes

Durée de validité du token de connexion

integer
>= 1
params
object
editablesChanges

Liste des travaux à appliquer

Array<object>
object
referenceId
required

Identifiant de l’élément (ex: mur:0, baie_vitree:1)

string
editableKey
required

Type de modification (ex: ISOLATION, FENETRE, ReplaceGEN)

string
editableValue
required

Valeur cible (ex: IMurCC14, PVC, PACAirEauECS)

string
namedCalculation

ID du scénario (défaut : ‘default’)

string
query
object
includeDPE

Inclure le DPE complet dans la réponse

boolean
includeUser

Inclure les infos utilisateur

boolean
coef2026
string
Allowed values: activated desactivated
Example 
{
  "dpeId": "2575E3361224X",
  "customerId": "client-123",
  "userId": "user-456",
  "userName": "Jean Dupont",
  "customerName": "Agence Immobilière XYZ",
  "params": {
    "editablesChanges": [
      {
        "referenceId": "mur:0",
        "editableKey": "ISOLATION",
        "editableValue": "IMurCC14"
      },
      {
        "referenceId": "baie_vitree:0",
        "editableKey": "FENETRE",
        "editableValue": "PVC"
      }
    ]
  }
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Calcul effectué

Media type application/json
object
calculation

Résultat d’un calcul DPE

object
result

Valeurs de performance énergétique

object
classe_bilan_dpe

Classe finale DPE (A à G)

object
value
One of:
number
VInit
One of:
number
VXML
One of:
number
title

Libellé du champ

string
value_display

URL de l’image de la classe (SVG)

string
value_info

Information complémentaire sur la valeur

string
classe_conso_c

Classe consommation

object
value
One of:
number
VInit
One of:
number
VXML
One of:
number
title

Libellé du champ

string
value_display

URL de l’image de la classe (SVG)

string
value_info

Information complémentaire sur la valeur

string
classe_emission_ges

Classe émissions GES

object
value
One of:
number
VInit
One of:
number
VXML
One of:
number
title

Libellé du champ

string
value_display

URL de l’image de la classe (SVG)

string
value_info

Information complémentaire sur la valeur

string
ep_conso_5_usages

Consommation énergétique totale (kWh/an)

object
value
One of:
number
VInit
One of:
number
VXML
One of:
number
title

Libellé du champ

string
value_display

URL de l’image de la classe (SVG)

string
value_info

Information complémentaire sur la valeur

string
ep_conso_5_usages_m2

Consommation par m² (kWh/m²/an)

object
value
One of:
number
VInit
One of:
number
VXML
One of:
number
title

Libellé du champ

string
value_display

URL de l’image de la classe (SVG)

string
value_info

Information complémentaire sur la valeur

string
emission_ges_5_usages

Émissions GES totales (kg CO2e/an)

object
value
One of:
number
VInit
One of:
number
VXML
One of:
number
title

Libellé du champ

string
value_display

URL de l’image de la classe (SVG)

string
value_info

Information complémentaire sur la valeur

string
emission_ges_5_usages_m2

Émissions GES par m² (kg CO2e/m²/an)

object
value
One of:
number
VInit
One of:
number
VXML
One of:
number
title

Libellé du champ

string
value_display

URL de l’image de la classe (SVG)

string
value_info

Information complémentaire sur la valeur

string
perte_surface_m2

Perte de surface due aux travaux (m²)

object
value
One of:
number
VInit
One of:
number
VXML
One of:
number
title

Libellé du champ

string
value_display

URL de l’image de la classe (SVG)

string
value_info

Information complémentaire sur la valeur

string
cout_5_usages

Coût annuel des 5 usages

object
value
One of:
number
VInit
One of:
number
VXML
One of:
number
title

Libellé du champ

string
value_display

URL de l’image de la classe (SVG)

string
value_info

Information complémentaire sur la valeur

string
hints

Indicateurs de performance des travaux

object
economieAnnuelle

Économie annuelle en euros

number
gainTotal

Gain total en kWh/an

number
gainM2

Gain par m² en kWh/m²/an

number
gainGESM2

Gain GES par m² en kg CO2e/m²/an

number
nextNoteDeltaM2

KWh/m² restants pour atteindre la classe suivante

number
percentDeltaSeuil

Marge en % par rapport au seuil de la classe suivante

number
perteSurfaceTotal

Perte de surface totale (m²)

number
coutTravaux

Coût total des travaux sélectionnés (euros)

number
retourSurInvestissementAnnees

Retour sur investissement (années)

number
error

Message d’erreur (null si pas d’erreur)

string | null
editableChanges
object
editablesValues
Array<object>
object
referenceId
required

Identifiant de l’élément (ex: mur:0, baie_vitree:1)

string
editableKey
required

Type de modification (ex: ISOLATION, FENETRE, ReplaceGEN)

string
editableValue
required

Valeur cible (ex: IMurCC14, PVC, PACAirEauECS)

string
namedCalculation
string
namedCalculationTitle
string
simulation

Métadonnées de la simulation

object
simulationId

Identifiant unique de la simulation

string
dpeId
string
initialDPEGrade

Note DPE initiale

number
actualDPEGrade

Note DPE actuelle (après travaux)

number
date
string format: date-time
sharingInfo
object
cost
integer
deltaCosts
object
margin
number
delta
number
source
string
dpe

DPE complet (présent si query.includeDPE activé)

object
id
string
infos

Informations générales du DPE

object
ref
object
text
string
value
string
surface
object
text
string
value
number
type_bien
object
text
string
value
string
zone_climatique
object
value
string
adresse_rue
object
value
string
adresse_cp
object
value
string
adresse_ville
object
value
string
items

Éléments du DPE par catégorie (mur, baie_vitree, plancher_bas, etc.)

object
mur
Array<object>

Élément du DPE (mur, fenêtre, chauffage, etc.)

object
type
string
referenceId
string
description
string
infos

Informations techniques de l’élément

object
editables

Options de travaux disponibles pour cet élément

object
key
additional properties
object
name

Nom de l’option

string
type
string
Allowed values: enum info
data

Valeurs possibles (clé = valeur technique, valeur = libellé)

object
coutsGains

Coûts et gains par option

object
key
additional properties
object
gain

Gain en kWh/an

number
gainGESM2

Gain GES en kg CO2e/m²/an

number
cout

Coût estimé des travaux (euros)

number
coutGain

Ratio coût/gain (euros par kWh économisé)

number
baie_vitree
Array<object>

Élément du DPE (mur, fenêtre, chauffage, etc.)

object
type
string
referenceId
string
description
string
infos

Informations techniques de l’élément

object
editables

Options de travaux disponibles pour cet élément

object
key
additional properties
object
name

Nom de l’option

string
type
string
Allowed values: enum info
data

Valeurs possibles (clé = valeur technique, valeur = libellé)

object
coutsGains

Coûts et gains par option

object
key
additional properties
object
gain

Gain en kWh/an

number
gainGESM2

Gain GES en kg CO2e/m²/an

number
cout

Coût estimé des travaux (euros)

number
coutGain

Ratio coût/gain (euros par kWh économisé)

number
plancher_bas
Array<object>

Élément du DPE (mur, fenêtre, chauffage, etc.)

object
type
string
referenceId
string
description
string
infos

Informations techniques de l’élément

object
editables

Options de travaux disponibles pour cet élément

object
key
additional properties
object
name

Nom de l’option

string
type
string
Allowed values: enum info
data

Valeurs possibles (clé = valeur technique, valeur = libellé)

object
coutsGains

Coûts et gains par option

object
key
additional properties
object
gain

Gain en kWh/an

number
gainGESM2

Gain GES en kg CO2e/m²/an

number
cout

Coût estimé des travaux (euros)

number
coutGain

Ratio coût/gain (euros par kWh économisé)

number
plancher_haut
Array<object>

Élément du DPE (mur, fenêtre, chauffage, etc.)

object
type
string
referenceId
string
description
string
infos

Informations techniques de l’élément

object
editables

Options de travaux disponibles pour cet élément

object
key
additional properties
object
name

Nom de l’option

string
type
string
Allowed values: enum info
data

Valeurs possibles (clé = valeur technique, valeur = libellé)

object
coutsGains

Coûts et gains par option

object
key
additional properties
object
gain

Gain en kWh/an

number
gainGESM2

Gain GES en kg CO2e/m²/an

number
cout

Coût estimé des travaux (euros)

number
coutGain

Ratio coût/gain (euros par kWh économisé)

number
installation_chauffage
Array<object>

Élément du DPE (mur, fenêtre, chauffage, etc.)

object
type
string
referenceId
string
description
string
infos

Informations techniques de l’élément

object
editables

Options de travaux disponibles pour cet élément

object
key
additional properties
object
name

Nom de l’option

string
type
string
Allowed values: enum info
data

Valeurs possibles (clé = valeur technique, valeur = libellé)

object
coutsGains

Coûts et gains par option

object
key
additional properties
object
gain

Gain en kWh/an

number
gainGESM2

Gain GES en kg CO2e/m²/an

number
cout

Coût estimé des travaux (euros)

number
coutGain

Ratio coût/gain (euros par kWh économisé)

number
installation_ecs
Array<object>

Élément du DPE (mur, fenêtre, chauffage, etc.)

object
type
string
referenceId
string
description
string
infos

Informations techniques de l’élément

object
editables

Options de travaux disponibles pour cet élément

object
key
additional properties
object
name

Nom de l’option

string
type
string
Allowed values: enum info
data

Valeurs possibles (clé = valeur technique, valeur = libellé)

object
coutsGains

Coûts et gains par option

object
key
additional properties
object
gain

Gain en kWh/an

number
gainGESM2

Gain GES en kg CO2e/m²/an

number
cout

Coût estimé des travaux (euros)

number
coutGain

Ratio coût/gain (euros par kWh économisé)

number
ventilation
Array<object>

Élément du DPE (mur, fenêtre, chauffage, etc.)

object
type
string
referenceId
string
description
string
infos

Informations techniques de l’élément

object
editables

Options de travaux disponibles pour cet élément

object
key
additional properties
object
name

Nom de l’option

string
type
string
Allowed values: enum info
data

Valeurs possibles (clé = valeur technique, valeur = libellé)

object
coutsGains

Coûts et gains par option

object
key
additional properties
object
gain

Gain en kWh/an

number
gainGESM2

Gain GES en kg CO2e/m²/an

number
cout

Coût estimé des travaux (euros)

number
coutGain

Ratio coût/gain (euros par kWh économisé)

number
porte
Array<object>

Élément du DPE (mur, fenêtre, chauffage, etc.)

object
type
string
referenceId
string
description
string
infos

Informations techniques de l’élément

object
editables

Options de travaux disponibles pour cet élément

object
key
additional properties
object
name

Nom de l’option

string
type
string
Allowed values: enum info
data

Valeurs possibles (clé = valeur technique, valeur = libellé)

object
coutsGains

Coûts et gains par option

object
key
additional properties
object
gain

Gain en kWh/an

number
gainGESM2

Gain GES en kg CO2e/m²/an

number
cout

Coût estimé des travaux (euros)

number
coutGain

Ratio coût/gain (euros par kWh économisé)

number
warnings
Array<object>
object
id

Identifiant unique de l’alerte

string
type
  • block : Erreur bloquante, le DPE ne peut pas être traité
  • confirm : Normalisation recommandée, l’utilisateur doit confirmer
  • warning : Information, pas bloquant
string
Allowed values: block confirm warning
title
string
content
string
seuils

Seuils DPE/CO2 pour cette surface et zone climatique

object
Example 
{
  "calculation": {
    "result": {
      "classe_bilan_dpe": {
        "value": 245.3,
        "VInit": 380.5,
        "title": "Consommation totale m2"
      },
      "classe_conso_c": {
        "value": 245.3,
        "VInit": 380.5,
        "title": "Consommation totale m2"
      },
      "classe_emission_ges": {
        "value": 245.3,
        "VInit": 380.5,
        "title": "Consommation totale m2"
      },
      "ep_conso_5_usages": {
        "value": 245.3,
        "VInit": 380.5,
        "title": "Consommation totale m2"
      },
      "ep_conso_5_usages_m2": {
        "value": 245.3,
        "VInit": 380.5,
        "title": "Consommation totale m2"
      },
      "emission_ges_5_usages": {
        "value": 245.3,
        "VInit": 380.5,
        "title": "Consommation totale m2"
      },
      "emission_ges_5_usages_m2": {
        "value": 245.3,
        "VInit": 380.5,
        "title": "Consommation totale m2"
      },
      "perte_surface_m2": {
        "value": 245.3,
        "VInit": 380.5,
        "title": "Consommation totale m2"
      },
      "cout_5_usages": {
        "value": 245.3,
        "VInit": 380.5,
        "title": "Consommation totale m2"
      }
    },
    "hints": {
      "economieAnnuelle": 450.5,
      "gainTotal": 12500,
      "gainM2": 68.3,
      "gainGESM2": 12.5,
      "perteSurfaceTotal": 0,
      "coutTravaux": 15400,
      "retourSurInvestissementAnnees": 34.2
    }
  },
  "editableChanges": {
    "editablesValues": [
      {
        "referenceId": "mur:0",
        "editableKey": "ISOLATION",
        "editableValue": "IMurCC14"
      }
    ]
  },
  "namedCalculation": "default",
  "namedCalculationTitle": "Projection 1",
  "simulation": {
    "dpeId": "2575E3361224X"
  },
  "dpe": {
    "id": "2575E3361224X",
    "infos": {
      "ref": {
        "value": "ADEME 2575E3361224X"
      },
      "surface": {
        "value": 18.26
      },
      "type_bien": {
        "value": "Appartement"
      },
      "zone_climatique": {
        "value": "h2a"
      }
    },
    "items": {
      "mur": [
        {
          "type": "mur",
          "referenceId": "mur:0",
          "description": "Mur Nord - Béton",
          "editables": {
            "additionalProperty": {
              "type": "enum"
            }
          }
        }
      ],
      "baie_vitree": [
        {
          "type": "mur",
          "referenceId": "mur:0",
          "description": "Mur Nord - Béton",
          "editables": {
            "additionalProperty": {
              "type": "enum"
            }
          }
        }
      ],
      "plancher_bas": [
        {
          "type": "mur",
          "referenceId": "mur:0",
          "description": "Mur Nord - Béton",
          "editables": {
            "additionalProperty": {
              "type": "enum"
            }
          }
        }
      ],
      "plancher_haut": [
        {
          "type": "mur",
          "referenceId": "mur:0",
          "description": "Mur Nord - Béton",
          "editables": {
            "additionalProperty": {
              "type": "enum"
            }
          }
        }
      ],
      "installation_chauffage": [
        {
          "type": "mur",
          "referenceId": "mur:0",
          "description": "Mur Nord - Béton",
          "editables": {
            "additionalProperty": {
              "type": "enum"
            }
          }
        }
      ],
      "installation_ecs": [
        {
          "type": "mur",
          "referenceId": "mur:0",
          "description": "Mur Nord - Béton",
          "editables": {
            "additionalProperty": {
              "type": "enum"
            }
          }
        }
      ],
      "ventilation": [
        {
          "type": "mur",
          "referenceId": "mur:0",
          "description": "Mur Nord - Béton",
          "editables": {
            "additionalProperty": {
              "type": "enum"
            }
          }
        }
      ],
      "porte": [
        {
          "type": "mur",
          "referenceId": "mur:0",
          "description": "Mur Nord - Béton",
          "editables": {
            "additionalProperty": {
              "type": "enum"
            }
          }
        }
      ]
    },
    "warnings": [
      {
        "type": "block"
      }
    ]
  }
}

400

Section titled “400 ”

Requête invalide

Media type application/json
object
error

Message d’erreur

string
errorObject

Détails supplémentaires (optionnel)

object
Example 
{
  "error": "Demande non valide: dpeId is required"
}

401

Section titled “401 ”

Non autorisé — clé partenaire invalide ou manquante

Media type application/json
object
error

Message d’erreur

string
errorObject

Détails supplémentaires (optionnel)

object
Example 
{
  "error": "Unauthorized"
}