FreeSTAR Network
Services.
Services and API
Services
FreeSTAR Network
The FreeSTAR API is the machine-readable view of the network: where to connect, which talkgroups and rooms exist, and who was heard recently. It is public JSON over HTTPS. There is no signup and no key for ordinary reads.
Base URL: https://api.freestar.network/v2/
Start here...
| What you want | Where to go |
|---|---|
| Full catalog (servers, destinations, bridges) | GET /directory |
| Who was heard (LastHeard) | GET /lastheard |
| Connected peers | GET /peers |
| Interactive documentation | /docs |
| Live dashboard | /metrics |
Prefer /directory for the catalog. One 200 response is the complete current list: servers, talkgroups, reflectors, AllStar nodes, and bridges. Objects that disappear from a later 200 have been removed. Occupancy is not in the directory — use /lastheard and /peers for that.
LastHeard covers YSF, NXDN, P25, M17, DMR (System-X and IPSC2), D-STAR, and AllStar. Callsigns are normalised on the API. The default window is 24 hours; snapshots older than 48 hours drop from public views. Filter by mode, for example:
https://api.freestar.network/v2/lastheard?mode=ysf&window=24h
Fair use
Public JSON is limited to 60 requests per hour per IP. That is a budget, not a required pause between calls. /docs, /schema, /health, and /metrics do not count.
If you poll /directory, send the previous ETag in If-None-Match: a 304 means nothing changed, you should keep your copy, and it does not use a quota slot. Polling every 15–30 minutes is plenty.
The OpenAPI specification is at /schema. The previous API remains at /v1/ on the same host.
Licence: GPL-3.0-or-later.
GET https://api.freestar.network/v2/directory GET https://api.freestar.network/v2/lastheard GET https://api.freestar.network/v2/lastheard?mode=dmr&window=24h GET https://api.freestar.network/v2/peers GET https://api.freestar.network/v2/docs
- JSON, snake_case, integer ports, no IP addresses in the directory.
- Stable ids look like
dmr:tg:23426andysf:reflector:23501. - DMR directory rows include the public join password. Unique per-master secrets are never listed.
- A 429 includes
Retry-Afterfor the rest of the current hour.
