← Documentation

SensorPulse Localhost API

The read-only HTTP API delivers live sensor data as JSON. Default port 8765. Enable in SensorPulse: Settings → Automation → Localhost sensor API.

Default: The API listens on 127.0.0.1 only – safe for Rainmeter and scripts on the same PC.

Remote access

Optionally enable Remote access in Settings. SensorPulse then also listens on your LAN IPs on your home network or VPN – read-only, with API token.

Endpoints

PathDescription
GET /api/health{"status":"ok"} – connection test
GET /api/sensorsJSON array of all active sensors
GET /api/quicklookCompact CPU/GPU/RAM + alerts
GET /api/alertsActive warnings
GET /api/history/{sensorId}?minutes=60Sensor history

Authentication

When an API token is set (required for remote access):

Authorization: Bearer YOUR_TOKEN

Security

Rainmeter example

Download: Rainmeter skin (README). Copy to Documents\Rainmeter\Skins\. Localhost (127.0.0.1) only.