Skip to main content
GET
Retrieve Device Status

Authorizations

Authorization
string
header
required

Short-lived session token obtained from POST /api/sessions/v2. Send it as Authorization: Bearer <session_token> together with the X-Device-Key: <device-key> header identifying the target device.

Headers

X-Device-Key
string
required

Device Key (4 BIP39 words) identifying the target device. Obtain it from POST /device/otp/confirm/v2.

Pattern: ^[a-z]+-[a-z]+-[a-z]+-[a-z]+$
Example:

"orbit-ranch-silver-tomato"

Response

200 - application/json

OK

Live device status. A field sitting at its zero value (battery_level: 0, ble_connected: false) is omitted from the response, so no field is guaranteed present — read an absent field as its zero value.

device_time
integer<int64>

The current time of the device. Epoch time in milliseconds.

Example:

1723251774000

battery_level
integer<int32>

The current battery level of the device. Range: 0 to 100.

Example:

42

wifi_rssi
integer<int32>

The current WiFi signal strength of the device. Range: -100 to 10 dB.

Example:

1

battery_voltage
number<float>

The current battery voltage.

Example:

12.4

temperature_sensor_1
number<float>

Temperature reading from sensor 1 in Celsius.

Example:

22.5

temperature_sensor_2
number<float>

Temperature reading from sensor 2 in Celsius.

Example:

23.1

wifi_connected
boolean

Indicates if the device is connected to WiFi.

Example:

true

ble_connected
boolean

Indicates if the device is connected to BLE.

Example:

false

charging_status
integer<int32>

Charging status of the device.

  • 0: Not charging
  • 1: Charging
  • 2: Charged
Example:

0