BWP-API: WPSim

Endpoint

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

  • No Arguments

  • Returns JSON data.

  • No Arguments

  • Returns JSON data.

  • No Arguments

  • Returns JSON data.

  • Simulates a heat pump system for the given input parameters.

  • Arguments:

  • zip: string
    The ZIP code used for the simulation. Required if designOutdoorTemperature is not provided. Conditional
  • designOutdoorTemperature: int
    The design outdoor temperature in °C. Required if zip is not provided. Conditional
  • heatingLimitTemperature: int [10, 12, 15]
    The heating limit temperature in °C. Only fixed values are allowed. Required
  • reference: string
    The reference dataset identifier. Required
  • heatingLoad: float
    The heating load in kW. Optional
  • operatingMode: int
    The operating mode ID. See /operatingModes. Required
  • maximumSupplementaryHeaterCoverage: float
    The maximum supplementary heater coverage in %. Required
  • heatPumpType: int
    The heat pump type ID. See /heatPumpTypes. Required

  • Returns JSON data.

  • thermalOutput: float
    The thermal output of the heating surface in W.

  • Exports a heat pump simulation using the same input parameters as /simulate.

  • Method: POST

  • Body: form-data

  • Returns JSON data.

  • zip: string
    The ZIP code used for the export. Required if designOutdoorTemperature is not provided. Conditional
  • designOutdoorTemperature: int
    The design outdoor temperature in °C. Required if zip is not provided. Conditional
  • heatingLimitTemperature: int
    The heating limit temperature in °C. Required
  • reference: string
    The reference dataset identifier. Required
  • heatingLoad: float
    The heating load in kW. Optional
  • operatingMode: int
    The operating mode ID. See /operatingModes. Required
  • maximumSupplementaryHeaterCoverage: float
    The maximum supplementary heater coverage in %. Required
  • heatPumpType: int
    The heat pump type ID. See /heatPumpTypes. Required