Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.hoplynk.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Endpoint

WSS https://argus.hoplynk.com/api/kits/{kit_id}/ws

​
Query Parameters

ParameterTypeDefaultDescription
feedsstringgpsComma-separated feeds: gps, starlink, or gps,starlink
intervalfloat1.0Push interval in seconds (0.5–10)

​
Auth handshake

The WebSocket authenticates via a first-message handshake — your API key never appears in the URL. 
Client → Server:  { "type": "auth", "key": "hlk_..." }
Server → Client:  { "type": "ready", "feeds": ["gps"] }
Server → Client:  { "type": "data", "feed": "gps", "payload": {...}, "ts": "..." }

​
Data message schema

{
  "type": "data",
  "feed": "gps",
  "payload": {
    "lat": 31.111125,
    "lon": -93.273234,
    "source": "starlink",
    "stale": false
  },
  "ts": "2026-05-15T19:27:01.123Z"
}

​
Example

with client.kit_stream(kit_id, feeds=["gps", "starlink"]) as stream:
    for event in stream:
        if event["feed"] == "gps":
            p = event["payload"]
            print(p["lat"], p["lon"])

​
Error events

{ "type": "error", "message": "Invalid credentials" }
{ "type": "close", "code": 4001 }
The stream auto-reconnects on disconnect unless you call stream.close().