-
Notifications
You must be signed in to change notification settings - Fork 112
API‐Reference
accius edited this page Mar 5, 2026
·
1 revision
All API endpoints are served from the Express backend (server.js). External API calls are cached server-side to reduce upstream load.
| Endpoint | Method | Description | Cache |
|---|---|---|---|
/api/config |
GET | Station config (callsign, grid, features, version) | 1 hour |
/api/version |
GET | App version only (for auto-refresh polling) | No cache |
/api/health |
GET | Status dashboard (HTML) or JSON stats | No cache |
/api/settings |
GET | Server-synced UI settings (if SETTINGS_SYNC=true) |
No cache |
/api/settings |
POST | Save UI settings | Rate limited |
| Endpoint | Description | Cache |
|---|---|---|
/api/solar-indices |
SFI, SSN, Kp history + forecast from SWPC/N0NBH | 5 min |
/api/n0nbh |
Parsed N0NBH/HamQSL band conditions + solar data | 1 hour |
/api/noaa/flux |
SWPC solar flux (F10.7) | 5 min |
/api/noaa/kindex |
SWPC planetary K-index | 5 min |
/api/noaa/sunspots |
SWPC observed solar cycle indices | 5 min |
/api/noaa/xray |
SWPC X-ray flux (GOES primary) | 5 min |
/api/noaa/aurora |
SWPC OVATION aurora forecast | 30 min |
/api/solar/image/:type |
NASA SDO images (0193, 0304, 0171, 0094, HMIIC) | 15 min |
/api/moon-image |
NASA Dial-A-Moon photorealistic lunar image | 1 hour |
| Endpoint | Description | Cache |
|---|---|---|
/api/dxcluster/spots |
DX cluster spots (source selectable via query param) | 30 sec |
/api/dxcluster/paths |
DX spots with spotter/DX locations for map arcs | 25 sec |
/api/dxcluster/sources |
Available DX cluster source options | Static |
/api/myspots/:callsign |
Spots involving a specific callsign | 45 sec |
/api/rbn/spots |
RBN spots for a callsign (?callsign=XX&minutes=15) |
10 sec |
/api/rbn/location/:call |
Skimmer location lookup | Permanent |
| Endpoint | Description | Cache |
|---|---|---|
/api/pota/spots |
POTA activator spots | 90 sec |
/api/sota/spots |
SOTA activator spots (enriched with summit data) | 2 min |
/api/wwff/spots |
WWFF activator spots | 90 sec |
| Endpoint | Description | Cache |
|---|---|---|
/api/propagation |
Hybrid P.533 predictions for DE→DX path | 5 min |
/api/propagation/heatmap |
Reliability grid for VOACAP heatmap layer | 5 min |
/api/ionosonde |
Real-time ionosonde data from KC2G/GIRO | 10 min |
/api/wspr/heatmap |
WSPR propagation data from PSKReporter | 10 min |
| Endpoint | Description | Cache |
|---|---|---|
/api/satellites/tle |
TLE data for 34 curated ham satellites | 12 hours |
/api/satellites/debug |
Satellite resolution status (which resolved, which missing) | No cache |
| Endpoint | Description |
|---|---|
/api/pskreporter/stream/:identifier |
SSE stream for real-time spots (callsign or grid mode) |
/api/pskreporter/config |
MQTT proxy status and connection info |
/api/pskreporter/:callsign |
Stream connection info for a callsign |
| Endpoint | Description |
|---|---|
/api/wsjtx |
Full WSJT-X state (clients, decodes, QSOs, WSPR) |
/api/wsjtx/decodes |
Lightweight decode polling (?since=timestamp) |
/api/wsjtx/relay |
POST endpoint for remote relay agent |
/api/wsjtx/relay/agent.js |
Download relay agent source |
/api/wsjtx/relay/download/:platform |
Download pre-configured relay script |
| Endpoint | Description |
|---|---|
/api/contest/qsos |
GET recent contest QSOs; POST to ingest QSOs |
/api/n3fjp/qso |
POST a QSO from N3FJP bridge |
/api/n3fjp/qsos |
GET recent N3FJP QSOs |
| Endpoint | Description | Cache |
|---|---|---|
/api/callsign/:call |
Unified lookup: QRZ → HamQTH → prefix estimation | 24 hours |
/api/cty |
Full cty.dat DXCC entity database | 1 hour |
/api/cty/lookup/:call |
Single callsign prefix lookup | 1 hour |
| Endpoint | Description |
|---|---|
/api/dxpeditions |
DXpedition calendar from NG3K |
/api/contests |
Contest calendar from WA7BNM RSS |
/api/dxnews |
DX news headlines from dxnews.com |
/api/aprs/stations |
APRS-IS station positions |
/api/rotator/status |
Rotator azimuth reading |
/api/rotator/turn |
POST target azimuth |
/api/rotator/stop |
POST stop rotation |
/api/qrz/status |
QRZ API configuration status |
/api/update |
POST trigger manual update |
/api/update/status |
Auto-update status |
OpenHamClock · GitHub · Report an Issue · 73 de K0CJH