API Reference

This documentation describes the PolyNet API endpoints available for developers. All API responses are returned in JSON format.

Base URL: https://api.polynetproject.org/v1 or your local installation URL.

Station Endpoints

GET /api/stations_latest

Returns a list of all stations with their latest status information.

Parameters

None

Response

{
  "stations": [
    {
      "station": "SatNOGS01",
      "latitude": 37.9838,
      "longitude": 23.7275,
      "last_packet_time": 1650123456,
      "user": "SatNOGS"
    },
    {
      "station": "MyStation123",
      "latitude": 51.5074,
      "longitude": -0.1278,
      "last_packet_time": 1650123457,
      "user": "User123"
    }
  ]
}

GET /api/station_crc_error

Returns CRC error rates for a specific station grouped by day.

Parameters

Parameter Type Required Description
station string Yes The station identifier

Response

{
  "labels": ["2023-01-01", "2023-01-02", "2023-01-03"],
  "error_rates": [2.5, 3.1, 1.8]
}

GET /api/station_heatmap

Returns heatmap data for a specific station.

Parameters

Parameter Type Required Description
station string Yes The station identifier

Response

[
  {
    "packet_id": 1234,
    "sat_lat": 37.9838,
    "sat_lon": 23.7275,
    "rssi": -110
  },
  {
    "packet_id": 1235,
    "sat_lat": 38.1234,
    "sat_lon": 24.1234,
    "rssi": -105
  }
]

Satellite Endpoints

GET /api/satellites_latest

Returns the latest location for each satellite.

Parameters

None

Response

[
  {
    "satellite": "NORBI",
    "sat_lat": 37.9838,
    "sat_lon": 23.7275
  },
  {
    "satellite": "FossaSat-1",
    "sat_lat": 51.5074,
    "sat_lon": -0.1278
  }
]

GET /api/satellite_heatmap

Returns heatmap data for a specific satellite.

Parameters

Parameter Type Required Description
satellite string Yes The satellite name

Response

[
  {
    "packet_id": 1234,
    "rel_lat": 0.5,
    "rel_lon": 0.7,
    "rssi": -110
  },
  {
    "packet_id": 1235,
    "rel_lat": -0.3,
    "rel_lon": 1.2,
    "rssi": -105
  }
]

Data Analysis Endpoints

GET /api/overall_packets

Returns overall packet counts grouped by satellite and day.

Parameters

None

Response

{
  "labels": ["2023-01-01", "2023-01-02", "2023-01-03"],
  "datasets": [
    {
      "label": "NORBI",
      "data": [25, 30, 28],
      "borderColor": "rgba(255,99,132,1)",
      "fill": false
    },
    {
      "label": "FossaSat-1",
      "data": [15, 18, 22],
      "borderColor": "rgba(54,162,235,1)",
      "fill": false
    }
  ]
}

GET /api/overall_crc_error

Returns overall CRC error rates grouped by day.

Parameters

None

Response

{
  "labels": ["2023-01-01", "2023-01-02", "2023-01-03"],
  "error_rates": [2.1, 2.8, 1.5]
}

GET /api/overall_metric

Returns aggregated metrics averaged by day.

Parameters

Parameter Type Required Description
metric string Yes Metric to analyze (crc_error, rssi, snr, frequency)
start_date string (YYYY-MM-DD) No Start date for the data range
end_date string (YYYY-MM-DD) No End date for the data range

Response

{
  "labels": ["2023-01-01", "2023-01-02", "2023-01-03"],
  "values": [-105.2, -104.8, -106.1]
}

Search Endpoints

GET /api/search

Search for satellites or stations based on criteria.

Parameters

Parameter Type Required Description
entityType string Yes Type of entity to search for (satellite, station)
satelliteName string No Filter by satellite name (if entityType=satellite)
satelliteFrequency string No Filter by satellite frequency (if entityType=satellite)
satelliteAll string No Return all satellites (if entityType=satellite)
stationName string No Filter by station name (if entityType=station)
stationAll string No Return all stations (if entityType=station)

Response

{
  "results": [
    {
      "satellite": "NORBI",
      "frequency": "436.703"
    },
    {
      "satellite": "FossaSat-1",
      "frequency": "436.700"
    }
  ]
}