Skip to main content
GET
Get total savings

Authorizations

x-api-key
string
header
required

Send your API key in the x-api-key header of every request. The key belongs to one Orbital account, and requests act as that account: they see and control only the devices it owns or has been given access to. A missing or unknown key gets 403 with { "message": "Forbidden" }.

Response

Success

totalSavedWater
number

Water saved by your active showers, in litres. Leaves out showers shared with you as maintenance.

Example:

18250.4

totalSavedEnergy
number

Energy saved by your active showers, in kWh. Leaves out showers shared with you as maintenance.

Example:

742.18