Documentation
API Widget lets you display data from your JSON API as a live iOS widget.
This documentation explains how the system works and how to get your widget running.
This documentation explains how the system works and how to get your widget running.
How it works
Using API Widget takes just a few simple steps:
1. Prepare a JSON API endpoint that returns key–value data.
2. Create an API Widget key that defines the widget type and visual theme.
3. Paste the key into the app and add the widget to your Home Screen.
Your widget will automatically refresh based on system conditions.*
* Widget update timing is managed by iOS WidgetKit and may vary.
1. Prepare a JSON API endpoint that returns key–value data.
2. Create an API Widget key that defines the widget type and visual theme.
3. Paste the key into the app and add the widget to your Home Screen.
Your widget will automatically refresh based on system conditions.*
* Widget update timing is managed by iOS WidgetKit and may vary.
What you can do
With the current version of API Widget, you can:
- display up to 12 rows of key–value data,
- apply built-in color styles per row,
- choose from multiple visual themes,
- keep live metrics visible on your Home Screen.
Start here 🚀
If this is your first time using API Widget, we recommend reading these sections next:
➡️ Getting Started — step-by-step setup guide
➡️ API Widget Key — key structure and usage examples
➡️ W12 Template — JSON format and supported options
➡️ Troubleshooting — common issues and solutions
➡️ Getting Started — step-by-step setup guide
➡️ API Widget Key — key structure and usage examples
➡️ W12 Template — JSON format and supported options
➡️ Troubleshooting — common issues and solutions