Fetch Screen Content

Retrieve TRMNL image data, device-free.

First, purchase + set up a TRMNL device.

Alternatively you can pay a small subscription fee for server-only access. With this setup you'll provide your own hardware but have full access to the TRMNL web application for plugin management, content rendering, and all the other features enjoyed by TRMNL device owners. Email [e-mail] for more information.

Once you have an API Key -- accessible from your Devices > Edit > Developer Perks -- make a request like below. Just replace "xxxxx" with your API key.

curl https://usetrmnl.com/api/display --header "access-token:xxxxxx"

This will respond with several fields, for example:

{
  "status"=>0, # will be 202 if no user_id is attached to device
  "image_url"=>"https://trmnl.s3.us-east-2.amazonaws.com/path-to-img.bmp",
  "image_name"=>"2024-12-15T00:00:00",
  "update_firmware"=>false,
  "firmware_url"=>nil,
  "refresh_rate"=>"1800",
  "reset_firmware"=>false
}

The image_url is likely the most interesting to you, as this may be leveraged by your own hardware to render content however you see fit.

Note: TRMNL devices send a few additional values in the request headers by default, such as your WiFi connection strength (RSSI value), firmware version (ex: 1.3.7), and more.

These atrributes impact the response content by instructing the device to either update firmware, change its refresh rate, and so on. But excluding these values from your request is OK, just be aware that some response values may be nil.