Thermostat API Overview

There are six primary thermostat API categories which allows you to retrieve and set configurations, active statuses, schedules, and retrieve historical information. You can use these APIs to retrieve and/or write to individual thermostats, all thermostats, or a subsets of thermostats.

Thermostat Attributes

Thermostat attributes allow you to set and retrieve thermostat configurations and active statuses.

ThermostatSchedule Attributes

ThermostatSchedule attributes allow you to set and retrieve individual schedules for thermostats.

SharedSchedule Attribute

SharedSchedule attributes allow you to set and retrieve sharable schedules for thermostats.

ThermostatHistory Attributes

ThermostatHistory attributes allows you to retrieve thermostat historical readings and setpoint information.

ThermostatEvent Attributes

ThermostatEvents attributes allow you to retrieve or set one-time (or repeated) events that override a thermostat's standard recurring schedule.

ThermostatUsage Attributes

ThermostatUsage attributes allows you to retrieve thermostat run-time and consumption related historical information.