Kelvin Simulations API

openapi: 3.2.0
info:
  title: Kelvin Simulations API
  version: '1.0'
  description: 'Operations tagged Simulations across 2 of this provider''s published API definitions: kelvin-api-openapi.yml, kelvin-api-v2-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: '{protocol}://{defaultHost}'
  variables:
    protocol:
      default: https
    defaultHost:
      default: app.go-kelvin.com
security:
- bearerAuth: []
tags:
- name: Simulations
paths:
  /api/v3/simulations:
    get:
      summary: Lister les simulations
      description: Endpoint pour lister les simulations.
      security:
      - bearerAuth: []
      parameters:
      - name: status
        in: query
        required: false
        example: with_contact_details
        description: "Filtrer les simulations avec des informations de contact:\n * `with_contact_details` \n "
        schema:
          type: string
          enum:
          - with_contact_details
      - name: page
        in: query
        required: false
        example: 1
        schema:
          type: integer
      responses:
        '200':
          description: successful
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          example: 1fh9vrmd2c
                          description: L'identifiant de la simulation
                        created_at:
                          type: string
                          format: date-time
                          example: '2024-10-08T10:00:54Z'
                          description: La date de création de la simulation
                        simulation_url:
                          type: string
                          format: uri
                          example: https://app.go-kelvin.com/simulator/4732fnd4mt/simulations/1fh9vrmd2c
                          description: L'adresse web du résultat de la simulation
                        team_id:
                          type: string
                          example: 4732fnd4mt
                          description: L'identifiant de l'équipe
                        source:
                          type: string
                          enum:
                          - simulator
                          - qualification
                          - api
                          - prospection
                          example: api
                          description: La source de la simulation
                        tracking_context:
                          type: object
                          description: Les informations de tracking extraites du contexte de lancement de la simulation
                          properties:
                            utm_source:
                              type:
                              - string
                              - 'null'
                            utm_medium:
                              type:
                              - string
                              - 'null'
                            utm_campaign:
                              type:
                              - string
                              - 'null'
                            utm_content:
                              type:
                              - string
                              - 'null'
                            utm_term:
                              type:
                              - string
                              - 'null'
                            gad_source:
                              type:
                              - string
                              - 'null'
                            gclid:
                              type:
                              - string
                              - 'null'
                            fbclid:
                              type:
                              - string
                              - 'null'
                            cuid:
                              type:
                              - string
                              - 'null'
                            referer:
                              type:
                              - string
                              - 'null'
                            gbraid:
                              type:
                              - string
                              - 'null'
                            msclkid:
                              type:
                              - string
                              - 'null'
                            krid:
                              type:
                              - string
                              - 'null'
                            krsrc:
                              type:
                              - string
                              - 'null'
                            ksid:
                              type:
                              - string
                              - 'null'
                        client:
                          type: object
                          description: Les informations du client
                          properties:
                            first_name:
                              type:
                              - string
                              - 'null'
                              example: Jean
                              description: Le prénom du client
                            last_name:
                              type:
                              - string
                              - 'null'
                              example: Dupont
                              description: Le nom de famille du client
                            email:
                              type:
                              - string
                              - 'null'
                              example: jean.dupont@example.com
                              description: L'email du client
                            phone_number:
                              type:
                              - string
                              - 'null'
                              example: '+33600112233'
                              description: Le téléphone du client
                            profile:
                              type:
                              - string
                              - 'null'
                              enum:
                              - owner_resident
                              - owner_non_resident
                              - renter
                              - lessor
                              - null
                              example: owner_resident
                              description: Le profil de l'utilisateur.
                            primary_residence:
                              type:
                              - boolean
                              - 'null'
                              example: true
                              description: Indique si c'est une résidence principale.
                            household_size:
                              type:
                              - number
                              - 'null'
                              example: 4
                              description: Nombre de personnes dans le foyer.
                            tax_residence_department:
                              type:
                              - string
                              - 'null'
                              example: '75'
                              description: Département de résidence fiscale.
                            income_range:
                              type:
                              - string
                              - 'null'
                              enum:
                              - very_modest
                              - modest
                              - intermediate
                              - superior
                              - null
                              example: modest
                              description: La tranche de revenus du foyer.
                            project_maturity:
                              type:
                              - string
                              - 'null'
                              enum:
                              - curious
                              - searching
                              - signed
                              - estimated
                              - null
                              example: curious
                              description: Maturité du projet.
                        housing:
                          type: object
                          description: Les informations du logement (type, latitude, longitude, adresse, adresse détaillée, BAN, lien Google Maps)
                          properties:
                            kind:
                              type:
                              - string
                              - 'null'
                              enum:
                              - apartment
                              - house
                              - null
                              description: Le type de logement
                            latitude:
                              type: number
                              format: float
                              example: 48.8487743
                              description: La latitude des coordonnées GPS du logement
                            longitude:
                              type: number
                              format: float
                              example: 2.328388
                              description: La longitude des coordonnées GPS du logement
                            address:
                              type:
                              - string
                              - 'null'
                              example: 10 rue du Regard, 75006, Paris
                              description: L'adresse du logement
                            address_parts:
                              type: object
                              description: Les parties de l'adresse du logement (numéro, rue, ville, code postal, pays, latitude, longitude)
                              properties:
                                street_number:
                                  type: string
                                  example: '10'
                                  description: Le numéro de la rue
                                address_line_1:
                                  type: string
                                  example: rue du Regard
                                  description: La rue
                                address_line_2:
                                  type:
                                  - string
                                  - 'null'
                                  example: Appartement 2
                                  description: Le complément d'adresse
                                city:
                                  type: string
                                  example: Paris
                                  description: La ville
                                postal_code:
                                  type: string
                                  example: '75006'
                                  description: Le code postal
                                country_number:
                                  type: integer
                                  example: 250
                                  description: Le code pays (ISO 3166-1 alpha-3)
                                latitude:
                                  type: number
                                  format: float
                                  example: 48.8487743
                                  description: La latitude des coordonnées GPS du logement
                                longitude:
                                  type: number
                                  format: float
                                  example: 2.328388
                                  description: La longitude des coordonnées GPS du logement
                            ban_id:
                              type:
                              - string
                              - 'null'
                              example: '75106_8092_00010'
                              description: L'identifiant BAN du logement
                            google_maps_link:
                              type: string
                              example: https://maps.google.com/
                              description: Le lien Google Maps du logement
                        initial_state:
                          type: object
                          properties:
                            overall_rating:
                              type: string
                              enum:
                              - A
                              - B
                              - C
                              - D
                              - E
                              - F
                              - G
                              example: B
                              description: La lettre DPE globale (la plus défavorable entre énergie et GES).
                            energy_rating:
                              type: string
                              enum:
                              - A
                              - B
                              - C
                              - D
                              - E
                              - F
                              - G
                              example: B
                              description: La lettre énergie
                            energy_consumption:
                              type: integer
                              example: 201
                              description: La consommation énergétique en kWh/m²/an.
                            carbon_rating:
                              type: string
                              enum:
                              - A
                              - B
                              - C
                              - D
                              - E
                              - F
                              - G
                              example: C
                              description: La lettre GES
                            carbon_emissions:
                              type: integer
                              example: 40
                              description: Les émissions de gaz à effet de serre en kg CO2/m²/an.
                            epc_id:
                              type:
                              - string
                              - 'null'
                              example: 2169E0063000A
                              description: Le numéro du DPE s'il y a un DPE attaché à la simulation.
                            confidence_score:
                              type: number
                              format: float
                              example: 0.85
                              description: Le score de confiance concernant la lettre du DPE.
                            annual_energy_cost_range:
                              type: object
                              properties:
                                min:
                                  type: integer
                                  example: 500
                                  description: '[Déprécié] Le minimum du prix annuel estimé de chauffage.'
                                max:
                                  type: number
                                  format: float
                                  example: 1200
                                  description: '[Déprécié] Le maximum du prix annuel estimé de chauffage.'
                            annual_energy_consumption:
                              type: integer
                              example: 150
                              description: La consommation énergétique annuelle exprimée en kWh/m²/an.
                            position_percentage_neighborhood:
                              type: number
                              format: float
                              example: 0.75
                              description: Le pourcentage de logements du quartier qui consomment plus que le logement en question.
                            energy_loss_percentage:
                              type: object
                              properties:
                                walls:
                                  type: number
                                  format: float
                                  example: 0.15
                                  description: Le pourcentage de perte d'énergie des murs.
                                openings:
                                  type: number
                                  format: float
                                  example: 0.2
                                  description: Le pourcentage de perte d'énergie des ouvrants.
                                low_floor:
                                  type: number
                                  format: float
                                  example: 0.3
                                  description: Le pourcentage de perte d'énergie des planchers bas.
                                high_floor:
                                  type: number
                                  format: float
                                  example: 0.35
                                  description: Le pourcentage de perte d'énergie des plafonds.
                            close_to_historical_monument:
                              type: boolean
                              example: false
                              description: Proximité d'un monument historique.
                            living_area:
                              type: number
                              example: 120
                              description: La surface habitable en mètres carrés.
                            exterior_walls_surface:
                              type: integer
                              example: 100
                              description: La surface extérieure des murs en mètres carrés.
                            house_number_of_levels:
                              type: integer
                              example: 1
                              description: Le nombre de niveaux dans la maison.
                            shared_walls:
                              type: boolean
                              example: true
                              description: Présence de murs mitoyens.
                            wall_material:
                              type: string
                              enum:
                              - lightweight_concrete
                              - insulating_concrete
                              - stone
                              - brick
                              - hollow_or_perforated_bricks
                              - wood
                              - wood_with_insulating_infill
                              - rammed_or_cob_earth
                              - traditional_old_material
                              - others
                              example: brick
                              description: Le matériau principal des murs.
                            construction_year:
                              type: integer
                              example: 1985
                              description: L'année de construction du bâtiment.
                            number_of_windows:
                              type: integer
                              example: 8
                              description: Le nombre total de fenêtres.
                            generator_type:
                              type: string
                              enum:
                              - air_to_air_heat_pump
                              - air_to_water_heat_pump
                              - classic_gas_boiler
                              - closed_fireplace_insert
                              - coal_boiler
                              - condensing_gas_boiler
                              - electric_boiler_or_underfloor_heating
                              - electric_convector_heater
                              - electric_radiator
                              - fossil_fueled_district_heating_network
                              - fuel_boiler
                              - fuel_stove
                              - geothermal_heat_pump
                              - hybrid_heat_pump
                              - insulated_district_heating_network
                              - lpg_propane_butane_boiler_with_external_tank
                              - low_temperature_gas_boiler
                              - misc_system
                              - other_gas_generators
                              - pellet_boiler
                              - pellet_stove
                              - radiant_panel_heater
                              - standard_gas_boiler
                              - uninsulated_district_heating_network
                              - wood_boiler
                              - wood_stove
                              - unknown
                              example: condensing_gas_boiler
                              description: Le type de générateur de chauffage.
                            generator_energy:
                              type: string
                              enum:
                              - electricity
                              - fuel
                              - gas
                              - biomass_wood
                              - district_heating
                              - others
                              - unknown
                              example: gas
                              description: Le type d'énergie utilisé par le générateur de chauffage.
                            hot_water_type:
                              type: string
                              enum:
                              - air_to_water_heat_pump
                              - classic_gas_boiler
                              - coal_boiler
                              - condensing_gas_boiler
                              - electric_boiler
                              - electric_hot_water_tank
                              - electric_water_heater
                              - fossil_fueled_district_heating_network
                              - fuel_boiler
                              - gas_water_tank
                              - geothermal_heat_pump
                              - hybrid_heat_pump
                              - insulated_district_heating_network
                              - instant_gas_water_heater
                              - instant_lpg_propane_butane_water_heater
                              - lpg_propane_butane_boiler_external_tank
                              - lpg_propane_butane_storage_hot_water_tank
                              - low_temperature_gas_boiler
                              - other_gas_generators
                              - pellet_boiler
                              - standard_gas_boiler
                              - thermodynamic_water_tank
                              - uninsulated_district_heating_network
                              - wood_boiler
                              - unknown
                              example: electric_hot_water_tank
                              description: Le type de système de production d'eau chaude sanitaire.
                            hot_water_energy:
                              type: string
                              enum:
                              - electricity
                              - fuel
                              - gas
                              - biomass_wood
                              - district_heating
                              - others
                              - unknown
                              example: electricity
                              description: Le type d'énergie utilisé pour l'eau chaude sanitaire.
                            walls_insulation:
                              type:
                              - object
                              - 'null'
                              description: L'isolation des murs.
                              properties:
                                level:
                                  type:
                                  - string
                                  - 'null'
                                  enum:
                                  - no_insulation
                                  - partially_insulated
                                  - moderately_insulated
                                  - well_insulated
                                  example: partially_insulated
                                  description: Le niveau d'isolation des murs.
                                u_value:
                                  type:
                                  - number
                                  - 'null'
                                  format: float
                                  example: 0.35
                                  description: La valeur U des murs en W/m²K.
                            windows_insulation:
                              type:
                              - object
                              - 'null'
                              description: L'isolation des fenêtres.
                              properties:
                                level:
                                  type:
                                  - string
                                  - 'null'
                                  enum:
                                  - high_class
                                  - middle_class
                                  - low_class
                                  example: middle_class
                                  description: Le niveau d'isolation des fenêtres.
                                u_value:
                                  type:
                                  - number
                                  - 'null'
                                  format: float
                                  example: 1.8
                                  description: La valeur U des fenêtres en W/m²K.
                            high_floor_insulation:
                              type:
                              - object
                              - 'null'
                              description: L'isolation du plancher haut.
                              properties:
                                level:
                                  type:
                                  - string
                                  - 'null'
                                  enum:
                                  - no_insulation
                                  - partially_insulated
                                  - moderately_insulated
                                  - well_insulated
                                  example: partially_insulated
                                  description: Le niveau d'isolation du plancher haut.
                                u_value:
                                  type:
                                  - number
                                  - 'null'
                                  format: float
                                  example: 0.25
                                  description: La valeur U du plancher haut en W/m²K.
                            low_floor_insulation:
                              type:
                              - object
                              - 'null'
                              description: L'isolation du plancher bas.
                              properties:
                                level:
                                  type:
                                  - string
                                  - 'null'
                                  enum:
                                  - no_insulation
                                  - partially_insulated
                                  - moderately_insulated
                                  - well_insulated
                                  example: partially_insulated
                                  description: Le niveau d'isolation du plancher bas.
                                u_value:
                                  type:
                                  - number
                                  - 'null'
                                  format: float
                                  example: 0.4
                                  description: La valeur U du plancher bas en W/m²K.
                            vents_type:
                              type: string
                              enum:
                              - window_opening_ventilation
                              - high_low_air_inlet_ventilation
                              - natural_ventilation_duct
                              - mechanical_ventilation_existing_duct
                              - sf_self_regulating_vmc
                              - sf_hygro_a_vmc
                              - sf_hygro_b_vmc
                              - sf_gas_vmc
                              - low_pressure_vmc
                              - hybrid_ventilation
                              - individual_df_vmc
                              - collective_df_vmc
                              - climatic_well
                              example: sf_self_regulating_vmc
                              description: Le type de ventilation.
                            garage:
                              type: boolean
                              example: false
                              description: Présence d'un garage.
                            high_floor_kinds:
                              type: array
                              items:
                                type: string
                                enum:
                                - apartment
                                - converted_attic
                                - lost_attic
                                - not_heated_space
                                - office
                                - roof_terrace
                                - unknown
                              example:
                              - not_heated_space
                              description: Les types de plancher haut.
                            low_floor_kinds:
                              type: array
                              items:
                                type: string
                                enum:
                                - apartment
                                - crawl_space
                                - not_heated_space
                                - office
                                - slab_on_grade
                                - underground_garage
                                - unknown
                              example:
                              - crawl_space
                              description: Les types de plancher bas.
                            secondary_generator_energy:
                              type: string
                              enum:
                              - electricity
                              - fuel
                              - gas
                              - biomass_wood
                              - district_heating
                              - others
                              - unknown
                              example: gas
                              description: Le type d'énergie utilisé par le chauffage secondaire.
                            secondary_generator_type:
                              type: string
                              enum:
                           

# --- truncated at 32 KB (131 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/kelvin/refs/heads/main/openapi/kelvin-simulations-api-openapi.yml