Documentation
REST API (v0.9 draft)
Pull detections into your platform over HTTPS.
Every Ridfinder receiver can stream what it hears to your system over HTTPS. This page documents the v0.9 draft: the endpoints are stable enough to build a prototype against, and the final schema is locked at firmware 1.0. Anything marked draft can still change — we flag breaking changes to registered integrators before they ship.
Authentication
Bearer token, passed in the Authorization header. The token is generated on the receiver’s local web UI and can be rotated without rebooting the unit. There are no OAuth flows on the device itself — if you need per-user tokens, put a thin proxy in front and we will help you design it.
Endpoints
GET /api/v1/status— firmware version, uptime, antenna state, current temperatureGET /api/v1/detections?since=— paginated detection records newer than a timestampGET /api/v1/detections/{id}— a single detection with full metadataPOST /api/v1/webhooks— register a callback URL; the unit POSTs on every new detection
Detection record (draft)
JSON, one object per detection:
{
"id": "d_01J8ZK...",
"seen_at": "2026-09-11T14:03:22Z",
"layer": "rid",
"protocol": "astm_f3411_remote_id",
"mac": "60:bb:35:...",
"rssi_dbm": -62,
"detail": { "serial": "...", "lat": 51.4, "lon": -0.9, "height_m": 41 }
}
Fields under detail vary by layer: RID detections decode identity and position; RF-spectrum detections carry band, bandwidth, duration and a confidence value instead. Both shapes are shown in the draft spec — request it and we send the PDF plus a Postman collection.
Not covered here: jamming, spoofing or any transmit-side function. The receivers are passive by design.
Content last reviewed: 2026-09-11. Interface draft v0.9 — locked against firmware 1.0. Questions: contact engineering.