API Reference
The Sleep.me Public Developer API
Postman Examples
Click here to download examples (right-click, Save Link As…) for testing in Postman.
To get started, simply:
- Download Postman
- Import the example collection above
- Click Edit on the collection
- Head to the variables tab and update the value for the
SleepMeAPI_Token- BE SURE YOU SAVE on this screen!
- Now you should be able to hit any of the APIs
Property Definitions
Status
When you get or set a device’s status, you’ll work off a common payload. This payload includes 3 sub-sections: about, control, and status.
- about includes read-only data around the identity and definition of the device.
- control includes data about the current state of the device’s controllable properties, and indicates you can request changes to these. May vary based on device model.
- status includes read-only data about the current status of the device & other values. May vary based on device model.
Dock Pro
Please see the following table to determine the meanings & values for each property:
| Property | Definition | Valid Values |
|---|---|---|
| about.mac_address | The MAC Address of the control board inside this unit. | Valid MAC Address |
| about.model | The model of the device. | DP999NA = Dock Pro |
| about.firmware_version | The current loaded firmware version of the device. This can change as the unit upgrades. | Follows SemVer. No v in front of the string, just {major}.{minor}.{patch} |
| about.ip_address | The public IPv4 address of the WiFi the device is connected to. | IPv4 Address |
| about.lan_address | The LAN IP given to the device by the WiFi router. | IPv4 Address |
| about.serial_number | The serial number of the device. | |
| control.thermal_control_status | The state of the unit’s thermal control systems. A change to “active” will start the thermal control systems, “standby” will turn it off. | “standby”, “active” |
| control.set_temperature_f | The desired water temperature in fahrenheit. -1 indicates MAX COLD, 999 indicates MAX HEAT. Temperature must be a valid integer. | -1, 55-115, 999 |
| control.set_temperature_c | The desired water temperature in celsius. -1.0 indicates MAX COLD, 999.0 indicates MAX HEAT. Temperature must be in half degrees increments. | -1.0, 13.0-48.0, 999.0 |
| control.display_temperature_unit | How the temperature is shown on the unit’s display board. | “c”, “f” |
| control.time_zone | The time zone set on the device. Follows the global time zone standards for all Platform APIs. | Any IANA Time zone Name |
| status.is_connected | Indicates if the unit has a current active connection to the Sleepme platform or not. | true, false |
| status.water_level | Indicates if the current water level in the reservoir in percentage. | 0-100 |
| status.is_water_low | Indicates if the reservoir is low enough that it needs to be refilled. | true, false |
| status.water_temperature_f | Indicates the current temperature of the water flowing through the system in fahrenheit. | 55-115 |
| status.water_temperature_c | Indicates the current temperature of the water flowing through the system in celsius. | 13.0-48.0 |
Sleep Tracker
Please see the following table to determine the meanings & values for each property:
| Property | Definition | Valid Values |
|---|---|---|
| about.mac_address | The MAC Address of the control board inside this unit. | Valid MAC Address |
| about.model | The model of the device. | ST501NA = Tracker |
| about.firmware_version | The current loaded firmware version of the device. This can change as the unit upgrades. | Follows SemVer. No v in front of the string, just {major}.{minor}.{patch} |
| about.ip_address | The public IPv4 address of the WiFi the device is connected to. | IPv4 Address |
| about.lan_address | The LAN IP given to the device by the WiFi router. | IPv4 Address |
| about.serial_number | The serial number of the device. | |
| status.is_connected | Indicates if the unit has a current active connection to the Kryo Cloud or not. | true, false |
| status.user_detected | Indicates if a user is detected by the tracker | true, false |
| status.environment_humidity | Indicates the current environmental humidity | 0.0-100.0 |
| status.environment_temperature_f | Indicates the current environmental temperature in fahrenheit. | 55-115 |
| status.environment_temperature_c | Indicates the current environmental temperature in celsius. | 13.0-48.0 |
| status.bed_temperature_f | Indicates the current bed temperature in fahrenheit. | 55-115 |
| status.bed_temperature_c | Indicates the current bed temperature in celsius. | 13.0-48.0 |
| connectivity.is_connected | Indicates if the unit has a current active connection to the Sleepme platform or not. | true, false |
| connectivity.last_connected_at | The RFC3339 date-time of the last known connection of the device to the Sleepme platform. Precision is in milliseconds. | null or RFC 3339 date-time string |
| connectivity.last_disconnected_at | The RFC3339 date-time of the last known disconnection of the device from the Sleepme platform. Precision is in milliseconds. | null or RFC 3339 date-time string |
| connectivity.uptime | The duration, in seconds, since the last device connection event. | any unsigned 64-bit integer |