The CloudRF API is a public scripting interface which allows developers to pull upon the power and data of CloudRF with just a few lines of code (in a language of your choice). You can integrate radio planning into your application or website without worrying about the heavy CPU, memory or disk resources required to do RF planning. It's up all year round, 24 hours a day.
Features
- Perform automated calculations from your data
- Schedule jobs to run when it suits you, 24/7 - human optional
- Human readable JSON output with URLs to images and text files
- All calculations reside in your CloudRF account once completed
- Automatically download KMZ files as you go and launch in Google Earth locally
- No additional cost once a plan has been purchased
- Test for free with a 30 day trial
- SSL Secured communication
- Submit your transmitter's parameters securely as a HTTP POST request and receive a link to either a KMZ/GTIFF overlay or a PNG image with WGS-84 geographic bounds. For companies looking to integrate RF planning into an existing project this API can save you hours of back-end development allowing you to concentrate on other things like presentation.
API reference
POSTMAN API docs and examples at api.cloudrf.com
Cilent code
HTML, Javascript, Python example scripts on Github
Example API request
curl --location --request POST "https://cloudrf.com/API/area" \ --header "Content-Type: application/x-www-form-urlencoded" \ --data "uid=21531&key=a8ec44b5ad85e0ab626e55f20e3cb5da111999a2&lat=50.355108&lon=-4.152938&txh=8&frq=868&rxh=2&dis=m&txw=0.1&txg=2.14&rxg=2.14&pm=1&pe=1&res=30&rad=6&out=2&rxs=-95&ant=38&azi=0&bwi=0.1&ber=0&blu=-120&clh=0&cli=5&cll=0&fbr=0&file=kmz&grn=-90&hbw=0&ked=0&mod=0&nam=DRAKES_ISLAND&net=DEVON&out=2&pol=v&red=-60&ter=15&tlt=0&vbw=0&col=10&rel=90&engine=2&rlat=50.355108&rlon=-4.12&file=json"
Example API (JSON) response
{
"Engine": "SLEIPNIR 1.0",
"Frequency MHz": 868,
"Propagation model": "ITM",
"Earth dielectric constant": 15,
"Earth conductivity": 0.00524,
"Radio climate": "Continental Temperate",
"Atmospheric bending constant": 301,
"Fraction of situations": 90,
"Fraction of time": 90,
"Receiver": [
{
"Latitude": 50.35511,
"Longitude": -4.12,
"Ground elevation m": 48,
"Antenna height m": 2,
"Receiver gain dBd": -0.01,
"Receiver gain dBi": 2.14
}
],
"Transmitters": [
{
"Latitude": 50.35511,
"Longitude": -4.152938,
"Ground elevation m": 9,
"Antenna height m": 8,
"Distance to receiver km": 2.337,
"Azimuth to receiver deg": 90,
"Downtilt angle deg": -0.8,
"Antenna gain dBd": -0.01,
"Antenna gain dBi": 2.14,
"Polarisation": "Vertical",
"Power W": "0.1",
"Power dBm": "20",
"ERP W": 0.1,
"EIRP W": 0.16,
"ERP dBm": 19.99,
"EIRP dBm": 22.14,
"Free space path loss dB": 102.7,
"Computed path loss dB": 108.8,
"Attenuation due to terrain dB": 6.1,
"Field strength at receiver dBuV/m": 51.5,
"Signal power at receiver dBm": -84.5,
"Signal power density at receiver": 3.71858e-10,
"RX voltage 50 ohm dipole uV": 17,
"RX voltage 50 ohm dipole dBuV": 25,
"RX voltage 75 ohm dipole uV": 21,
"RX voltage 75 ohm dipole dBuV": 26,
"Raise RX antenna for fresnel 60% m": 0,
"Raise RX antenna for full fresnel m": 0,
"Distance": [
0,
0.029,
0.058,
0.087,
0.115,
0.144,
0.173,
0.202,
0.231,
0.26,
0.288,
0.317,
0.346,
0.375,
0.404,
0.433,
0.462,
0.49,
0.519,
0.548,
0.577,
0.606,
0.635,
0.663,
0.692,
0.721,
0.75,
0.779,
0.808,
0.837,
0.865,
0.894,
0.923,
0.952,
0.981,
1.01,
1.039,
1.067,
1.096,
1.125,
1.154,
1.183,
1.212,
1.24,
1.269,
1.298,
1.327,
1.356,
1.385,
1.414,
1.442,
1.471,
1.5,
1.529,
1.558,
1.587,
1.615,
1.644,
1.673,
1.702,
1.731,
1.76,
1.789,
1.817,
1.846,
1.875,
1.904,
1.933,
1.962,
1.99,
2.019,
2.048,
2.077,
2.106,
2.135,
2.164,
2.192,
2.221,
2.25,
2.279,
2.308,
2.337,
2.337
],
"Terrain": [
17,
11,
9,
5,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
5,
15,
23,
25,
29,
36,
40,
41,
41,
39,
44,
48,
50
],
"Fresnel": [
0,
-5.7,
-8,
-9.7,
-11.2,
-12.4,
-13.5,
-14.5,
-15.4,
-16.2,
-16.9,
-17.6,
-18.3,
-18.9,
-19.5,
-20,
-20.5,
-21,
-21.4,
-21.8,
-22.2,
-22.6,
-22.9,
-23.2,
-23.5,
-23.8,
-24,
-24.3,
-24.5,
-24.7,
-24.9,
-25,
-25.2,
-25.3,
-25.4,
-25.5,
-25.6,
-25.6,
-25.7,
-25.7,
-25.7,
-25.7,
-25.7,
-25.7,
-25.6,
-25.6,
-25.5,
-25.4,
-25.3,
-25.2,
-25,
-24.9,
-24.7,
-24.5,
-24.3,
-24,
-23.8,
-23.5,
-23.2,
-22.9,
-22.6,
-22.2,
-21.8,
-21.4,
-21,
-20.5,
-20,
-19.5,
-18.9,
-18.3,
-17.6,
-16.9,
-16.2,
-15.4,
-14.5,
-13.5,
-12.4,
-11.2,
-9.7,
-8,
-5.7,
-0.4,
0
],
"dBm": [
-20,
-46.4,
-52.4,
-55.9,
-58.4,
-60.4,
-61.9,
-63.3,
-64.8,
-67.3,
-68,
-69.8,
-70.8,
-71.2,
-71.6,
-71.9,
-71.9,
-72,
-71.7,
-71.9,
-72.4,
-72.8,
-73.2,
-73.6,
-73.9,
-74.3,
-74.6,
-75,
-75.3,
-75.6,
-75.9,
-76.1,
-76.4,
-76.7,
-76.9,
-77.2,
-77.4,
-77.7,
-77.9,
-78.1,
-78.8,
-79.2,
-79.5,
-79.9,
-80.3,
-80.6,
-81,
-81.3,
-81.6,
-81.9,
-82.2,
-82.6,
-82.9,
-83.2,
-83.5,
-83.8,
-84.1,
-84.3,
-84.6,
-84.9,
-85.1,
-85.4,
-85.7,
-85.9,
-86.2,
-86.4,
-86.7,
-83.8,
-87.1,
-87.4,
-83.1,
-83.3,
-83.4,
-83.5,
-83.6,
-83.8,
-83.9,
-84,
-84.1,
-105.3,
-84.3,
-84.4,
-84.5
],
"dB": [
20,
70.7,
76.7,
80.2,
82.7,
84.6,
86.2,
87.6,
89.1,
91.6,
92.3,
94,
95.1,
95.5,
95.9,
96.2,
96.1,
96.2,
96,
96.2,
96.6,
97.1,
97.5,
97.9,
98.2,
98.6,
98.9,
99.2,
99.5,
99.9,
100.1,
100.4,
100.7,
101,
101.2,
101.5,
101.7,
101.9,
102.2,
102.4,
103.1,
103.4,
103.8,
104.2,
104.5,
104.9,
105.3,
105.6,
105.9,
106.2,
106.5,
106.8,
107.2,
107.5,
107.8,
108.1,
108.3,
108.6,
108.9,
109.1,
109.4,
109.7,
109.9,
110.2,
110.5,
110.7,
110.9,
108.1,
111.4,
111.7,
107.4,
107.6,
107.7,
107.8,
107.9,
108,
108.2,
108.3,
108.4,
129.6,
108.6,
108.7,
108.8
]
}
]
}