getLocationOverdriveStatus

GET

/location/{location_number}/overdrive_status

Per-circuit status of the location's overdrive. Overdrive is per-location — one entry applies to all circuits. set_overdrive is the location-wide requested value (°C); overdrive_applied and target_supply_setpoint are the per-circuit °C values actually realized.

Request

Authorization

API Key

Add parameter in header

X-ApiKey

Example:

X-ApiKey: ********************

Path Params

Responses

🟢200

application/json

successful operation

Bodyapplication/json

🟠400

🟠403

🟠404

🟠429

🔴500

Request Example

Shell

JavaScript

Java

Swift

curl --location '/location/10000001/overdrive_status' \
--header 'X-ApiKey: <api-key>'

Response Example

200 - Example 1

[
    {
        "circuit_id": 42,
        "set_overdrive": -2,
        "effective_from": "2026-06-08T06:00:00.000Z",
        "overdrive_applied": -2,
        "target_supply_setpoint": 53.3,
        "applied": true,
        "reason": "pending",
        "can_apply_overdrive": true,
        "observed_at": "2026-06-08T09:19:31.000Z"
    }
]

Modified at 2026-06-18 14:38:42

getOneLocationOverdriveSettings

getMonthlyConsumption