forked from ha7ilm/openwebrx
-
Notifications
You must be signed in to change notification settings - Fork 146
Jakob Ketterl edited this page Apr 21, 2021
·
19 revisions
Here are the API endpoints and the output:
Endpoint: /metrics
(Prometheus format)
# https://prometheus.io/docs/instrumenting/exposition_formats/
openwebrx_users 2
wsjt_decodes_40m_FT8_total 40484
wsjt_decodes_40m_FT4_total 1637
wsjt_decodes_40m_WSPR_total 170
wsjt_decodes_20m_FT8_total 385
wsjt_decodes_20m_FT8_total 21
aprs_decodes_2m_aprs_total_total 364
aprs_decodes_2m_aprs_direct_total 123
Endpoint: /metrics.json
(Generic JSON format)
{
"openwebrx": {
"users": 2
},
"aprs": {
"decodes": {
"2m": {
"aprs": {
"total": {
"count": 364
},
"direct": {
"count": 123
}
}
}
}
},
"wsjt": {
"decodes": {
"40m": {
"FT8": {
"count": 40484
},
"FT4": {
"count": 1637
},
"WSPR": {
"count": 170
}
},
"20m": {
"FT8": {
"count": 385
},
"FT4": {
"count": 21
}
}
}
}
}
Endpoint: /status.json
{
"receiver": {
"name": "CALL",
"admin": "email",
"gps": {
"lat": 0.0,
"lon": 0.0
},
"asl": 200,
"location": "City, Country"
},
"max_clients": 20,
"version": "v0.20.3",
"sdrs": [
{
"name": "RTL-SDR USB Stick",
"type": "RtlSdrSoapySource",
"profiles": [
{
"name": "2m komplett",
"center_freq": 145000000,
"sample_rate": 2400000
},
[...]
]
},
{
"name": "Hack RF",
"type": "HackrfSource",
"profiles": [
{
"name": "10m",
"center_freq": 28800000,
"sample_rate": 384000
},
[...]
]
}
]
}
Endpoint: api/features
An overview over all features and their availability, also including the necessary software components for them.
Supported Hardware
Setup Guide
Docker
Manual installation
Upgrading an installation
Migrating to OpenWebRX 1.0
RHEL specific notes
User Management
Configuration
Bookmarks
Background decoding
How to get openwebrx stats into collectd
Airspy HF+ and Discovery
Airspy R2 / Mini
HackRF
Perseus HF receiver
RTL-SDR
Radioberry
SDRPlay
HPSDR / Hermes-Lite 2
FiFi-SDR
AMBE vocoder