Data

Get a data module's current data over the HTTP API, and every field each module reports.

Get a module’s current data over HTTP.

Authentication

This endpoint requires authentication via the X-API-Token header or the token header.

Request

GET /api/data/{module}
X-API-Token: {token}

GET /api/data/{module}
token: {token}

{module} is one of: audio, battery, bluetooth, cameras, cpu, disks, discord, displays, gpus, media, memory, networks, processes, sensors, system.

Response

The response is the raw data for the requested module. The shape depends on the module. Most modules return a JSON object; displays, gpus, and processes return a JSON array of objects.

The same payloads are pushed over the WebSocket API as DATA_UPDATE messages.

audio

Each device has:

Each app has:

On Linux, the devices come from pactl, which needs PulseAudio 16 or later, or PipeWire with pipewire-pulse. Monitor sources, which capture an output, aren’t listed as inputs, and filters such as an equaliser aren’t listed as apps. On macOS all three lists are empty.

battery

The top-level battery fields are for the first system battery, and are null when there isn’t one. ac_connected is null when the system doesn’t report a power supply, as on most desktops, and on macOS.

Each item in batteries has name, model, serial, scope (system or device), state, percentage, time_remaining, power, and voltage. On Windows and macOS, batteries are named BAT0, BAT1 and so on, and connected devices usually aren’t listed.

On Linux, a connected device’s name can change when it reconnects, such as hidpp_battery_1 becoming hidpp_battery_2. Its serial stays the same, so use it to tell device batteries apart. serial is null when the driver doesn’t report one, and always on Windows and macOS.

bluetooth

Each device has:

On Linux, the devices come from BlueZ. On Windows, only classic Bluetooth devices are listed, so Bluetooth LE devices such as some keyboards and mice are left out. On macOS the list is empty.

cameras

Each camera has:

Each format has:

Each control has:

Metadata nodes are left out, so a webcam is listed once. The cameras are read without streaming from them, so they’re still listed while an app is using them. On Windows and macOS the list is empty.

cpu

disks

read_bytes_rate and write_bytes_rate are in bytes per second since the previous reading, in the total and on each disk. They are null on the first reading, and when a counter resets.

Each partition has device, mount_point, filesystem_type, options, category (primary, bind, or squashfs), and usage (total, used, free, percent).

discord

The state of the local Discord app. This module only exists once Discord is set up, and appears without a restart.

call has:

input and output each have:

Every field other than connected, authenticated and error is null until System Bridge is authenticated. Changes are pushed when they happen in Discord.

desktop

The open windows, workspaces and keyboard layout, from Hyprland, another Wayland desktop, or Windows. Changes are pushed when they happen, except on Windows, which is checked every second. It’s left out on macOS and X11.

Each window has id, app, title, pid, workspace (a workspace id), display, x, y, width, height, and whether it’s focused, fullscreen, maximised, minimised, floating, urgent and inhibiting_idle (keeping the screen awake). content_type is what the window says it shows, such as video or game. Fields a desktop doesn’t report are null. title is null unless you turn on Window titles on the web client’s Desktop page.

Window ids are Hyprland’s window addresses, Windows’ window handles, or numbers System Bridge gives windows on other Wayland desktops. Use them with desktop control.

Each workspace has id, name, display, windows (how many), and whether it’s active (shown on its display), focused, special (a Hyprland scratchpad) and fullscreen.

hyprland has:

omarchy has:

displays

Returns an array of objects, one per display.

On Linux without an X server, such as under Wayland, the displays come from the kernel’s DRM connectors instead. Then name is the monitor’s model from its EDID, and is_primary and pixel_clock are null. Under Hyprland, the resolution, refresh_rate and position are the mode Hyprland set. On other Wayland compositors, the resolution is the monitor’s preferred one, and the position and refresh_rate are null.

gpus

Returns an array of objects, one per GPU. Full metrics require an NVIDIA GPU; other GPUs report a subset (typically id, name, and memory).

media

Details of the current media session: title, artist, album_title, album_artist, subtitle, type, and status; playback state position, duration, playback_rate, volume, shuffle, repeat, and track_number; capability flags is_play_enabled, is_pause_enabled, is_stop_enabled, is_next_enabled, is_previous_enabled, is_seek_enabled, is_fast_forward_enabled, and is_rewind_enabled; a thumbnail; and updated_at. Available fields vary by operating system and media player.

On Linux, players lists every media player, each with an id, name, status (PLAYING, PAUSED or STOPPED), title and artist, plus the same track, playback, capability and thumbnail fields as above, so a client can show any of them. player is the id of the one the other fields describe, and MEDIA_CONTROL takes an id to control another. On Windows, players is empty and player is null.

memory

networks

Each interface address has address, family, netmask, broadcast, and ptp; interface stats has isup, duplex, speed, mtu, and flags. speed is the link speed in Mb/s, read on Linux only. It is null where the system doesn’t report one, such as wireless, virtual or disconnected interfaces. Interface io has the same fields as the combined io, for that interface only.

Interface wifi is null on wired and virtual interfaces. On wireless interfaces it has ssid (the network name), signal (signal strength in dBm), signal_percent (0 to 100, where -50 dBm or stronger is 100) and link_rate (the transmit rate in Mb/s). These are null while the interface isn’t connected. It’s read through nl80211 on Linux, so it works with NetworkManager, iwd and wpa_supplicant, and through the WLAN API on Windows. It’s always null on macOS.

bytes_sent_rate and bytes_recv_rate are in bytes per second since the previous reading. They are null on the first reading, and when a counter resets.

processes

Returns an array of objects, one per process.

sensors

system

{
    "boot_time": 1651433957.3015134,
    "fqdn": "Desktop",
    "hostname": "Desktop",
    "ip_address_4": "1.1.1.1",
    "mac_address": "aa:bb:cc:dd:ee:ff",
    "platform": "Windows",
    "platform_version": "10.0.22000",
    "uptime": 7.015625,
    "uuid": "abcd-efgh-abcd-efgh-abcd",
    "version": "5.0.2",
    "version_latest": "5.0.7",
    "version_newer_available": false
}