BWP-API: EWK-VDI 4640

Endpoint

Any call to the module needs to use the base URL https://api.waermepumpe.de/api/ewk.

  • Retrieves all soil types with their thermal conductivities.

  • No Arguments

  • Returns JSON data.

  • Retrieves the ZIP code's climate information.

  • Arguments:

  • zip: string
    The ZIP code to retrieve information for. Required

  • Returns JSON data.

  • Retrieves the supported anti-freeze agents.

  • No Arguments

  • Returns JSON data.

  • Retrieves the supported soil temperatures.

  • No Arguments

  • Returns JSON data.

  • Calculates the kinematic viscosity.

  • Arguments:

  • antifreezeAgent: int
    The anti-freeze agents as retrieved via /antifreezeAgents. Required
  • soilTemperature: int
    The soil temperature in °C as retrieved via /soilTemperature. Required
  • concentration: int
    The concentration in % as retrieved via /concentrations. Required

  • Returns JSON data.

  • Returns the supported concentration levels of anti-freeze agents.

  • Arguments:

  • antifreezeAgent: int
    The anti-freeze agents as retrieved via /antifreezeAgents. Required

  • Returns JSON data.

  • Calculates the thermal conductivity of a drilling profile.

  • Arguments:

  • layers: array
    The rock layers.
    Subarray elements:
    rock: int, The rock types ID as retrieved via /rockTypes, 0 for custom rock type.
    length: int, The layer height in m.
    thermalConductivity: float, The rock type's thermal conductivity in W/(m·K), Required rock is 0. Required

  • Returns JSON data.

  • Calculates Reynolds number and judges flow behavior.

  • Arguments:

  • outsideDiameter: int
    The outside diameter of the geothermal probe in mm. Required
  • wallThickness: int
    The wall thickness of the geothermal probe in mm. Required
  • volumeFlow: float
    The total volume flow m^3/h. Required
  • numberOfCircuits: int
    The number of circuits, e.g., double U probes contain two circuits. Required
  • kinematicViscosity: float
    The kinematic viscocity in 10^-6 m^2/s Required

  • Returns JSON data.

  • Arguments:

  • annualHeatDemand: int
    The annual heat demand in kWh/a.
    Required
  • soilType: int
    The soil type ID as retrieved via /soilTypes.
    Required
  • climateZone: int
    The climate zone according to DIN 4710 as retrieved via /zip.
    Required
  • probes: int [1 - 5]
    The number of probes.
    Required
  • collectorType: int [1, 2]
    The collector type.
    A value of 1 indicates capillary tube mats.
    A value of 2 indicates PE pipes.
    Required
  • cop: float [1.5 - 7.0]
    The COP of the heat pump at B0/W35.
    Required
  • jaz: float [1.5 - 6.0]
    The JAZ of the heat pump appliance according to VD 4650-1.
    Required
  • heatingCapacity: float [1.0 - 30.0]
    The heating capacity of the heat pump at B0/W35 in kW.
    Required
  • flowBehavior: int [1, 2]
    The flow behavior within the geothermal probes.
    A value of 1 indicates laminar flow.
    A value of 2 indicates turbulent flow.
    Required

  • Returns JSON data.

  • Arguments:

  • annualHeatDemand: int
    The annual heat demand in kWh/a.
    Required
  • soilType: int
    The soil type ID as retrieved via /soilTypes.
    Required
  • climateZone: int
    The climate zone according to DIN 4710 as retrieved via /zip.
    Required
  • probes: int [1 - 5]
    The number of probes.
    Required
  • collectorType: int [1, 2]
    The collector type.
    A value of 1 indicates capillary tube mats.
    A value of 2 indicates PE pipes.
    Required
  • cop: float [1.5 - 7.0]
    The COP of the heat pump at B0/W35.
    Required
  • jaz: float [1.5 - 6.0]
    The JAZ of the heat pump appliance according to VD 4650-1.
    Required
  • heatingCapacity: float [1.0 - 30.0]
    The heating capacity of the heat pump at B0/W35 in kW.
    Required
  • flowBehavior: int [1, 2]
    The flow behavior within the geothermal probes.
    A value of 1 indicates laminar flow.
    A value of 2 indicates turbulent flow.
    Required

  • Returns a PDF file.