API docs by Redocly

kelvin API (v2)

Download OpenAPI specification:

Bienvenue dans la documentation de l'API kelvin. Cette API est conçue pour évaluer et améliorer la performance énergétique des propriétés.

API Logo

Aperçu de l'API

L'API kelvin vous permet de créer des simulations pour évaluer la performance énergétique d'un bien immobilier. Elle vous aide également à proposer des plans de travaux personnalisés pour optimiser l'efficacité énergétique de ces biens.

Objectifs Principaux

  • Création de simulations : Lancez des simulations pour obtenir la performance énergétique actuelle d'une propriété.
  • Propositions de travaux : Génération de recommandations de travaux spécifiques pour améliorer l'efficacité énergétique, basées sur les résultats de la simulation.
  • Gestion des DPE : Recherchez et gérez les Diagnostics de Performance Énergétique.

Utilisation de l'iframe de sélection de polygone

Pour créer une simulation, il faut déterminer la latitude, la longitude et l'identifiant d'interopérabilité (ban_id) de la propriété. Une carte interactive est disponible pour faciliter cette tâche: L'iframe de sélection de polygone. Cette carte permet aux utilisateurs de sélectionner visuellement leur propriété sur une carte. Vous pouvez intégrer ce composant dans vos applications en suivant la documentation de l'iframe de sélection de polygone.

Utilisez cette documentation pour explorer les endpoints disponibles, comprendre les paramètres requis, et découvrir comment intégrer efficacement l'API dans votre système.

Rechercher des DPE par clé d'interopérabilité ou par numéro DPE.

Cet endpoint permet de rechercher des DPE par clé d'interopérabilité ou par numéro de DPE.

Fonctionnalités : Il est obligatoire de fournir au moins un des deux paramètres "ban_id" ou "dpe_id".

  • Recherche par clé d'interopérabilité : Il est possible de rechercher les DPE par la clé d'interopérabilité (ban_id) d'une adresse. Par exemple "31157_0790_00009".
  • Recherche par Numéro de DPE : Il est également possible de rechercher un DPE en utilisant son numéro unique. Cela permet de récupérer rapidement les informations d'un DPE spécifique, par exemple "2331E2555868X".

Filtres : En plus des paramètres principaux, cet endpoint permet d'appliquer des filtres supplémentaires :

  • Surface : Filtrer les DPE en fonction de la surface du bien à 10% près.
  • Date du du diagnostic : Filtrer les DPE selon la date à laquelle ils ont été établis.
  • Classe Énergétique : Filtrer par la classe énergétique du DPE.

Réponse : En cas de succès, l'endpoint retourne une liste de DPE correspondant aux critères de recherche spécifiés.

Authorizations:
bearerAuth
query Parameters
dpe_id
string
Example: dpe_id=2331E2555868X
building_type
string
Example: building_type=house

Le type de bâtiment:

  • apartment
  • house
  • building
  • unknown
ban_id
string
Example: ban_id=31157_0790_00009
surface
number
Example: surface=100
report_date
string
Example: report_date=2024-01-01
energy_class
string
Example: energy_class=E

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Lister les simulations

Endpoint pour lister les simulations.

Authorizations:
bearerAuth
query Parameters
status
string
Example: status=with_contact_details

Filtrer les simulations avec des informations de contact:

  • with_contact_details
page
integer
Example: page=1

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Créer une simulation

Endpoint pour créer une simulation à partir d'un ban_id et des coordonnées GPS.

Authorizations:
bearerAuth
Request Body schema: application/json
latitude
required
number
longitude
required
number
ban_id
string

Responses

Request samples

Content type
application/json
{
  • "latitude": 43.53718,
  • "longitude": 1.337797,
  • "ban_id": "31157_0790_00009"
}

Response samples

Content type
application/json
{
  • "simulation_id": "hjjcm1qp28"
}

Récupérer les informations de la propriété

Les informations de la propriété.

Authorizations:
bearerAuth
path Parameters
simulation_id
required
string
Example: hjjcm1qp28

L'identifiant de simulation renvoyé par l'appel au endpoint créer

Responses

Response samples

Content type
application/json
{
  • "status": "completed",
  • "housing": {
    },
  • "address": {
    }
}

Mettre à jour les informations de la propriété

Endpoint pour mettre à jour les informations de la propriété

Authorizations:
bearerAuth
path Parameters
simulation_id
required
string
Example: hjjcm1qp28

L'identifiant de simulation renvoyé par l'appel au endpoint créer

Request Body schema: application/json
dpe_id
string

Le numéro unique du DPE.

housing_type
string

Le type de propriété (house or apartment).

surface
integer

La surface de la propriété en m2. Obligatoire si le housing_type est apartment.

floor_level
string

