Skip to main content
GET
/
api
/
dhw
Get DHW tank status
curl --request GET \
  --url http://aris.local/api/dhw \
  --header 'Authorization: Bearer <token>'
{
  "dhwId": "dhw_main",
  "tempTopC": 51.2,
  "tempBottomC": 45.1,
  "heatingActive": false,
  "recircEnabled": true,
  "tempMidC": 48.7,
  "stateOfChargePercent": 75,
  "effectiveCapacityLiters": 242,
  "isSanitizing": false,
  "dhwDeliveryTempC": 48.5,
  "dhwColdSupplyTempC": 12.3,
  "backupHeaterActive": false,
  "recircPumpActive": false,
  "lastSanitizationTs": "2024-01-15T03:00:00Z"
}

Authorizations

​
Authorization
string
header
required

Session token or API token

Response

DHW tank status

Domestic hot water tank status. The DHW tank stores potable hot water and acts as part of the Aris thermal-storage strategy. A mixing valve ensures delivered water temperature remains stable and scald-safe, independent of internal tank temperature.

​
dhwId
string
required

Unique identifier for the DHW tank

Example:

"dhw_main"

​
tempTopC
number
required

Temperature at the top of the tank (Celsius). Primary indicator of available hot water since hot water is drawn from the top.

Example:

51.2

​
tempBottomC
number
required

Temperature at the bottom of the tank (Celsius). Indicates remaining cold mass and total usable energy. Cold water enters at the bottom during draws.

Example:

45.1

​
heatingActive
boolean
required

True when the tank is currently being charged by the HCU

Example:

false

​
recircEnabled
boolean
required

True if the home has a DHW recirculation loop installed

Example:

true

​
tempMidC
number

Mid-layer temperature (Celsius). Improves stratification accuracy for state of charge calculations. Only present if the tank has a mid-layer sensor installed.

Example:

48.7

​
stateOfChargePercent
integer

Calculated energy level (0-100%) based on stratification vs target temperatures. Computed by the Brain from temperature readings. Only present when Brain has sufficient data to calculate.

Required range: 0 <= x <= 100
Example:

75

​
effectiveCapacityLiters
number

Usable hot water capacity (liters) accounting for mixing valve boost effect. Because the mixing valve blends tank water with cold supply, the effective capacity can exceed the physical tank volume. Computed by the Brain.

Example:

242

​
isSanitizing
boolean

True during active Legionella sanitization cycle. The tank is heated to an elevated temperature (~65C) to kill bacteria. Normal operation resumes after the cycle completes.

Example:

false

​
dhwDeliveryTempC
number

Temperature of mixed hot water delivered to fixtures (Celsius), measured after the mixing valve. Primary indicator of user experience and scald protection. Only present if delivery temperature sensor is installed.

Example:

48.5

​
dhwColdSupplyTempC
number

Temperature of incoming cold water supply (Celsius). Used for energy calculations and freeze protection alerts. Only present if cold supply sensor is installed.

Example:

12.3

​
backupHeaterActive
boolean

Whether the electric backup heater (if present) is currently energized. Used for resiliency and extreme-condition recovery when heat pump cannot meet demand.

Example:

false

​
recircPumpActive
boolean

True if the recirculation pump is currently running. Only present if recirculation is enabled.

Example:

false

​
lastSanitizationTs
string<date-time>

ISO 8601 timestamp (UTC) of the last completed Legionella sanitization cycle. Used for maintenance scheduling and compliance reporting.

Example:

"2024-01-15T03:00:00Z"