Microwaveprop API

Issue an API token

Prefer the account settings page for interactive use; this endpoint is here for scripts that need to mint a token without leaving the terminal.

Request body

email string required

Account email address.

password string required

Account password.

name string required

Human-readable label so you can identify the token later.

expires_at datetime

ISO 8601 UTC. Omit for a token that lives until revoked.

curl -X POST https://prop.w5isp.com/api/v1/auth/tokens \
  -H "Content-Type: application/json" \
  -d '{
    "email": "[email protected]",
    "password": "your password",
    "name": "iPad",
    "expires_at": "2027-01-01T00:00:00Z"
  }'

{
  "data": {
    "id": "01HX...",
    "name": "iPad",
    "inserted_at": "2026-05-09T12:34:00Z",
    "last_used_at": null,
    "expires_at": "2027-01-01T00:00:00Z",
    "revoked_at": null
  },
  "token": "mwp_AbCdEf..."
}

The authenticated user

Returns the user behind the bearer token: callsign, name, email, home QTH, and admin flag.

PATCH /me accepts any subset of home_grid, home_lat, home_lon, home_elevation_m. Grid is auto-derived from lat/lon and vice versa.

curl -H "Authorization: Bearer $TOKEN" \
  https://prop.w5isp.com/api/v1/me

curl -X PATCH \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"home_grid":"EM12kx"}' \
  https://prop.w5isp.com/api/v1/me

User-scoped collections

Two sibling endpoints return everything submitted under the authenticated user's account, newest first:

• GET /me/contacts — every QSO submitted by the user.
• GET /me/beacons — every beacon (approved or pending) submitted by the user.

Both honour standard page + per_page pagination.

curl -H "Authorization: Bearer $TOKEN" \
  "https://prop.w5isp.com/api/v1/me/contacts?per_page=20"

Manage your API tokens

GET /me/api-tokens lists every non-revoked token belonging to the authenticated user. The plaintext value is never returned — only the metadata (id, name, timestamps).

DELETE /me/api-tokens/:id revokes a token. The row is soft-deleted (its revoked_at is set) and any in-flight request using it is invalidated on the next call.

curl -H "Authorization: Bearer $TOKEN" \
  https://prop.w5isp.com/api/v1/me/api-tokens

curl -X DELETE \
  -H "Authorization: Bearer $TOKEN" \
  https://prop.w5isp.com/api/v1/me/api-tokens/01HX...

Beacon monitor stations

Distributed beacon monitor stations that report SNR samples back to Microwaveprop. Each monitor row has a token field — the credential the monitor program uses to identify itself when reporting.

Operations

• GET /me/beacon-monitors — list.
• POST /me/beacon-monitors — create. Returns the new monitor's plaintext token (shown once).
• DELETE /me/beacon-monitors/:id — revoke and remove.

curl -X POST \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"shack-pi","grid":"EM12kx"}' \
  https://prop.w5isp.com/api/v1/me/beacon-monitors

Public contact (QSO) feed

Paginated list of QSOs.

Query parameters

page integer

1-based. Defaults to 1.

per_page integer

Defaults to 50; capped at 200.

search string

One or two callsigns; matches station1 or station2.

When called with a bearer token, the user's own private contacts are included in addition to the public set.

GET /contacts/:id returns a single QSO. Private QSOs return 404 to non-owners.

curl "https://prop.w5isp.com/api/v1/contacts?search=W5XD&per_page=25"

Submit a QSO

Create a new QSO under the authenticated user's account; their email is recorded as submitter_email.

Required fields

station1 string required

Submitter callsign.

station2 string required

Other operator's callsign.

qso_timestamp datetime required

ISO 8601 UTC.

band string required

MHz integer string ("10000", "24000").

grid1 string required

4- or 6-character Maidenhead.

grid2 string required

Other end's grid.

mode string required

Mode (e.g. CW, SSB).

Optional fields

user_declared_prop_mode string

e.g. tropo, aircraft_scatter.

height1_ft number

Antenna height above ground.

height2_ft number

Other end's antenna height.

private boolean

Hide from the public feed.

notes string

Free-form text.

A duplicate (same stations + same hour + same band) returns 409 Conflict with the existing record in the existing field.

curl -X POST \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "station1": "W5XD",
    "station2": "K5XD",
    "qso_timestamp": "2026-05-08T12:34:00Z",
    "band": "10000",
    "grid1": "EM12",
    "grid2": "EM13",
    "mode": "CW"
  }' \
  https://prop.w5isp.com/api/v1/contacts

Beacons

GET /beacons lists approved beacons; GET /beacons/:id reads a single one.

POST /beacons is unauthenticated — the new beacon is created in approved=false state until an admin approves it via the website.

curl -X POST \
  -H "Content-Type: application/json" \
  -d '{
    "callsign": "WB5LUA/B",
    "frequency_mhz": 10368.025,
    "grid": "EM13qe",
    "power_w": 5
  }' \
  https://prop.w5isp.com/api/v1/beacons

Propagation score at a grid point

Returns the composite propagation score plus the per-factor breakdown (rain, humidity, refractivity, …) for one grid point at one band.

Query parameters

band integer required

MHz.

lat number required

Decimal degrees.

lon number required

Decimal degrees.

valid_time datetime

ISO 8601 UTC. Defaults to the latest scored hour.

GET /scores/bands lists every band the engine scores for, with each band's humidity-effect classification (beneficial / harmful).

curl "https://prop.w5isp.com/api/v1/scores?band=10000&lat=32.78&lon=-96.80"

48-hour score timeline

Returns the score at one grid point across the available forecast horizon (currently 48 hours). Same band + lat + lon parameters as /scores.

curl "https://prop.w5isp.com/api/v1/forecast?band=10000&lat=32.78&lon=-96.80"

Public per-user profile

Public per-user profile: callsign, name, home QTH, all public contacts involving the callsign, plus all approved beacons submitted by the user. Email is not exposed.

curl https://prop.w5isp.com/api/v1/profiles/W5XD