Device API

Fetch the current screen

get/api/display/current

Request

  • Base URL: https://trmnl.com
  • URL: https://trmnl.com/api/display/current
  • Auth: none declared. Required headers: Access-Token

Headers

Access-Tokenstring required

Device API Key (eg. abc-123)

Response

Success

statusinteger
refresh_rateinteger
image_urlstring nullable
filenamestring nullable
rendered_atstring nullable

Example response

{
  "status": 200,
  "refresh_rate": 300,
  "image_url": "https://trmnl.com/images/system_screens/setup_logo/og_plus.png",
  "filename": "setup-logo.bmp",
  "rendered_at": "2023-01-01T00:00:00Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.