La position da le propriété dans l'immeuble. Obligatoire si le housing_type est apartment.

number_of_exterior_wall
integer

Le nombre de murs donnant sur l'extérieur. Obligatoire si le housing_type est appartement.

Responses

Request samples

Content type
application/json
{
  • "dpe_id": "2331E2555868X",
  • "housing_type": "house",
  • "surface": 100,
  • "floor_level": "ground",
  • "number_of_exterior_wall": 1
}

Response samples

Content type
application/json
{
  • "error": "Housing type is missing or invalid"
}

Lancer la simulation

Endpoint pour lancer la simulation.

Authorizations:
bearerAuth
path Parameters
simulation_id
required
string
Example: hjjcm1qp28

L'identifiant de simulation renvoyé par l'appel au endpoint créer

Responses

Response samples

Content type
application/json
{
  • "error": "Unauthorized"
}

Récupérer l'état initial

Les informations de l'état initial.

Authorizations:
bearerAuth
path Parameters
simulation_id
required
string
Example: hjjcm1qp28

L'identifiant de simulation renvoyé par l'appel au endpoint créer

Responses

Response samples

Content type
application/json
{
  • "status": "completed",
  • "initial_state": {
    }
}

Mettre à jour l'état initial

Endpoint pour mettre à jour les informations de l'état initial

Authorizations:
bearerAuth
path Parameters
simulation_id
required
string
Example: hjjcm1qp28

L'identifiant de simulation renvoyé par l'appel au endpoint créer

Request Body schema: application/json
housing_type
string
Enum: "house" "apartment"

Type de logement (maison ou appartement).

close_to_historical_monument
boolean

Proximité d'un monument historique.

floor_level
string

Niveau de l'étage (rez-de-chaussée, intermédiaire, dernier étage).

living_area
integer

La surface habitable en mètres carrés.

number_of_exterior_wall
integer

Nombre de murs extérieurs.

house_number_of_levels
integer

Le nombre de niveaux dans la maison.

shared_walls
boolean

Présence de murs mitoyens.

object

L'année de construction du bâtiment.

recently_renovated
Array of strings unique
Items Enum: "windows" "roof" "attic" "walls" "lower_floor" "vents" "generator" "hot_water"

Éléments récemment rénovés.

wall_material
string
Enum: "aggregate" "others" "concrete" "wood" "brick" "millstone" "stone"

Le matériau principal des murs.

high_floor_type
string
Enum: "roof_terrace" "not_heated_space" "office" "apartment" "converted_attic" "lost_attic" "unknown"

Le type de plancher haut.

low_floor_type
string
Enum: "slab_on_grade" "not_heated_space" "office" "apartment" "crawl_space" "unknown"

Le type de plancher bas.

windows
string
Enum: "high_class" "middle_class" "low_class"

Le type de fenêtre.

number_of_windows
integer

Le nombre total de fenêtres.

generator_energy
string
Enum: "gas" "electricity" "fuel" "urban_heating_or_biomass"

Le type d'énergie utilisé par le générateur de chauffage.

generator_type
string
Enum: "boiler" "district_heating_network" "electric" "heat_pump"

Le type d'énergie utilisé par le générateur de chauffage.

hot_water_energy
string
Enum: "gas" "electricity" "fuel" "urban_heating_or_biomass" "wood"

Le type d'énergie utilisé pour l'eau chaude sanitaire.

hot_water_type
string
Enum: "hot_water_tank" "boiler" "water_heater" "heat_pump" "district_heating_network"

Le type de système de production d'eau chaude sanitaire.

has_vents
boolean

Présence d'un système de ventilation.

Responses

Request samples

Content type
application/json
{
  • "housing_type": "apartment",
  • "close_to_historical_monument": true,
  • "floor_level": "ground",
  • "living_area": 120,
  • "number_of_exterior_wall": 3,
  • "house_number_of_levels": 1,
  • "shared_walls": true,
  • "construction_year": {
    },
  • "recently_renovated": [
    ],
  • "wall_material": "brick",
  • "high_floor_type": "roof_terrace",
  • "low_floor_type": "slab_on_grade",
  • "windows": "middle_class",
  • "number_of_windows": 8,
  • "generator_energy": "electricity",
  • "generator_type": "heat_pump",
  • "hot_water_energy": "electricity",
  • "hot_water_type": "heat_pump",
  • "has_vents": true
}

Response samples

Content type
application/json
{
  • "error": "Generator type n'est pas valide"
}

Récupérer l'état projeté

Les informations de l'état projeté.

Authorizations:
bearerAuth
path Parameters
simulation_id
required
string
Example: hjjcm1qp28

L'identifiant de simulation renvoyé par l'appel au endpoint créer

Responses

Response samples

Content type
application/json
{
  • "status": "completed",
  • "projected_state": {
    }
}