WPSD API

WPSD has a simple API to retrieve last heard information in JSON format.

Many WPSD based repeaters are running on low power hardware at remote sites, often on low bandwidth links. You can use the API to provide a close to real time display of repeater activity by using an Internet facing host to cache and proxy the last heard list.

Accessing the API

The API can be accessed via the following URL pattern:

http://<hostname>/api

Where <hostname> is the name of the WPSD host.

Options

[General]

Option

Default

Description

limit=<integer>

None

Determins the number of entries returned. A lower number will reduce the load on the WPSD host, and return the data faster.

names=[true|false]

true

Resolve and display the name of the heard station.

country=[true|false]

true

Resolve and display the country of the heard station.

Examples

http://wpsd.local/api/?limit=10

Retrieve the last 10 entries in the heard list in JSON format from the host wpsd.local.

http://wpsd.local/api/?limit=10&names=false

Retrieve the last 10 entries in the heard list in JSON format from the host wpsd.local without the names field.

http://wpsd.local/api/?limit=10&country=false

Retrieve the last 10 entries in the heard list in JSON format from the host wpsd.local without the country field.

Sample Proxy Code

A basic PHP proxy client using APCu to cache the data is available at https://repo.w0chp.net/vk1kcm/viewapi.