Any call to the module needs to use the base URL https://api.waermepumpe.de/api/heatingLoad.
Retrieves the heating load using the construction age class.
Arguments:
windows: int [0, 1]
Specifies if the windows are insulated.
These values are valid:
0: windows not insulated
1: windows insulated
Default value is 0.
Optional
roof: int [0, 1]
Specifies if the roof is insulated.
These values are valid:
0: roof not insulated
1: roof insulated
Default value is 0.
Optional
walls: int [0, 1]
Specifies if the walls are insulated.
These values are valid:
0: walls not insulated
1: walls insulated
Default value is 0.
Optional
area: float [0 - ∞]
The heated area in m². Required
designOutsideTemperature: float [-18 - -8]
The design outside temperature in °C. Required
type: int [1, 2, 3, 4]
Specifies the building type.
These values are valid:
1: single-family home, detached
2: end-townhouse
3: mid-townhouse
4: home in single-family zone Required
type: int [1, 2, 3, 4]
Specifies the building type.
These values are valid:
1: single-family home, detached
2: end-townhouse
3: mid-townhouse
4: home in single-family zone Required
age: int [1, 2, 3, 4, 5, 6, 7]
Specifies the buildings' age class.
These values are valid:
1: up to 1958
2: 1959 to 1968
3: 1969 to 1973
4: 1974 to 1977
5: 1978 to 1983
6: 1984 to 1994
7: as of 1995 Required
Returns JSON data.
heatingLoad: float
The heating load in kW.
specificHeatingLoad: float
The specific heating load in W/m².
Retrieves the heating load using the full load hours.
Arguments:
generatedUsefulHeatOutputMode: int [0, 1, 2]
The method of ascertaining the generated useful heat output.
These values are valid:
0: direct input
1: final energy consumption and degree of utilization
2: final energy consumption, construction age class and heat generator Required
finalEnergyConsumptionMode: int [0, 1]
The method of ascertaining the final energy consumption. Required if generatedUsefulHeatOutputMode is 1 or 2.
These values are valid:
0: direct input
1: energy source and consumption Conditional
generatedUsefulHeatOutput: float [0 - ∞]
The generated useful heat output in kW. Required if generatedUsefulHeatOutputMode is 0. Conditional
finalEnergyConsumption: float [0 - ∞]
The final energy consumption in kWh/a. Required if finalEnergyConsumptionMode is 0. Conditional
degreeOfUtilization: int [0 - 100]
The degree of utilization in %. Required if generatedUsefulHeatOutputMode is 1. Conditional
energySource: int [1, 2]
Indicates the energy source. Required if finalEnergyConsumptionMode is 1.
These values are valid:
1: oil
2: natural gas Conditional
consumption: int [0 - ∞]
The consumption in l or m³ depending on the energy source. Required if finalEnergyConsumptionMode is 1. Conditional
age: int [1, 2, 3]
The age class of the heat generator. Required if generatedUsefulHeatOutputMode is 2.
These values are valid:
1: before 1980
2: 1980 to 1994
3: as of 1995 Conditional
typeOfHeatGenerator: int [1, 2, 3]
The type of heat generator. Required if generatedUsefulHeatOutputMode is 2.
These values are conditionally valid:
1: condensing boiler or district heating. Valid if age is 2 or 3.
2: low-temperature boiler. Valid if age is 1, 2 or 3.
3: wood pellet boiler. Valid if age is 3. Conditional
fullLoadHoursMode: int [0, 1, 2]
The method of ascertaining the full load hours.
These values are valid:
0: direct input
1: ZIP code and heating limit temperature
2: operating time and average degree of load Required
fullLoadHours: int [0 - 8760]
The full load hours in h. Required if fullLoadHoursMode is 0. Conditional
averageDegreeOfLoadMode: int [1, 2]
The method of ascertaining the full load hours. Required if fullLoadHoursMode is 1.
These values are conditionally valid:
1: direct input
2: heating limit temperature and ZIP code Conditional
operatingTime: int [0 - 8760]
The operating time in h. Required if fullLoadHoursMode is 2. Conditional
averageDegreeOfLoad: int [0 - 100]
The average degree of load in %. Required if averageDegreeOfLoadMode is 0. Conditional
heatingLimitTemperature: int [10, 12, 15]
The heating limit temperature in °C. Required if fullLoadHoursMode is 0 or averageDegreeOfLoadMode is 1.
Conditional
zip: string
The zip code of the postal area. Required if fullLoadHoursMode is 0 or averageDegreeOfLoadMode is 1.
Conditional
Returns JSON data.
fullLoadHours: int
The full load hours in h.
generatedUsefulHeatOutput: float
The generated useful heat output in kWh/a.
degreeOfUtilization: float
The degree of utilization in %.
finalEnergyConsumption: float
The final energy consumption in kWh/a.
heatingLoad: float
The heating load in kW.
Retrieves the hot water heat demand dependent on the volume flow rate and number of persons.
Arguments:
numberOfPersons: int [0 - ∞]
The number of persons to be provided with hot water.
Required
specificHeatDemand: int
The person-specific hot water in l/dP.
Default value is 30 l/dP.
Optional
typeOfHotWaterProduction: int [1, 2, 3, 4]
These values are valid:
1: central unit without circulation
2: central unit with circulation in single-family home
3: central unit with circulation in multi-family home
4: central apartment unit
Required
degreeOfUtilization: int [0 - 100]
The degree of utilization describes the efficiency of the hot water production in percent.
Depending on the type of hot water production, different ranges are valid:
central unit without circulation: [50 - 70]
central unit with circulation in single-family home: [20 - 40]
central unit with circulation in multi-family home: [30 - 60]
central apartment unit: [70 - 85]
Required
Returns JSON data.
heatingLoad: float
The hot water heat demand in kWh/a.
Retrieves the hot water heat demand dependent on the inhabited area.
Arguments:
area: int [0 - ∞]
The inhabited area in m².
Required
typeOfHotWaterProduction: int [1, 2, 3, 4]
These values are valid:
1: central unit without circulation
2: central unit with circulation in single-family home
3: central unit with circulation in multi-family home
4: central apartment unit
Required
degreeOfUtilization: int [0 - 100]
The degree of utilization describes the efficiency of the hot water production in percent.
Depending on the type of hot water production, different ranges are valid:
central unit without circulation: [50 - 70]
central unit with circulation in single-family home: [20 - 40]
central unit with circulation in multi-family home: [30 - 60]
central apartment unit: [70 - 85]
Required
Returns JSON data.
heatDemand: float
The hot water heat demand in kWh/a.
Retrieves the hot water heat demand using utilization units.
Arguments:
utilizationUnits: int [0 - ∞]
The number of utilization units to be provided with hot water.
Required
numberOfPersons: int [0 - ∞]
The number of persons across all utilization units to be provided with hot water.
Required
solarthermalSupport: int
Specifies the use of solar thermal energy. Must be 0 if number of utilization units is greate than 1.
These values are valid:
0: no solarthermal support
1: solarthermics provide 60 % of hot water heat demand
Default value is 0.
Optional
circulation: int
Specifies the existence of circulation. Must be 1 if number of utilization units is greate than 1.
These values are valid:
0: no circulation
1: circulation
Default value is 1.
Optional
userBehavior: int
Specifies the user behavior. Must be 2 if number of utilization units is greate than 2.
These values are valid:
1: economical
2: normal
3: comfortable
Default value is 2.
Optional
typeOfHeatGenerator: int
Specifies the type of heat generation.
These values are valid:
1: condensing boiler
2: low-temperature boiler
Required
Returns JSON data.
heatDemand: float
The hot water heat demand in kWh/a.
Retrieves the heating load using energy consumption based on full load hours as in DIN/TS 12831-1 and the utilizatin units method for hot water heat demand.
Arguments:
generatedUsefulHeatOutputMode: int [0, 1, 2]
The method of ascertaining the generated useful heat output.
These values are valid:
0: direct input
1: final energy consumption and degree of utilization
2: final energy consumption, construction age class and heat generator Required
finalEnergyConsumptionMode: int [0, 1]
The method of ascertaining the final energy consumption. Required if generatedUsefulHeatOutputMode is 1 or 2.
These values are valid:
0: direct input
1: energy source and consumption Conditional
hotWaterHeatDemandMode: int [0, 1]
The method of ascertaining the hot water heat demand. Required if generatedUsefulHeatOutputMode is 1 or 2.
These values are valid:
0: direct input
1: utilization units Conditional
climateFactor: int [0, ∞]
The ID of the climate factor as retrieved via energyConsumptionHeatingLoad/climateFactors.
1: utilization units Optional
hotWaterHeatDemand: int [0, ∞]
The hot water heat demand in kWh/a. Required if hotWaterHeatDemandMode is 0.
Conditional
generatedUsefulHeatOutput: float [0 - ∞]
The generated useful heat output in kW. Required if generatedUsefulHeatOutputMode is 0. Conditional
finalEnergyConsumption: float [0 - ∞]
The final energy consumption in kWh/a. Required if finalEnergyConsumptionMode is 0. Conditional
degreeOfUtilization: int [0 - 100]
The degree of utilization in %. Required if generatedUsefulHeatOutputMode is 1. Conditional
energySource: int [1, 2]
Indicates the energy source. Required if finalEnergyConsumptionMode is 1.
These values are valid:
1: oil
2: natural gas Conditional
consumption: int [0 - ∞]
The consumption in l or m³ depending on the energy source. Required if finalEnergyConsumptionMode is 1. Conditional
age: int [1, 2, 3]
The age class of the heat generator. Required if generatedUsefulHeatOutputMode is 2.
These values are valid:
1: before 1980
2: 1980 to 1994
3: as of 1995 Conditional
typeOfHeatGenerator: int [1, 2]
The type of heat generator. Required if generatedUsefulHeatOutputMode is 2.
These values are conditionally valid:
1: condensing boiler or district heating. Valid if age is 2 or 3.
2: low-temperature boiler. Valid if age is 1, 2 or 3.
Conditional
fullLoadHoursMode: int [0, 1, 2]
The method of ascertaining the full load hours.
These values are valid:
0: direct input
1: ZIP code and heating limit temperature
2: operating time and average degree of load Required
fullLoadHours: int [0 - 8760]
The full load hours in h. Required if fullLoadHoursMode is 0. Conditional
averageDegreeOfLoadMode: int [1, 2]
The method of ascertaining the full load hours. Required if fullLoadHoursMode is 1.
These values are conditionally valid:
1: direct input
2: heating limit temperature and ZIP code Conditional
operatingTime: int [0 - 8760]
The operating time in h. Required if fullLoadHoursMode is 2. Conditional
averageDegreeOfLoad: int [0 - 100]
The average degree of load in %. Required if averageDegreeOfLoadMode is 0. Conditional
heatingLimitTemperature: int [10, 12, 15]
The heating limit temperature in °C. Required if fullLoadHoursMode is 0 or averageDegreeOfLoadMode is 1.
Conditional
zip: string
The zip code of the postal area. Required if fullLoadHoursMode is 0 or averageDegreeOfLoadMode is 1.
Conditional
utilizationUnits: int [0 - ∞]
The number of utilization units to be provided with hot water. Required if hotWaterHeatDemandMode is 1.
Conditional
numberOfPersons: int [0 - ∞]
The number of persons across all utilization units to be provided with hot water. Required if hotWaterHeatDemandMode is 1.
Conditional
solarthermalSupport: int
Specifies the use of solar thermal energy. Must be 0 if number of utilization units is greate than 1.
These values are valid:
0: no solarthermal support
1: solarthermics provide 60 % of hot water heat demand
Default value is 0.
Optional
circulation: int
Specifies the existence of circulation. Must be 1 if number of utilization units is greate than 1.
These values are valid:
0: no circulation
1: circulation
Default value is 1.
Optional
userBehavior: int
Specifies the user behavior. Must be 2 if number of utilization units is greate than 2.
These values are valid:
1: economical
2: normal
3: comfortable
Default value is 2.
Optional
Returns JSON data.
fullLoadHours: int
The full load hours in h.
generatedUsefulHeatOutput: float
The generated useful heat output in kWh/a.
degreeOfUtilization: float
The degree of utilization in %.
finalEnergyConsumption: float
The final energy consumption in kWh/a.
longTermConsumption: float
The long-term final energy consumption in kWh/a.
climateFactor: float
The climate factor used for long-term correction.
spaceHeatingHeatDemand: float
The long-term space heating heat demand in kWh/a.
hotWaterHeatDemand: float
The hot water heat demand in kWh/a.
heatingLoad: float
The heating load in kW.
Retrieves the climate factors ascertained by Deutscher Wetterdienst (DWD) to clean space heating heat demand from seasonal impact.
Arguments
zip: string
The ZIP code to retrieve climate factors for. Required
Returns JSON data.
id: int
Internal ID of the climate factor record.
dateStart: int
Date (d.m.Y) of the begin of the consumption period.
dateEnd: int
Date (d.m.Y) of the end of the consumption period.
zip: string
The ZIP code of corresponding to the climate factor.
climateFactor: float
The climate factor.
Retrieves the predefined thermal transmittance as defined in DIN EN 12831-1 and DIN/TS 12831-1.
No Arguments
Returns JSON data.
transmittances: array
The predefined thermal transmittances as defined in DIN EN 12831-1 and DIN/TS 12831-1.
categories: array
The categories the predefined thermal transmittances belong to as defined in DIN EN 12831-1 and DIN/TS 12831-1.
standards: array
The standards the categories refer to.
ageClasses: array
The age classes as defined in DIN EN 12831-1 and DIN/TS 12831-1.
Retrieves the building heating load using the simplified heating load method as in DIN EN 12831-1 and DIN/TS 12831-1.
Arguments:
internalVolume: int [0 - ∞]
The building's internal volume in m³.
Required
designInsideTemperature: int [0 - ∞]
The building's design inside temperature in °C.
Required
designOutsideTemperature: int [-∞ - 0]
The building's design outside temperature in °C. Must be provided if zip is not set.
Conditional
zip: string
The zip code of the postal area. Must be provided if designOutsideTemperature is not set.
Conditional
airTightness: int [1, 2, 3]
The building's air tightness to account for ventilation heat loss.
These values are valid:
1: tight windows
2: medium tightness
3: obvious leakage
Conditional
buildingComponents: array
The components the building consists of.
Each element needs to have these properties:
Conditional
predefinedThermalTransmittance: int [0 - ∞]
ID of the predefined thermal transmittance as retrieved by /simplifiedBuildingHeatingLoad/predefinedThermalTransmittances
area: float [0 - ∞]
The outside surface area (external dimension) of the building component in m².
blanketAdditionalThermalTransmittance: float [0 - ∞]
The blanket additional thermal transmittance due to thermal bridges in W/(m²*K).
adjacency: int [1, 2, 3, 4]
The component's adjacency:
These values are valid:
1: outdoor air
2: unheated room
3: soil
4: heated room
additionalInsulation: int [0, 2, 5, 8, 12, 16, 20, 30, 40]
The component's additional insulation in cm.
Returns JSON data.
heatingLoad: float
The heating load in kW.
Retrieves the predefined thermal transmittance as defined in DIN EN 12831-1 and DIN/TS 12831-1.
No Arguments
Returns JSON data.
transmittances: array
The predefined thermal transmittances as defined in DIN EN 12831-1 and DIN/TS 12831-1.
categories: array
The categories the predefined thermal transmittances belong to as defined in DIN EN 12831-1 and DIN/TS 12831-1.
standards: array
The standards the categories refer to.
ageClasses: array
The age classes as defined in DIN EN 12831-1 and DIN/TS 12831-1.
Generates the room's building components using DIN EN 12831-1 and DIN/TS 12831-1.
Arguments:
construction: int [1, 2]
The construction type of the room.
These values are valid:
1: massive
2: timber
Required
ageClass: int [1, 2]
The age class of the room.
These values are valid:
1: up to 1918
2: 1919 to 1948
3: 1949 to 1957
4: 1958 to 1968
5: 1969 to 1978
6: 1979 to 1983
7: 1984 to 1995
8: as of 1995>
Required
roomType: int [1, 2, 3]
The room type as defined in DIN/TS 12831-1.
These values are valid:
1: living room or bedroom
2: kitchen
3: bathroom
4: windowless room
5: other
Required
baseArea: float [0 - ∞]
The base area of the room in m².
Required
height: float [0 - ∞]
The room height in m.
Required
floorAdjacency: int [1, 2]
The room's floor adjacency.
These values are valid:
1: unheaded room
2: heated room
Required
ceilingAdjacency: int [1, 2, 3]
The room's ceiling adjacency.
These values are valid:
1: unheaded room
2: heated room
3: outdoor air
Required
predefinedThermalTransmittance: int [0 - ∞]
ID of the predefined thermal transmittance to be used for windows as retrieved by /simplifiedBuildingHeatingLoad/predefinedThermalTransmittances.
Required
additionalInsulation: int [0, 2, 5, 8, 12, 16, 20, 30, 40]
The component's additional insulation in cm.
Required
numberOfExteriorWalls: int [1, 2, 3, 4]
The number of exterior walls. Can take values 1 to 4 in case of living room or bedroom. Can take values 1 to 2 else.
Required
Returns JSON data.
buildingComponents: array
Retrieves the room heating load using the simplified heating load method as in DIN EN 12831-1 and DIN/TS 12831-1.
Arguments:
designInsideTemperature: int [0 - ∞]
The building's design inside temperature in °C.
Required
designOutsideTemperature: int [-∞ - 0]
The building's design outside temperature in °C. Must be provided if zip is not set.
Conditional
zip: string
The zip code of the postal area. Must be provided if designOutsideTemperature is not set.
Conditional
roomType: int [1, 2, 3]
The room type as defined in DIN/TS 12831-1.
These values are valid:
1: living room or bedroom
2: kitchen
3: bathroom
4: windowless room
5: other
Required
numberOfExteriorWalls: int [1, 2, 3, 4]
The number of exterior walls. Can take values 1 to 4 in case of living room or bedroom. Can take values 1 to 2 else.
Required
numberOfInteriorWalls: int [1, 2, 3, 4]
The number of interior walls. Can take values 0 to 2.
Required
baseArea: float [0 - ∞]
The base area of the room in m².
Required
height: float [0 - ∞]
The room height in m.
Required
buildingComponents: array
The components the building consists of.
Each element needs to have these properties:
Conditional
predefinedThermalTransmittance: int [0 - ∞]
ID of the predefined thermal transmittance as retrieved by /simplifiedBuildingHeatingLoad/predefinedThermalTransmittances.
areaMode: int [1, 2, 3, 4]
The mode of determining the surface area of the building component.
These values are valid:
1: direct input
2: exterior walls
3: interior walls
4: windows
area: float [0 - ∞]
The outside surface area (external dimension) of the building component in m². Required if areaMode is 1.
blanketAdditionalThermalTransmittance: float [0 - ∞]
The blanket additional thermal transmittance due to thermal bridges in W/(m²*K).
adjacency: int [1, 2, 3, 4]
The component's adjacency.
These values are valid:
1: outdoor air
2: unheated room
3: soil
4: heated room
additionalInsulation: int [0, 2, 5, 8, 12, 16, 20, 30, 40]
The component's additional insulation in cm.