TRMNL API
HomeBuy a Device
  • 👋Overview
  • How it Works
  • Private Plugins
    • Screen Templating
    • Screen Templating (Graphics)
    • Create a screen
  • Reusing Markup
  • DIY TRMNL (Advanced)
    • Introduction
    • BYOD
    • BYOD/S
    • BYOS
  • ImageMagick Guide
  • Plugin Marketplace
    • Introduction
    • Plugin Creation
    • Plugin Installation Flow
    • Plugin Management Flow
    • Plugin Screen Generation Flow
    • Plugin Uninstallation Flow
    • Going Live
  • Private API
    • Introduction
    • Fetch Screen Content
    • Fetch Plugin Content
    • Account API
  • Partners API
    • Introduction
    • Getting Started
    • Provisioning Devices
Powered by GitBook
On this page
  1. Private API

Introduction

Advanced features available for Developer edition devices.

PreviousGoing LiveNextFetch Screen Content

Last updated 17 days ago

As outlined in our , TRMNL exposes a GET endpoint that responds with image and other content for your device to store or render.

GET /api/display

# request headers example
{
  'ID' => 'XX:XX:XX:XX',
  'Access-Token' => '2r--SahjsAKCFksVcped2Q'
}

# response body example
{
  "image_url"=>"https://trmnl.s3.us-east-2.amazonaws.com/path-to-img.bmp",
  "filename"=>"2025-05-10-plugin-T00:00:00",
  "update_firmware"=>false
}

With a device's API key you can request content without a TRMNL device or TRMNL firmware.

In the following Private API docs we'll outline a few ways to take advantage of this information for your own privacy, security, and experimentation purposes.

open source firmware