Skip to content
Mat Stace edited this page Jan 3, 2024 · 24 revisions

The Cloudlog API allows you to interact with Cloudlog via third-party tools, this might be radios, external logging applications or programs, you can generate two types of keys read-only or read/write depending on your requirements.

At any time you can come to this section and delete keys to remove access.

API/QSO/

The QSO function allows you to send ADIF QSO strings via JSON to be imported into Cloudlog, dupe checking is handled on the fly and you can send more than one QSO at a time.

{
    "key":"YOUR_API_KEY",
    "station_profile_id":"Station Profile ID Number",
    "type":"adif",
    "string":"<call:5>N9EAT<band:4>70cm<mode:3>SSB<freq:10>432.166976<qso_date:8>20190616<time_on:6>170600<time_off:6>170600<rst_rcvd:2>59<rst_sent:2>55<qsl_rcvd:1>N<qsl_sent:1>N<country:24>United States Of America<gridsquare:4>EN42<sat_mode:3>U/V<sat_name:4>AO-7<prop_mode:3>SAT<name:5>Marty<eor>"
}
  • station_profile_id - This can be found when editing a station profile its a number and displayed in the URL string.

API/Radio

Standard Radio API Call

{
   "key":"YOUR_API_KEY", 
   "radio":"FT-950",
   "frequency":14075,
   "mode":"SSB",
   "power": '', // Optional field defined in watts
   "timestamp":"2012/04/07 16:47"
}

Satellite Data

{
   "key":"YOUR_API_KEY",
   "radio":"SATPC32",
   "uplink_freq": "2400210000",
   "downlink_freq": "10489710000", 
   "uplink_mode": "SSB", 
   "downlink_mode": "SSB", 
   "satmode": "S/X", 
   "satname": "QO-100", 
   "power": '', // Optional field defined in watts
   "timestamp":"2012/04/07 16:47" 
}

Radio API Call - Cloudlog v2

{
    "key": "YOUR_API_KEY",          // API-Key
    "radio": "QO-100 Station",      // Name of the radio (used for assigning received data)
    "frequency": "2400170000",      // Frequency in Hz
    "mode": "SSB",                  // Mode
    "frequency_rx": "10489670000",  // Optional Rx frequency in Hz
    "mode_rx": "SSB",               // Optional Rx mode (not logged)
    "prop_mode": "SAT",             // Optional propagation mode
    "sat_name": "QO-100",           // Optional satellite name
    "power": "5",                   // Optional transmit power in Watts
}

API/logbook_check_callsign

This allows you to check if a callsign is in the logbook

{
    "key":"", // Cloudlog API Key
    "logbook_public_slug":"", // This is the Station Logbook Public Slug
    "band":"2m", // This is optional if you want to search satellite qsos only set the band as SAT
    "callsign":""
}

API/logbook_check_grid

This allows you to check if a grid is in the logbook

{
    "key":"", // Cloudlog API Key
    "logbook_public_slug":"", // This is the Station Logbook Public Slug
    "band":"2m", // This is optional if you want to search satellite qsos only set the band as SAT
    "grid":""
}

API/statistics

Returns the active profile stats that would show on the dashboard

  • Todays QSOs
  • Months QSOs
  • Years QSOs
  • Total QSOs

For this to work via V2 of Cloudlog and public access (i.e. not logged in) you need to provide a valid (e.g. read-only) API key in the URL. That simply needs to be set on the URL like:

https://m0abc.cloudlog.co.uk/index.php/api/statistics/clPutYourApiKeyHere

API/station_info

Returns information about stations (logbook locations) belonging to the user who has the corresponding API key:

[
{
station_id: "1",
station_profile_name: "JO30oo / DJ7NT",
station_gridsquare: "JO30OO",
station_callsign: "DJ7NT",
station_active: "1"
},
{
station_id: "2",
station_profile_name: "JO30oo / DO7INT",
station_gridsquare: "JO30OO",
station_callsign: "DO7INT",
station_active: null
}
]

For this to work via V2 of Cloudlog and public access (i.e. not logged in) you need to provide a valid (e.g. read-only) API key in the URL. That simply needs to be set on the URL like:

https://m0abc.cloudlog.co.uk/index.php/api/station_info/clPutYourApiKeyHere

Legacy XML Query API

Cloudlog does have an API which can query the database see its page for more information Legacy XML API

Clone this wiki locally