Content & ServicesOpen PlatformNew
Get Device Status
Quick Guide
Prerequisites
- Make sure you have retrieved and saved your API key in the Dot. App;
- Make sure you own at least one device and have obtained its device serial number;
The API rate limit is 10 requests per second. With the API, you can control device behavior and responses more flexibly.
Placeholders wrapped in '{{variable}}' indicate values you must replace. Fill them with your actual values and remove the '{{}}' braces.
Request Examples
GET
/api/authV2/open/device/:id/statusGenerated Code
1// Generating...Response Example
{
"deviceId": "ABCD1234ABCD",
"alias": null,
"location": null,
"status": {
"version": "1.0.0",
"current": "Power Active",
"description": "The device is power active and ready to use",
"battery": "Charging",
"wifi": "-62 dBm"
},
"renderInfo": {
"last": "12/18/2025 14:11",
"current": {
"rotated": false,
"border": 0,
"image": ["https://example.com/render/0.png", "https://example.com/render/1.png"]
},
"next": {
"battery": "12/18/2025 17:11",
"power": "12/18/2025 14:16"
}
}
}Troubleshooting
Endpoint
/api/authV2/open/device/:id/status
Method
GET
Path Parameters
Prop
Type
Device serial number
Response Schema
The screen border color is returned as 0 for white or 1 for black.
Prop
Type
Device serial number
Name assigned by the user to identify the device.
User-assigned label for where the device is placed.
Current operating state, power status, and connection details.
Parameters
Firmware version running on the device.
Current operating state.
Human-readable explanation of the current operating state.
Battery charge or power status.
Wi-Fi signal strength.
Current screen content and refresh schedule.
Parameters
Most recent content refresh time.
Settings and images used for the current screen.
Parameters
Whether the screen is rotated
White or black screen border.
URLs of the images used for the current screen.
Upcoming content refresh times for each power source.
Parameters
Next content refresh while running on battery power.
Next content refresh while connected to power.
Status Codes
| code | Meaning | Description |
|---|---|---|
200 | Success | Successfully retrieved device status |
400 | Invalid params | Invalid device ID format |
401 | Unauthorized | Invalid or expired API key |
403 | Forbidden | No permission to view this device |
404 | Not found | Device not found or not registered |
500 | Server Error | Internal server error |
Did this solve your problem?
Join our community