For Developers, the Ham.Live APIs

For Developers, the Ham.Live APIs


For the most current view of available endpoints, go to https://www.ham.live/api (output below):


In the above, ":id" is either the unique net id or the unique user id (depending on the endpoint)

If you need the required JSON properties for POST/PATCH send me a support ticket.

Data APIs (JSON):

Admin (NCS/Logger) Interactions (JSON):
https://www.ham.live/api/admin/interactions/{NET ID} (GET) - Return command list
https://www.ham.live/api/admin/interactions/{NET ID} ( POST  { "cmdLine": "<command and args>" }  )  - Execute command

User (station) Interactions (sig reports, hand raise/lower, row highlighting, etc)

{
   "action": handState|sigReport|alterCheckState|highlightState
   "actionParams": (implementation-specific args for interaction)
   "dstStation": (target station) 
}

100% of the webapp ueses the APIs directly, via publicly available client-side JavaScript, so the API can be reasoned by looking at the source until this documentation is complete. 

    • Related Articles

    • How can I find out what nets are available ?

      "Live" / running nets are listed on the main Ham.Live homepage, just under the lobby. At the time of this writing there are 2 nets starting soon. If you don't see your favorite net listed, please contact your Net Control Operator and ask them to try ...

    • How do I change my profile picture?

      If your profile picture looks something like this: Ham.Live is getting your pic or "Gravatar" from a free service. Please update your pic at the following site: https://en.gravatar.com/ PS - If you logged in via Google, your profile pic is provided ...

    • How do I change my email address?

      Unfortunately email address changes are more of a 'lengthly' process than I'd like. This is actually for security reasons. Once a callsign is registered, no one else can enroll with the same callsign. To "free up" the callsign (in order to bind it to ...

    • Net Control Panel (shell commands)

      Commands Available to *both NCS and Loggers: ? (or 'help') :List all commands available to current user (this is a good way to view the more advanced commands also) ? <command> : Get help info on specific command i callsign : Check-in callsign to ...