Base URL
All requests go to a single host. The environment is selected by your API key, not the URL.Authentication
Every request carries your API key in thex-api-key header. A sandbox key routes to simulated devices; a live key reaches real devices. See Authentication and Environments for the full picture.
How the reference is organised
Endpoints are grouped by device type. Each type follows the same pattern: list the devices, read one device’s state and capabilities, and, where the device supports control, push an action or update a setting.Battery
State, actions, settings, and action history for home batteries.
EV charger
State and charge-control actions for EV chargers.
HVAC
State and setpoint actions for heating and cooling.
Solar inverter
Read-only generation and state for solar inverters.
Vehicle
Read-only state for connected vehicles.
Schedules
Coordinate actions over time. The resource is coming soon; see the concept page for the shape and what works today.
Responses
A successful call returns the resource as JSON. A failure returns the canonical error envelope: a stablecode, a human-readable message, and optional details. See Error envelope for the shape and the full code list, and What to expect for the asynchronous action lifecycle that sits behind every push.