Skip to main content

Telemetry

Intro​

This page can serve as base examples on how your flight application will be able to retrieve and make use of on-board telemetry from within the satellite. More detailed specifications of the API can be found here. You can also test this API on the Ground by looking at the telemetry example section.

Base URL​

The base url for every request is the following:

http://satellite-telemetry.dphi-tm

It will be referred to as BASE_URL in the rest of the documentation.

Example Workflow for simple telemetry tasks​

  1. Check API status
curl "$BASE_URL/health"

Returns service status and timestamp.

  1. List available types
curl "$BASE_URL/api/telemetry/types"

Returns all supported telemetry types.

  1. Get telemetry records
curl "$BASE_URL/api/telemetry?datatype=attitude&limit=5"

Returns latest 5 attitude records.

WARNING: querying the endpoint without any parameter will cause the whole database to be returned, and therefore may timeout or fail if too many datapoints are present. We discourage relying on retrieving telemetry without constraining the query through time range parameters.

  1. Fetch stats or latest TLE
curl "$BASE_URL/api/telemetry/stats"
curl "$BASE_URL/api/telemetry/tle"

Returns telemetry stats or latest TLE string.

  1. Full example curl for telemetry data:
curl "$BASE_URL/api/telemetry?starttime=2025-01-01T00:00:00Z&endtime=2025-01-02T00:00:00Z&datatype=attitude&limit=10"

Fisheye images workflow​

To get the Images the Fisheye camera took, one can gather a list of files first :

curl "$BASE_URL/api/images/list"

An example of the returned JSON might look as follows :

{"success":true,"data":["example3.png","example2.png","example1.png"],"error":null,"count":3}

With this, one can either:

  • Get 1 single image, the result will be the image directly. One example to gather an image with curl would be :
curl -X POST -d '{"images": ["example3.png"]}' -H "Content-Type: application/json" http://satellite-telemetry.dphi-tm/api/images --output example3.png
  • Get multiple images zipped together :
curl -X POST -d '{"images": ["example3.png","example2.png"]}' -H "Content-Type: application/json" http://satellite-telemetry.dphi-tm/api/images --output example.zip
  • Finally get the whole set of images with a limit (Highly discouraged to go over 100 images as processing might take too long and timeout) :
curl -X POST -d '{"limit": 100}' -H "Content-Type: application/json" http://satellite-telemetry.dphi-tm/api/images --output example.zip

The zipped files are in fact not compressed, it uses the STORED algorithm, so it's more a convenient way to get multiple images at once.