Skip to main content
GET
Get the live status of a shower

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" }.

Path Parameters

id
string
required

The unique identifier for the shower

Response

Request successful

online
boolean
required

Whether the shower answered within 5 seconds.

Example:

true

state
string | null

What the shower is doing, such as ready, starting, showering, paused, cleaning or hibernating. null when it didn’t answer.

Example:

"showering"

temperature_setpoint
number | null

Current temperature setpoint, in °C. null when the shower didn’t answer.

Example:

38

flow_setpoint
number | null

Current flow setpoint, in L/min. null when the shower didn’t answer.

Example:

9