TRMNL API
HomeBuy a Device
  • 👋Overview
  • How it Works
  • Private Plugins
    • Screen Templating
    • Screen Templating (Graphics)
    • Create a screen
  • 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
  • How it works
  • Markup Quickstart
  1. Private API

Fetch Plugin Content

Retrieve parsed plugin JSON data for your own templates.

PreviousFetch Screen ContentNextAccount API

Last updated 4 days ago

No matter how many customizations we add to native plugins, there will always be a good reason to change them. Instead of cluttering our interface and adding complexity for other users, TRMNL offers a "data only" mode for select native plugins.

For more context on this feature, go .

How it works

First, set up + hide an instance of the plugin you want to re-build yourself with raw data. This instructs TRMNL to sync and parse data on your behalf.

  1. Connect the Weather, Stock Prices, or any Calendar plugin (more coming soon)

  2. Make note of the PluginSetting integer ID in the URL (/plugin_settings/<id-here>)

  3. Navigate to Playlists and "hide" the automatically added item by clicking the eyeball icon

Next, build a Private Plugin.

  1. Navigate to Plugins > Private Plugin, select "Polling" as the Strategy

  2. Input https://usetrmnl.com/api/plugin_settings/<id-here>/data as the Polling URL

  3. Input authorization=bearer <your-user-api-key> as the Polling Header*

*Find or generate a on your Account tab

Click save, then enter the Markup Editor.

Parsed data will appear inside a data node of the "Merge Variables" dropdown. You may need to click "Force Refresh" from the private plugin settings view to ensure the data has been fetched.

Markup Quickstart

If you only want to make small changes to the TRMNL native design, you can steal that markup here:

Just click the plugin you're rebuilding, and all layouts will appear with sample data embedded. If you've connected a plugin natively, your latest cached JSON will be embedded instead of demo data.

(requires login)

https://usetrmnl.com/plugins/demo
here
User API Key
Private Plugin > Edit Markup
Example - Google Calendar "data mode"