APIHub
Back to Explore

Cloud-RF API

The Cloud‑RF API provides a set of JSON endpoints for performing and managing radio‑frequency propagation analyses, including point‑to‑point and point‑to‑multipoint path profiling, heat‑map creation, clutter data upload, interference and network merging queries, and archival operations such as listing, deleting, and exporting calculations in GIS formats.

Telecom
apiKeyHeader
HTTPS
CORS: Unknown
Description enriched …
Visit official documentation

Latency

2115ms p95

Uptime

100.0% 30d

Playground

Verified

live

Endpoints

REST · JSON
GET

/archive/delete

Delete a calculation from the database.

  • cid (query, required) — Unique calculation ID number
GET

/archive/delete/network

Delete an entire network

  • nid (query, required) — Network name
GET

/archive/export

Export a calculation in a GIS file format

  • file (query, required) — Calculation file name
  • fmt (query, required) — Raster/Vector file format: KML, KMZ, SHP, GeoTIFF
GET

/archive/list

List calculations from your archive

  • n (query) — North bounding box
  • e (query) — East bounding box
  • s (query) — South bounding box
  • w (query) — West bounding box
POST

/area

Create a point-to-multipoint heatmap

POST

/clutter/add

Upload clutter data as GeoJSON

GET

/interference

Find the best server for overlapping coverage

  • network (query, required) — Network name eg. Overlapping broadcast stations
  • name (query, required) — Interference layer name eg. QRM_map
GET

/mesh

Merge sites into a super layer.

  • network (query, required) — Network name eg. 100_BLUE_repeaters_nationwide
  • name (query, required) — Super layer name eg. National_map
GET

/network

Find the best server for somewhere

  • net (query, required) — Network name
  • nam (query, required) — Super layer name
  • lat (query, required) — Latitude in decimal degrees
  • lon (query, required) — Longitude in decimal degrees
  • alt (query, required) — Height above ground level in metres
  • rxg (query) — Receiver gain in dBi
POST

/path

Point-to-point path profile analysis (Tx to Rx)

POST

/points

Point-to-multipoint path profile analysis (Many Tx, one Rx)

11 endpoints auto-detected

Authentication

This API uses an API key, passed in the "key" header. No OAuth required.

curl -X GET \
  "https://api.cloudrf.com/archive/delete" \
  -H "key: YOUR_API_KEY"

api.cloudrf.com · HTTPS only