Sign in

v1

latestSwagger 2.0Creative Commons BY-SA 2.02026-07-17211539.2 KB
amateur

Request Amateur Radiosonde Telemetry Data

Use this to get the current state of all the radiosondes then use the realtime API to access streaming data. Do not regularly poll this endpoint, it is rate limited.

get/amateur/telemetry/{payload_callsign}

Path parameters

payload_callsignstring required

Specific callsign to query (if wanted). Requests for data for a single sonde will return the highest time resolution data available.

Query parameters

lastnumber

How far back to search in seconds. Defaults to 24hrs

datetimestring date-time

End time to query as an ISO-8601 time string. Defaults to now. Example: 2021-02-02T11:27:38.634Z

formatstring string

Valid options are csv, kml or json

Response

Returns a list of all data received

devstring

If this field is set then the payload will not be uploaded to the database. This is useful for development and testing.

software_namestring required

Name of the decoding software e.g. 'horusgui'

software_versionstring required

Version of the decoding software e.g. '1.4.0', '20210115'

uploader_callsignstring required

Callsign of the uploader Arbitrary string. Uploader position information and other metadata will be handled separately, but will need to match this callsign to enable calculation of listener statistics.

time_receivedstring date-time required

The time the telemetry packet was received. UTC time in YYYY-MM-DDTHH:MM:SS.SSSSSSZ format.

payload_callsignstring required

Callsign for the payload

datetimestring date-time required

Date/Time from the sonde's GPS, provided in YYYY-MM-DDTHH:MM:SS.SSSSSSZ format Some sondes (e.g. iMet, LMS6) do not provide the date portion of the timestamp. In this situation, the date portion should be added on by the receiver. An example of how to handle this problem is available here.

latnumber double required

Latitude (decimal degrees)

lonnumber double required

Longitude (decimal degrees)

altnumber double required

Altitude (metres)

frequencynumber float

Transmit frequency of the radiosonde in MHz.

tempnumber float

Measured Temperature (deg C)

humiditynumber float

Measured Relative Humidity (%)

vel_hnumber float

Horizontal Velocity (m/s)

vel_vnumber float

Horizontal Velocity (m/s)

pressurenumber float

Measured Pressure (hPa)

headingnumber float

Heading (degrees True)

battnumber float

Battery Voltage (volts)

satsnumber

Number of SVs used in position solution

snrnumber float

Signal-to-Noise ratio of the received signal, in dB

rssinumber float

Received-Signal-Strength-Indication of the radiosonde signal, nominally in dBm

uploader_positionnumber[]

Station position, as a list [lat, lon, alt].

uploader_antennastring

Station antenna/receiver information, free-text string.

telemetry_hiddenboolean

This field is usually set by the server and usually does not need to be set when uploading. This controls if the data should be shown in default dashboards and the website.

historicalboolean

Set this to true if uploading data in the past

upload_timestring date-time required

Set by the server to indicate the servers received time. Not not set this when uploading.