API reference

HTTP, MQTT and webhook surface

OpenSense exposes one general-purpose ingest endpoint, a handful of transport-specific adapters (Shelly GET, MQTT bridge, TTN webhook), and a small REST surface for managing devices, sensors, alerts and reports.

Start with the overview for base URL, auth, errors and rate limits.

00 · auth+errorsOverview

Base URL, token types, error shape, idempotency, rate limits, pagination.

01 · push dataPOST /v1/ingest

The endpoint every device hits. cURL / Python / ESPHome / Arduino.

02 · pull dataRead measurements

Time-bucketed queries with raw / 5 min / 1 h / 1 d aggregation.

03 · rules + eventsAlerts

Channel rules, severity, escalation, the events stream.