Any call to the module needs to use the base URL https://api.waermepumpe.de/api/spf.
No Arguments
Returns JSON data.
No Arguments
Returns JSON data.
Arguments:
manufacturer: int
The manufacturer ID of the space heating heat pump.
Limited to assigned manufacturer IDs.
Required
Returns JSON data.
Arguments:
manufacturer: int
The manufacturer ID of the space heating heat pump.
Limited to assigned manufacturer IDs.
Required
heatSource: int
The heat source ID. See /heatSources.
Required
intermediateHeatExchanger: int [0, 1]
Employment of an intermediate circuit.
A value of 0 indicates that no intermediate circuit is employed.
A value of 1 indicates that an intermediate circuit is employed.
Optional. Default value is 0.
Optional
Returns JSON data.
Arguments:
manufacturer: int
The manufacturer ID of the space heating heat pump.
Limited to assigned manufacturer IDs.
Required
type: int
0, another heat generator, 1: space heating heat pump, 2: outdoor air, 3: ambient air, 4: waste air, 5: brine, 6: groundwater, 7: earth / direct heat exchange
Required
intermediateHeatExchanger: int [0, 1]
Employment of an intermediate circuit.
A value of 0 indicates that no intermediate circuit is employed.
A value of 1 indicates that an intermediate circuit is employed.
Optional. Default value is 0.
Optional
Returns JSON data.
Arguments:
manufacturer: int
The manufacturer ID of the space heating heat pump.
Limited to assigned manufacturer IDs.
Required
model: int
The model ID. Must correspond to the manufacturer of the space heating heat pump if positive. Else model performance data must be provided.
Required
modelTitle: string
The model title. Must be provided if no stored model is given.
Conditional
ratedHeatingCapacity: float
The rated heating capacity in kW. Must be provided if no stored model is given.
Conditional
capacityControl: int [1, 2]
The capacity control. Must be provided if no stored model is given.
A value of 1 indicates a fixed-speed unit.
A value of 2 indicates a variable-capacity unit.
Conditional
copA7W35: float
The COP at A7/W35 according to EN 14511. Must be provided if no stored model is given and heat source is air.
Equals to COP at A7/W35 according EN 14825.
Conditional
copA2W35: float
The COP at A2/W35 according to EN 14511. Must be provided if no stored model is given, heat source is air and no EN 14825 is provided.
Conditional
copA-7W35: float
The COP at A-7/W35 according to EN 14511. Must be provided if no stored model is given, heat source is air and no EN 14825 is provided.
Conditional
copB0W35: float
The COP at B0/W35 according to EN 14511. Must be provided if no stored model is given and heat source is brine or is water and an intermediate heat exchanger is used.
Equals to COP at B0/W35 according EN 14825.
Conditional
copW10W35: float
The COP at W10/W35 according to EN 14511. Must be provided if no stored model is given and heat source is water.
Equals to COP at W10/W35 according EN 14825.
Conditional
copE4W35: float
The COP at E4/W35 according to EN 14511. Must be provided if no stored model is given and heat source is direct expansion.
Equals to COP at E4/W35 according EN 14825.
Conditional
copA2W35_EN14825: float
The COP at A2/W35 according to EN 14825. Must be provided if no stored model is given, heat source is air and no EN 14511 is provided.
Conditional
capacityA2W35_EN14825: float
The capacity at A2/W35 according to EN 14825 in kW. Must be provided if no stored model is given, heat source is air and no EN 14511 is provided.
Conditional
copA-7W35_EN14825: float
The COP at A-7/W35 according to EN 14825. Must be provided if no stored model is given, heat source is air and no EN 14511 is provided.
Conditional
capacityA-7W35_EN14825: float
The capacity at A-7/W35 according to EN 14825 in kW. Must be provided if no stored model is given, heat source is air and no EN 14511 is provided.
Conditional
defrostingA2W35: int [1, 2, 3, 4]
The capacity control. Must be provided if no stored model is given.
A value of 1 indicates that defrosting has been taken into account during measurement.
A value of 2 indicates that the defrosting method is reverse circulation.
A value of 3 indicates that the defrosting method is hot gas.
A value of 4 indicates that the defrosting method is direct electrical. Conditional
copDataEN14511Available: int [1, 2]
Determines whether EN 14511 data is provided or auxiliary values are to be calculated through EN 14825 data. Must be provided if no stored model is given and heat source is air.
Conditional
heatSource: int
The heat source ID. See /heatSources.
Required
intermediateHeatExchanger: int [0, 1]
Employment of an intermediate circuit.
A value of 0 indicates that no intermediate circuit is employed.
A value of 1 indicates that an intermediate circuit is employed.
Optional. Default value is 0.
Optional
heatingLimitTemperature: int [10, 12, 15]
The heating limit temperature in °C. Only fixed values are allowed.
Required
supplyTemperature: int [30 - 80]
The supply temperature in °C.
Values 30 °C to 55 °C are valid for monovalent and bivalent parallel operation.
Values 30 to 80 are valid for bivalent alternative operation.
Required
returnTemperature: int [20 - 60]
The return temperature in °C.
Values between 3 K and 10 K below supply temperature are valid for monovalent and bivalent parallel operation.
Values between 3 K and 20 K below supply temperature are valid for bivalent alternative operation.
Required
designOutsideTemperature: int [-16 - 12]
The design outside temperature in °C.
Values between -16 °C and -8 °C are valid.
Required for air heat sources in any case and for any other heat source if operating mode is bivalent.
Conditional
sourceTemperature: int [-16 - 12]
The source temperature in °C.
Values between -16 °C and -8 °C are valid for outdoor air heat sources.
Values between -3 °C and 5 °C are valid for brine heat sources.
Values between 5 °C and 12 °C are allowed for groundwater heat sources.
Required
powerBrinePump: int [0 - ∞]
The power of the brine pump in W.
Required if heat source is brine or groundwater with intermediate circuit.
Conditional
powerWellWaterPump: int [0 - ∞]
The power of the well water pump in W.
Required if heat source is groundwater with intermediate circuit.
Conditional
powerHeatSourcePump: int [0 - ∞]
The power of the heat source pump in W.
Required if heat source is brine or groundwater without intermediate circuit.
Conditional
bivalencePoint: int [-10 - 2]
The bivalence point in °C.
Required if operating mode is bivalent.
Conditional
operatingMode: int
The operating mode ID. See /operatingModes.
Required
supplementaryHeater: int [1 , 2]
A value of 1 indicates a monoenergetic supplementary heater.
A value of 2 indicates a supplementary heater using another energy source.
The type of the supplementary heater.
Required if operating mode is bivalent.
Conditional
heatingCapacity: float [0 - ∞]
The heating capacity of the heat pump in kW.
Required if operating mode is bivalent.
Conditional
heatingLoad: float [0 - ∞]
The heating load of the building in kW.
Conditional
shareDhw: int [0 - 100]
The share of heat demand dedicated to domestic hot water in %.
Required
heatSourceDhw: int
0, another heat generator, 1: space heating heat pump, 2: outdoor air, 3: ambient air, 4: waste air, 5: brine, 6: groundwater, 7: earth / direct heat exchange
Required
manufacturerDhw: int
The manufacturer ID of the domestic hot water heat pump.
Not limited to assigned manufacturer IDs.
Required if domestic hot water is provided by a domestic hot water heat pump.
Conditional
modelDhw: int
The model ID. Must correspond to the manufacturer of the domestic hot water heat pump.
Required if domestic hot water is provided by a domestic hot water heat pump.
Conditional
storageTemperature: int [50 - 70]
The storage temperature in °C.
Values between 50 °C and 60 °C are valid for domestic hot water provision through space heating heat pump.
Values between 50 °C and 70 °C are valid for domestic hot water provision through domestic hot water heat pump. Upper limit may to lowered by model data.
Required if domestic hot water not provided by another heat generator.
Conditional
storageType: int [1 - internal heat exchanger, 2 - other, 3 - EN 16147]
A value of 1 indicates an internal heat exchanger and is valid if domestic hot water is provided by space heating water heat pump.
A value of 2 indicates another type of heat exchanger and is valid if domestic hot water is provided by space heating water heat pump.
A value of 3 indicates domestic hot water generator and is valid if domestic hot water is provided by domestic hot water heat pump.
Required if domestic hot water not provided by another heat generator.
Conditional
Returns JSON data.
Arguments:
manufacturer: int
The manufacturer ID of the space heating heat pump.
Limited to assigned manufacturer IDs.
Required
model: int
The model ID. Must correspond to the manufacturer of the space heating heat pump if positive. Else model performance data must be provided.
Required
modelTitle: string
The model title. Must be provided if no stored model is given.
Conditional
ratedHeatingCapacity: float
The rated heating capacity in kW. Must be provided if no stored model is given.
Conditional
capacityControl: int [1, 2]
The capacity control. Must be provided if no stored model is given.
A value of 1 indicates a fixed-speed unit.
A value of 2 indicates a variable-capacity unit.
Conditional
copA7W35: float
The COP at A7/W35 according to EN 14511. Must be provided if no stored model is given and heat source is air.
Equals to COP at A7/W35 according EN 14825.
Conditional
copA2W35: float
The COP at A2/W35 according to EN 14511. Must be provided if no stored model is given, heat source is air and no EN 14825 is provided.
Conditional
copA-7W35: float
The COP at A-7/W35 according to EN 14511. Must be provided if no stored model is given, heat source is air and no EN 14825 is provided.
Conditional
copB0W35: float
The COP at B0/W35 according to EN 14511. Must be provided if no stored model is given and heat source is brine or is water and an intermediate heat exchanger is used.
Equals to COP at B0/W35 according EN 14825.
Conditional
copW10W35: float
The COP at W10/W35 according to EN 14511. Must be provided if no stored model is given and heat source is water.
Equals to COP at W10/W35 according EN 14825.
Conditional
copE4W35: float
The COP at E4/W35 according to EN 14511. Must be provided if no stored model is given and heat source is direct expansion.
Equals to COP at E4/W35 according EN 14825.
Conditional
copA2W35_EN14825: float
The COP at A2/W35 according to EN 14825. Must be provided if no stored model is given, heat source is air and no EN 14511 is provided.
Conditional
capacityA2W35_EN14825: float
The capacity at A2/W35 according to EN 14825 in kW. Must be provided if no stored model is given, heat source is air and no EN 14511 is provided.
Conditional
copA-7W35_EN14825: float
The COP at A-7/W35 according to EN 14825. Must be provided if no stored model is given, heat source is air and no EN 14511 is provided.
Conditional
capacityA-7W35_EN14825: float
The capacity at A-7/W35 according to EN 14825 in kW. Must be provided if no stored model is given, heat source is air and no EN 14511 is provided.
Conditional
defrostingA2W35: int [1, 2, 3, 4]
The capacity control. Must be provided if no stored model is given.
A value of 1 indicates that defrosting has been taken into account during measurement.
A value of 2 indicates that the defrosting method is reverse circulation.
A value of 3 indicates that the defrosting method is hot gas.
A value of 4 indicates that the defrosting method is direct electrical. Conditional
copDataEN14511Available: int [1, 2]
Determines whether EN 14511 data is provided or auxiliary values are to be calculated through EN 14825 data. Must be provided if no stored model is given and heat source is air.
Conditional
heatSource: int
The heat source ID. See /heatSources.
Required
intermediateHeatExchanger: int [0, 1]
Employment of an intermediate circuit.
A value of 0 indicates that no intermediate circuit is employed.
A value of 1 indicates that an intermediate circuit is employed.
Optional. Default value is 0.
Optional
heatingLimitTemperature: int [10; 12; 15]
The heating limit temperature in °C. Only fixed values are allowed.
Required
supplyTemperature: int [30 - 80]
The supply temperature in °C.
Values 30 °C to 55 °C are valid for monovalent and bivalent parallel operation.
Values 30 to 80 are valid for bivalent alternative operation.
Required
returnTemperature: int [20 - 60]
The return temperature in °C.
Values between 3 K and 10 K below supply temperature are valid for monovalent and bivalent parallel operation.
Values between 3 K and 20 K below supply temperature are valid for bivalent alternative operation.
Required
designOutsideTemperature: int [-16 - 12]
The design outside temperature in °C.
Values between -16 °C and -8 °C are valid.
Required for air heat sources in any case and for any other heat source if operating mode is bivalent.
Conditional
sourceTemperature: int [-16 - 12]
The source temperature in °C.
Values between -16 °C and -8 °C are valid for outdoor air heat sources.
Values between -3 °C and 5 °C are valid for brine heat sources.
Values between 5 °C and 12 °C are allowed for groundwater heat sources.
Required
powerBrinePump: int [0 - ∞]
The power of the brine pump in W.
Required if heat source is brine or groundwater with intermediate circuit.
Conditional
powerWellWaterPump: int [0 - ∞]
The power of the well water pump in W.
Required if heat source is groundwater with intermediate circuit.
Conditional
powerHeatSourcePump: int [0 - ∞]
The power of the heat source pump in W.
Required if heat source is brine or groundwater without intermediate circuit.
Conditional
bivalencePoint: int [-10 - 2]
The bivalence point in °C.
Required if operating mode is bivalent.
Conditional
operatingMode: int
The operating mode ID. See /operatingModes.
Required
supplementaryHeater: int [1 , 2]
A value of 1 indicates a monoenergetic supplementary heater.
A value of 2 indicates a supplementary heater using another energy source.
The type of the supplementary heater.
Required if operating mode is bivalent.
Conditional
heatingCapacity: float [0 - ∞]
The heating capacity of the heat pump in kW.
Required if operating mode is bivalent.
Conditional
heatingLoad: float [0 - ∞]
The heating load of the building in kW.
Conditional
shareDhw: int [0 - 100]
The share of heat demand dedicated to domestic hot water in %.
Required
heatSourceDhw: int
0, another heat generator, 1: space heating heat pump, 2: outdoor air, 3: ambient air, 4: waste air, 5: brine, 6: groundwater, 7: earth / direct heat exchange
Required
manufacturerDhw: int
The manufacturer ID of the domestic hot water heat pump.
Not limited to assigned manufacturer IDs.
Required if domestic hot water is provided by a domestic hot water heat pump.
Conditional
modelDhw: int
The model ID. Must correspond to the manufacturer of the domestic hot water heat pump.
Required if domestic hot water is provided by a domestic hot water heat pump.
Conditional
storageTemperature: int [50 - 70]
The storage temperature in °C.
Values between 50 °C and 60 °C are valid for domestic hot water provision through space heating heat pump.
Values between 50 °C and 70 °C are valid for domestic hot water provision through domestic hot water heat pump. Upper limit may to lowered by model data.
Required if domestic hot water not provided by another heat generator.
Conditional
storageType: int [1 - internal heat exchanger, 2 - other, 3 - EN 16147]
A value of 1 indicates an internal heat exchanger and is valid if domestic hot water is provided by space heating water heat pump.
A value of 2 indicates another type of heat exchanger and is valid if domestic hot water is provided by space heating water heat pump.
A value of 3 indicates domestic hot water generator and is valid if domestic hot water is provided by domestic hot water heat pump.
Required if domestic hot water not provided by another heat generator.
Conditional
addressName: string
The owner's or operator's name, respectively, as part of the contact data. Will be printed on the report is contact is complete.
Optional
addressStreet: string
The owner's or operator's street, respectively, as part of the contact data. Will be printed on the report is contact is complete.
Optional
addressZip: string
The owner's or operator's zip code, respectively, as part of the contact data. Will be printed on the report is contact is complete.
Optional
addressPlace: string
The owner's or operator's place, respectively, as part of the contact data. Will be printed on the report is contact is complete.
Optional