For the complete documentation index, see llms.txt. This page is also available as Markdown.

Introduction

Open endpoints that don't require authentication.

Every endpoint, parameter + response shape lives in our API reference, generated from our code + always current.

Whether you have a native TRMNL with Developer Edition, a BYOD license, or no device at all, you may benefit from publicly available data in JSON format.

No API key, no account. Just GET (or POST where noted) the URL. Full request + response schemas live in our API docs.

Endpoint
What you get

Search + sort community plugins (guide)

GET /recipes/{id}.json

One community plugin (guide)

Valid plugin categories (guide)

Supported device models -- dimensions, colors, bit depth, palettes + Framework CSS classes

Color palettes referenced by each model's palette_ids

POST /api/markup

Render a Liquid template with TRMNL's filters. Send markup (a string or an array of strings) + optional variables

IPv4 + IPv6 addresses of our servers. Plugin poll requests only come from these, so allowlist them behind a firewall

Latest production firmware for TRMNL OG -- model, version + url to the binary

Every published firmware version per model, as used by our web flasher

Open community bounties. Add ?completed=true for finished ones

/api/book/{token}/...

Walk-up room booking. The token comes from a room's public booking link, so no account is needed

/api/models, /api/palettes and /api/firmware/latest are cached for 5 minutes. Everything else is served fresh.

Last updated