Skip to main content
This section currently covers battery information. You need the ID of a battery accessible to your client and an access token.

Read battery information

Set KAPA_BATTERY_ID to your battery ID, then send the token in the Authorization header:
The response describes the battery’s manufacturer, model, usable capacity, and nominal power ratings. Energy values use watt-hours (Wh), and power values use watts (W).

Units

Energy is in watt-hours (Wh), as integers. Battery levels are expressed as stored energy in Wh rather than state of charge in %, because the meaning of SoC differs between manufacturers. Stored energy is measured against the usable capacity: it ranges from 0 to usable_capacity_wh. Power ratings use watts (W). Nominal ratings such as nominal_charge_power_w are positive magnitudes.

Errors

Errors use RFC 9457 Problem Details (application/problem+json). The code field is stable and meant for programs; title and detail are meant for humans.