Any call to the module needs to use the base URL https://api.waermepumpe.de/api/ghl.
No Arguments
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
Returns JSON data.
Retrieves all supported drilling configuration.
No Arguments
Returns JSON data.
Arguments:
manufacturer: int
The manufacturer ID of the space heating heat pump. Required if stored model data shall be used.
Limited to assigned manufacturer IDs.
Conditional
model: int
The model ID. Must correspond to the manufacturer of the space heating heat pump.
If not given, model data must be provided directly.
Conditional
drillingConfiguration: int
The drilling configuration ID as retrieved via /drillingConfigurations.
Required
cop: float [1.5 - 7.0]
The COP of the heat pump at B0/W35. Must be provided if no stored model is given. Conditional
heatingCapacity: float [1.0 - 30.0]
The heating capacity of the heat pump at B0/W35 in kW. Must be provided if no stored model is given. Conditional
annualFullLoadHours: int [1200, 1500, 1800, 2100, 2400]
The annual full load hours in h/a. Required
outletTemperature: int [-5, -3, 0]
The minimum outlet temperature of the geothermal probe in °C. Required
application: int [1, 2]
The application of the heat pump appliance.
A value of 1 indicates space-heating.
A value of 2 indicates space-heating and domestic hot water. Required
soilTemperature: int [9 - 13]
The mean soil temperature in °C. Required
thermalConductivity: float [1.5, 2.0, 2.5, 3.0, 3.5]
The thermal conductivity of the soil in W/(m·K). Required
averageDrillingDiameter: float [0.1 - 0.2]
The average drilling diameter in m. Required
boreholeResistance: float [0.07, 0.08, 0.09, 0.10, 0.11, 0.12]
The borehole resistance in m·K/W. Required
distanceProbes: float [6 - 12]
The distance between geothermal probes in m. Required
Returns JSON data.
Arguments:
manufacturer: int
The manufacturer ID of the space heating heat pump. Required if stored model data shall be used.
Limited to assigned manufacturer IDs.
Conditional
model: int
The model ID. Must correspond to the manufacturer of the space heating heat pump.
If not given, model data must be provided directly.
Conditional
drillingConfiguration: int
The drilling configuration ID as retrieved via /drillingConfigurations.
Required
cop: float [1.5 - 7.0]
The COP of the heat pump at B0/W35. Must be provided if no stored model is given. Conditional
heatingCapacity: float [1.0 - 30.0]
The heating capacity of the heat pump at B0/W35 in kW. Must be provided if no stored model is given. Conditional
annualFullLoadHours: int [1200, 1500, 1800, 2100, 2400]
The annual full load hours in h/a. Required
outletTemperature: int [-5, -3, 0]
The minimum outlet temperature of the geothermal probe in °C. Required
application: int [1, 2]
The application of the heat pump appliance.
A value of 1 indicates space-heating.
A value of 2 indicates space-heating and domestic hot water. Required
soilTemperature: int [9 - 13]
The mean soil temperature in °C. Required
thermalConductivity: float [1.5, 2.0, 2.5, 3.0, 3.5]
The thermal conductivity of the soil in W/(m·K). Required
averageDrillingDiameter: float [0.1 - 0.2]
The average drilling diameter in m. Required
boreholeResistance: float [0.07, 0.08, 0.09, 0.10, 0.11, 0.12]
The borehole resistance in m·K/W. Required
distanceProbes: float [6 - 12]
The distance between geothermal probes in m. Required