Documentation

From JSON API to home screen.

Everything you need to create trackers for any JSON API, write result formats, and pin live widgets to your home screen.

Getting Started

How to start

A tracker is the heart of Zync: it bundles a source, a result format, and how the result should look on your widget. A source is the API URL Zync reads; the result format turns the API response into the text on your widget. Once a tracker exists, pinning it as a widget takes one tap.

  1. Create a tracker

    Open the app and tap the + button. Give your tracker a name, paste any public JSON URL into source (the API URL) — e.g. https://api.example.com/weather — and optionally pick a category and write a short description. Save it, and it appears instantly on your main screen.

    To share a tracker with the community it must be https on a public domain (no raw IP or local/private host). Local-only trackers can use any address.

  2. Write the result format you want to see

    The result format tells Zync which part of the JSON response to display. Press TEST to see the raw response while you explore, then narrow it down — see Result format below for every trick it supports.
  3. Or install from the community

    Don't want to start from scratch? Browse the Community tab for ready-made trackers shared by other users, tap INSTALL, and it lands directly on your main screen — result format already configured.
  4. Pin the widget

    Open any tracker and tap Add to Home Screen. Your launcher asks for confirmation — accept it, and the widget appears on your home screen showing live data. Prefer the classic way? Long-press an empty spot on your launcher, open Widgets, find Zync, and drop it anywhere.
  5. Tune & switch anytime

    Every tracker has a theme (light, dark, transparent), a font size, and a refresh interval you can change at any time. Tap a widget's title to jump straight back into its configuration and swap which tracker it displays.