Download OpenAPI specification:
The CloudRF API enables users to model and test radio propagation for any radio, anywhere. Authenticate by passing your API key in the request header as key. Set up a CloudRF.com account to generate this key. All data is transferred as JSON. For detailed documentation, visit docs.cloudrf.com.
This set of endpoints allows the user to create new links, site heatmaps, routes, and networks.
This endpoint returns an omni-directional coverage plot (point-to-multipoint) as an image. This function assumes a consistent receiver height at all locations out to fixed radius. Speed can be improved by adjusting the resolution with the "res" parameter. A standard request requires a transmitter, receiver, antenna and output objects. Providing a model and environment enhances accuracy.
The request payload providing the site properties.
| site | string [ 2 .. 50 ] characters Default: "A1" Site name. |
| network required | string [ 2 .. 50 ] characters Default: "Testing" Network name/group. |
| engine | number <float> Default: 2 Enum: 1 2 Processing engine to handle the request:
|
required | object |
required | object (Receiver) |
required | object (Antenna) |
object (Model) | |
object (Environment) | |
required | object (OutputWithBounds) |
{- "site": "A1",
- "network": "Testing",
- "transmitter": {
- "lat": 38.916,
- "lon": 1.448,
- "alt": 2,
- "frq": 446,
- "txw": 1,
- "bwi": 1
}, - "receiver": {
- "lat": 0,
- "lon": 0,
- "alt": 2,
- "rxg": 3,
- "rxs": -100
}, - "antenna": {
- "txg": 2.15,
- "txl": 0,
- "ant": 0,
- "azi": 90,
- "tlt": 1,
- "hbw": 120,
- "vbw": 30,
- "pol": "v"
}, - "environment": {
- "clt": "Minimal.clt",
- "elevation": 1,
- "landcover": 0,
- "buildings": 0,
- "obstacles": 0
}, - "output": {
- "units": "metric",
- "col": "RAINBOW.dBm",
- "out": 2,
- "nf": -100,
- "res": 10,
- "rad": 5
}
}{- "bounds": [
- [
- 38.97373,
- 1.505727,
- 38.85827,
- 1.390273
]
], - "id": "3930916",
- "sid": "M2ZSaUZuVlVDRno3TTJDTGVqRGJlUT09",
- "area": 0,
- "coverage": "0%",
- "key": [
- [
- {
- "l": "-20dBm",
- "r": 255,
- "g": 19,
- "b": 0
}, - {
- "l": "-24dBm",
- "r": 255,
- "g": 61,
- "b": 0
}, - {
- "l": "-28dBm",
- "r": 255,
- "g": 102,
- "b": 0
}, - {
- "l": "-32dBm",
- "r": 255,
- "g": 144,
- "b": 0
}, - {
- "l": "-36dBm",
- "r": 255,
- "g": 185,
- "b": 0
}, - {
- "l": "-40dBm",
- "r": 255,
- "g": 227,
- "b": 0
}, - {
- "l": "-44dBm",
- "r": 242,
- "g": 255,
- "b": 0
}, - {
- "l": "-48dBm",
- "r": 200,
- "g": 255,
- "b": 0
}, - {
- "l": "-52dBm",
- "r": 159,
- "g": 255,
- "b": 0
}, - {
- "l": "-56dBm",
- "r": 117,
- "g": 255,
- "b": 0
}, - {
- "l": "-60dBm",
- "r": 76,
- "g": 255,
- "b": 0
}, - {
- "l": "-64dBm",
- "r": 34,
- "g": 255,
- "b": 0
}, - {
- "l": "-68dBm",
- "r": 0,
- "g": 255,
- "b": 7
}, - {
- "l": "-72dBm",
- "r": 0,
- "g": 255,
- "b": 49
}, - {
- "l": "-76dBm",
- "r": 0,
- "g": 255,
- "b": 90
}, - {
- "l": "-80dBm",
- "r": 0,
- "g": 255,
- "b": 132
}, - {
- "l": "-84dBm",
- "r": 0,
- "g": 255,
- "b": 173
}, - {
- "l": "-88dBm",
- "r": 0,
- "g": 255,
- "b": 215
}, - {
- "l": "-92dBm",
- "r": 0,
- "g": 254,
- "b": 255
}, - {
- "l": "-96dBm",
- "r": 0,
- "g": 212,
- "b": 255
}, - {
- "l": "-100dBm",
- "r": 0,
- "g": 171,
- "b": 255
}, - {
- "l": "-104dBm",
- "r": 0,
- "g": 129,
- "b": 255
}, - {
- "l": "-108dBm",
- "r": 0,
- "g": 88,
- "b": 255
}, - {
- "l": "-112dBm",
- "r": 0,
- "g": 46,
- "b": 255
}
]
], - "elapsed": 1572,
- "balance": 1,
- "calculation_adjusted": [
- [
- "Resolution has been reduced from 30m to 54m due to your plan. Your proposed calculation would exceed your plans megapixel limit of 5MP.",
- "10m landcover is disabled for calculations with a radius greater than 50KM.",
- "10m landcover is disabled for calculations with a resolution of greater than 30m.",
- "3D buildings are disabled for calculations with a radius greater than 20KM.",
- "3D buildings are disabled for calculations with a resolution greater than 30m."
]
]
}This endpoint allows users to analyse a point-to-point path. A path profile is a single link from A to B. A basic request requires transmitter, receiver, antenna, and output objects; providing the model and environment objects enhances accuracy.
| site | string [ 2 .. 50 ] characters Default: "Link" Site name. |
| network | string [ 2 .. 50 ] characters Default: "Testing" Network name/group. |
required | object (Transmitter) |
required | object (Antenna) |
required | object (Receiver) |
object (Model) | |
object (Environment) | |
required | object (Output) |
{- "site": "Link",
- "network": "Testing",
- "transmitter": {
- "lat": 38.916,
- "lon": 1.448,
- "alt": 1,
- "frq": 446,
- "txw": 1,
- "bwi": 1
}, - "antenna": {
- "txg": 2.15,
- "txl": 0,
- "ant": 0,
- "azi": 90,
- "tlt": 1,
- "fbr": 0,
- "hbw": 120,
- "vbw": 30,
- "pol": "v"
}, - "receiver": {
- "lat": 38.906986,
- "lon": 1.421416,
- "alt": 0.1,
- "rxg": 3,
- "rxs": -100
}, - "model": {
- "pm": 4,
- "pe": 2,
- "ked": 4,
- "rel": 50
}, - "environment": {
- "clt": "Minimal.clt",
- "elevation": 1,
- "landcover": 0,
- "buildings": 0,
- "obstacles": 0
}, - "output": {
- "units": "m",
- "col": "RAINBOW.dBm",
- "out": 2,
- "ber": 2,
- "mod": 7,
- "nf": -100,
- "res": 20
}
}{- "Engine": "Sleipnir 1.18",
- "Frequency MHz": 868,
- "Propagation model": "ITM",
- "Earth dielectric constant": 14,
- "Earth conductivity": 0.01,
- "Radio climate": "Maritime Temperate (Land)",
- "Atmospheric bending constant": 301,
- "Fraction of situations": 90,
- "Fraction of time": 90,
- "Receiver": {
- "Latitude": 38.90699,
- "Longitude": 1.421416,
- "Ground elevation m": 13,
- "Antenna height m": 0.1,
- "Receiver gain dBd": 0.85,
- "Receiver gain dBi": 3
}, - "Transmitters": {
- "Latitude": 38.916,
- "Longitude": 1.448,
- "Ground elevation m": 0,
- "Antenna height m": 1,
- "Height above sea level m": 2,
- "Distance to receiver km": 2.512,
- "Azimuth to receiver deg": 246.46,
- "Downtilt angle deg": 0.3,
- "Antenna gain dBd": -1,
- "Antenna gain dBi": 1.15,
- "Polarisation": "Horizontal",
- "Power W": 0.1,
- "Power dBm": 21.15,
- "ERP W": 0.08,
- "EIRP W": 0.13,
- "ERP dBm": 19,
- "EIRP dBm": 21.15,
- "Free space path loss dB": 95.1,
- "Bandwidth MHz": 1,
- "Johnson Nyquist noise dB": 10.2,
- "Noise floor dBm": -100,
- "Channel noise dBm": -89.8,
- "Signal power at receiver dBm": -205.6,
- "Signal to Noise Ratio dB": -115.8,
- "Computed path loss dB": 225.6,
- "Model attenuation dB": 130.6,
- "Field strength at receiver dBuV/m": -68.5,
- "RX voltage 50 ohm dipole uV": 0,
- "RX voltage 50 ohm dipole dBuV": -95,
- "RX voltage 75 ohm dipole uV": 0,
- "RX voltage 75 ohm dipole dBuV": -94,
- "Raise RX antenna for LOS": 100.1,
- "Raise RX antenna for fresnel 60%": 313.1,
- "Raise RX antenna for full fresnel": 445.1,
- "Obstructions": [
- [
- 38.90701,
- 1.421483
], - [
- 38.90708,
- 1.421693
], - [
- 38.90719,
- 1.422009
], - [
- 38.90919,
- 1.427901
], - [
- 38.90926,
- 1.428112
], - [
- 38.90936,
- 1.428427
], - [
- 38.91357,
- 1.440844
], - [
- 38.91379,
- 1.441475
], - [
- 38.91382,
- 1.441581
], - [
- 38.9139,
- 1.441791
], - [
- 38.91393,
- 1.441896
], - [
- 38.91397,
- 1.442002
], - [
- 38.91404,
- 1.442212
], - [
- 38.91579,
- 1.447369
], - [
- 38.91582,
- 1.447474
], - [
- 38.91586,
- 1.447579
], - [
- 38.91589,
- 1.447684
], - [
- 38.91593,
- 1.44779
]
], - "Distance": [
- 0.01,
- 0.02,
- 0.03,
- 0.04,
- 0.05,
- 0.06,
- 0.07,
- 0.08,
- 0.089,
- 0.099,
- 0.109,
- 0.119,
- 0.129,
- 0.139,
- 0.149,
- 0.159,
- 0.169,
- 0.179,
- 0.189,
- 0.199,
- 0.209,
- 0.219,
- 0.229,
- 0.239,
- 0.249,
- 0.259,
- 0.268,
- 0.278,
- 0.288,
- 0.298,
- 0.308,
- 0.318,
- 0.328,
- 0.338,
- 0.348,
- 0.358,
- 0.368,
- 0.378,
- 0.388,
- 0.398,
- 0.408,
- 0.418,
- 0.428,
- 0.437,
- 0.447,
- 0.457,
- 0.467,
- 0.477,
- 0.487,
- 0.497,
- 0.507,
- 0.517,
- 0.527,
- 0.537,
- 0.547,
- 0.557,
- 0.567,
- 0.577,
- 0.587,
- 0.597,
- 0.606,
- 0.616,
- 0.626,
- 0.636,
- 0.646,
- 0.656,
- 0.666,
- 0.676,
- 0.686,
- 0.696,
- 0.706,
- 0.716,
- 0.726,
- 0.736,
- 0.746,
- 0.756,
- 0.766,
- 0.776,
- 0.785,
- 0.795,
- 0.805,
- 0.815,
- 0.825,
- 0.835,
- 0.845,
- 0.855,
- 0.865,
- 0.875,
- 0.885,
- 0.895,
- 0.905,
- 0.915,
- 0.925,
- 0.935,
- 0.945,
- 0.954,
- 0.964,
- 0.974,
- 0.984,
- 0.994,
- 1.004,
- 1.014,
- 1.024,
- 1.034,
- 1.044,
- 1.054,
- 1.064,
- 1.074,
- 1.084,
- 1.094,
- 1.104,
- 1.114,
- 1.124,
- 1.133,
- 1.143,
- 1.153,
- 1.163,
- 1.173,
- 1.183,
- 1.193,
- 1.203,
- 1.213,
- 1.223,
- 1.233,
- 1.243,
- 1.253,
- 1.263,
- 1.273,
- 1.283,
- 1.293,
- 1.302,
- 1.312,
- 1.322,
- 1.332,
- 1.342,
- 1.352,
- 1.362,
- 1.372,
- 1.382,
- 1.392,
- 1.402,
- 1.412,
- 1.422,
- 1.432,
- 1.442,
- 1.452,
- 1.462,
- 1.471,
- 1.481,
- 1.491,
- 1.501,
- 1.511,
- 1.521,
- 1.531,
- 1.541,
- 1.551,
- 1.561,
- 1.571,
- 1.581,
- 1.591,
- 1.601,
- 1.611,
- 1.621,
- 1.631,
- 1.641,
- 1.65,
- 1.66,
- 1.67,
- 1.68,
- 1.69,
- 1.7,
- 1.71,
- 1.72,
- 1.73,
- 1.74,
- 1.75,
- 1.76,
- 1.77,
- 1.78,
- 1.79,
- 1.8,
- 1.81,
- 1.819,
- 1.829,
- 1.839,
- 1.849,
- 1.859,
- 1.869,
- 1.879,
- 1.889,
- 1.899,
- 1.909,
- 1.919,
- 1.929,
- 1.939,
- 1.949,
- 1.959,
- 1.969,
- 1.979,
- 1.988,
- 1.998,
- 2.008,
- 2.018,
- 2.028,
- 2.038,
- 2.048,
- 2.058,
- 2.068,
- 2.078,
- 2.088,
- 2.098,
- 2.108,
- 2.118,
- 2.128,
- 2.138,
- 2.148,
- 2.158,
- 2.167,
- 2.177,
- 2.187,
- 2.197,
- 2.207,
- 2.217,
- 2.227,
- 2.237,
- 2.247,
- 2.257,
- 2.267,
- 2.277,
- 2.287,
- 2.297,
- 2.307,
- 2.317,
- 2.327,
- 2.336,
- 2.346,
- 2.356,
- 2.366,
- 2.376,
- 2.386,
- 2.396,
- 2.406,
- 2.416,
- 2.426,
- 2.436,
- 2.446,
- 2.456,
- 2.466,
- 2.476,
- 2.486,
- 2.496,
- 2.506,
- 2.512
], - "Terrain": [
- 0,
- 0,
- 0,
- 0,
- 0,
- 0,
- 0,
- 0,
- 0,
- 0,
- 0,
- 0,
- 0,
- 0,
- 1,
- 1,
- 1,
- 0,
- 0,
- 0,
- 0,
- 0,
- 0,
- 0,
- 0,
- 0,
- 0,
- 0,
- 0,
- 0,
- 0,
- 0,
- 0,
- 0,
- 0,
- 0,
- 0,
- 0,
- 0,
- 0,
- 0,
- 0,
- 0,
- 0,
- 0,
- 0,
- 0,
- 0,
- 0,
- 0,
- 0,
- 2,
- 4,
- 6,
- 8,
- 8,
- 8,
- 8,
- 7,
- 6,
- 6,
- 5,
- 4,
- 4,
- 4,
- 4,
- 5,
- 5,
- 4,
- 4,
- 3,
- 3,
- 2,
- 1,
- 1,
- 0,
- 0,
- 0,
- 0,
- 0,
- 0,
- 0,
- 0,
- 0,
- 0,
- 0,
- 0,
- 0,
- 0,
- 0,
- 0,
- 0,
- 0,
- 0,
- 0,
- 0,
- 0,
- 0,
- 0,
- 0,
- 0,
- 0,
- 0,
- 0,
- 0,
- 0,
- 0,
- 0,
- 1,
- 1,
- 1,
- 1,
- 0,
- 0,
- 0,
- 0,
- 0,
- 0,
- 0,
- 0,
- 0,
- 0,
- 0,
- 0,
- 0,
- 1,
- 3,
- 4,
- 5,
- 6,
- 7,
- 7,
- 7,
- 8,
- 7,
- 7,
- 7,
- 6,
- 6,
- 6,
- 5,
- 6,
- 6,
- 6,
- 6,
- 6,
- 6,
- 5,
- 5,
- 5,
- 5,
- 5,
- 5,
- 5,
- 5,
- 5,
- 5,
- 5,
- 5,
- 5,
- 5,
- 5,
- 5,
- 5,
- 5,
- 5,
- 5,
- 5,
- 5,
- 5,
- 5,
- 4,
- 4,
- 5,
- 5,
- 6,
- 7,
- 8,
- 9,
- 9,
- 10,
- 11,
- 12,
- 13,
- 13,
- 13,
- 13,
- 13,
- 13,
- 12,
- 12,
- 11,
- 11,
- 10,
- 10,
- 9,
- 8,
- 8,
- 7,
- 7,
- 7,
- 6,
- 6,
- 6,
- 5,
- 5,
- 5,
- 4,
- 4,
- 3,
- 3,
- 3,
- 4,
- 5,
- 6,
- 6,
- 7,
- 7,
- 8,
- 9,
- 9,
- 10,
- 11,
- 11,
- 10,
- 10,
- 10,
- 10,
- 10,
- 10,
- 10,
- 10,
- 10,
- 10,
- 11,
- 11,
- 11,
- 12,
- 12,
- 13,
- 13,
- 14,
- 14,
- 14,
- 14,
- 14,
- 14,
- 13,
- 13,
- 13,
- 12,
- 12,
- 12
], - "Terrain_AMSL": [
- 0,
- 0,
- 0,
- 0,
- 0,
- 0,
- 0,
- 0,
- 0,
- 0,
- 0.2857143,
- 0.6122449,
- 0.9854227,
- 1.554769,
- 1.878919,
- 2.059873,
- 2.213366,
- 2.164594,
- 1.91969,
- 1.756807,
- 1.548727,
- 1.175032,
- 0.9257952,
- 0.6642221,
- 0.3950071,
- 0.2835749,
- 0.1918292,
- 0.1243444,
- 0.08567836,
- 0.05740742,
- 0.03820432,
- 0.02589859,
- 0.01735862,
- 0.01163736,
- 0.007842081,
- 0.00526258,
- 0.003534574,
- 0.002377034,
- 0.001596313,
- 0.00107256,
- 0.0007208438,
- 0.0004842452,
- 0.0003253784,
- 0.0002186382,
- 0.0001468945,
- 0.0000987016,
- 0.00006631919,
- 0.2857588,
- 0.6122748,
- 0.6997286,
- 1.371109,
- 1.811873,
- 3.411816,
- 5.513543,
- 7.248176,
- 9.167648,
- 9.989909,
- 9.915105,
- 9.581809,
- 8.926689,
- 7.7748,
- 7.183328,
- 6.554974,
- 5.787586,
- 5.789413,
- 5.875996,
- 5.921856,
- 6.226752,
- 6.003515,
- 5.736018,
- 5.566612,
- 4.900878,
- 4.314787,
- 3.683182,
- 2.842692,
- 2.405809,
- 1.847383,
- 1.299412,
- 0.9360863,
- 0.5832688,
- 0.5455382,
- 0.580699,
- 0.6727866,
- 0.828432,
- 0.7259882,
- 0.6038867,
- 0.4511867,
- 0.2544374,
- 0.187073,
- 0.1275281,
- 0.08129121,
- 0.05655605,
- 0.03791077,
- 0.02510829,
- 0.01708216,
- 0.01144303,
- 0.007661926,
- 0.005169588,
- 0.003467792,
- 0.002328472,
- 0.00156655,
- 0.001051831,
- 0.0007066933,
- 0.0004750106,
- 0.0003190764,
- 0.2859287,
- 0.612389,
- 0.9855195,
- 1.697691,
- 2.185086,
- 2.552614,
- 2.49077,
- 2.032638,
- 1.439432,
- 0.8518343,
- 0.6177007,
- 0.4155667,
- 0.2693002,
- 0.1860811,
- 0.1244211,
- 0.08282892,
- 0.1990473,
- 0.3437568,
- 0.5179476,
- 1.151536,
- 1.716177,
- 2.626523,
- 4.070605,
- 5.201901,
- 6.557004,
- 7.68993,
- 8.349834,
- 8.799538,
- 8.977043,
- 9.018059,
- 8.827806,
- 8.688987,
- 8.362122,
- 7.982702,
- 7.719116,
- 7.294849,
- 6.999524,
- 7.001927,
- 7.042328,
- 7.291968,
- 7.476603,
- 7.401557,
- 7.167161,
- 6.863617,
- 6.633191,
- 6.380567,
- 6.268196,
- 6.183136,
- 6.118843,
- 6.081454,
- 6.054776,
- 6.036439,
- 6.024667,
- 6.016555,
- 6.011094,
- 6.007474,
- 6.005018,
- 6.003369,
- 6.145123,
- 6.307644,
- 6.493734,
- 6.706643,
- 6.78686,
- 6.85532,
- 6.764118,
- 6.629471,
- 6.321273,
- 5.959266,
- 5.987144,
- 6.181098,
- 6.589644,
- 7.536841,
- 8.329655,
- 9.065163,
- 10.13309,
- 10.7897,
- 11.71257,
- 12.80505,
- 13.61533,
- 14.30471,
- 14.67501,
- 14.79929,
- 14.68272,
- 14.59386,
- 14.29655,
- 13.79616,
- 13.3838,
- 12.78236,
- 12.28033,
- 11.92093,
- 11.14052,
- 10.4774,
- 9.93412,
- 9.221719,
- 8.947605,
- 8.586206,
- 8.107933,
- 7.805963,
- 7.357158,
- 7.038722,
- 6.885978,
- 6.468837,
- 6.199077,
- 5.793413,
- 5.208761,
- 4.885893,
- 4.555438,
- 4.807156,
- 5.46407,
- 6.260952,
- 7.218883,
- 7.991986,
- 8.495974,
- 8.95812,
- 9.635154,
- 10.29846,
- 10.98453,
- 11.70259,
- 12.1408,
- 12.11828,
- 11.99452,
- 11.75051,
- 11.26619,
- 11.28732,
- 11.32915,
- 11.41181,
- 11.71832,
- 11.7799,
- 11.84429,
- 11.90607,
- 12.07575,
- 12.40373,
- 12.91222,
- 13.48453,
- 13.9715,
- 14.48118,
- 14.84817,
- 15.32869,
- 15.80829,
- 15.85502,
- 15.856,
- 15.64562,
- 15.33666,
- 14.9769,
- 14.5656,
- 14.12559,
- 13.66687,
- 13.47972,
- 13.3246
], - "Landcover distance": [
- 0.01,
- 0.02,
- 0.03,
- 0.04,
- 0.05,
- 0.06,
- 0.07,
- 0.08,
- 0.089,
- 0.099,
- 0.109,
- 0.119,
- 0.129,
- 0.139,
- 0.149,
- 0.159,
- 0.169,
- 0.179,
- 0.189,
- 0.199,
- 0.209,
- 0.219,
- 0.229,
- 0.239,
- 0.249,
- 0.259,
- 0.268,
- 0.278,
- 0.288,
- 0.298,
- 0.308,
- 0.318,
- 0.328,
- 0.338,
- 0.348,
- 0.358,
- 0.368,
- 0.378,
- 0.388,
- 0.398,
- 0.408,
- 0.418,
- 0.428,
- 0.437,
- 0.447,
- 0.457,
- 0.467,
- 0.477,
- 0.487,
- 0.497,
- 0.507,
- 0.517,
- 0.527,
- 0.537,
- 0.547,
- 0.557,
- 0.567,
- 0.577,
- 0.587,
- 0.597,
- 0.606,
- 0.616,
- 0.626,
- 0.636,
- 0.646,
- 0.656,
- 0.666,
- 0.676,
- 0.686,
- 0.696,
- 0.706,
- 0.716,
- 0.726,
- 0.736,
- 0.746,
- 0.756,
- 0.766,
- 0.776,
- 0.785,
- 0.795,
- 0.805,
- 0.815,
- 0.825,
- 0.835,
- 0.845,
- 0.855,
- 0.865,
- 0.875,
- 0.885,
- 0.895,
- 0.905,
- 0.915,
- 0.925,
- 0.935,
- 0.945,
- 0.954,
- 0.964,
- 0.974,
- 0.984,
- 0.994,
- 1.004,
- 1.014,
- 1.024,
- 1.034,
- 1.044,
- 1.054,
- 1.064,
- 1.074,
- 1.084,
- 1.094,
- 1.104,
- 1.114,
- 1.124,
- 1.133,
- 1.143,
- 1.153,
- 1.163,
- 1.173,
- 1.183,
- 1.193,
- 1.203,
- 1.213,
- 1.223,
- 1.233,
- 1.243,
- 1.253,
- 1.263,
- 1.273,
- 1.283,
- 1.293,
- 1.302,
- 1.312,
- 1.322,
- 1.332,
- 1.342,
- 1.352,
- 1.362,
- 1.372,
- 1.382,
- 1.392,
- 1.402,
- 1.412,
- 1.422,
- 1.432,
- 1.442,
- 1.452,
- 1.462,
- 1.471,
- 1.481,
- 1.491,
- 1.501,
- 1.511,
- 1.521,
- 1.531,
- 1.541,
- 1.551,
- 1.561,
- 1.571,
- 1.581,
- 1.591,
- 1.601,
- 1.611,
- 1.621,
- 1.631,
- 1.641,
- 1.65,
- 1.66,
- 1.67,
- 1.68,
- 1.69,
- 1.7,
- 1.71,
- 1.72,
- 1.73,
- 1.74,
- 1.75,
- 1.76,
- 1.77,
- 1.78,
- 1.79,
- 1.8,
- 1.81,
- 1.819,
- 1.829,
- 1.839,
- 1.849,
- 1.859,
- 1.869,
- 1.879,
- 1.889,
- 1.899,
- 1.909,
- 1.919,
- 1.929,
- 1.939,
- 1.949,
- 1.959,
- 1.969,
- 1.979,
- 1.988,
- 1.998,
- 2.008,
- 2.018,
- 2.028,
- 2.038,
- 2.048,
- 2.058,
- 2.068,
- 2.078,
- 2.088,
- 2.098,
- 2.108,
- 2.118,
- 2.128,
- 2.138,
- 2.148,
- 2.158,
- 2.167,
- 2.177,
- 2.187,
- 2.197,
- 2.207,
- 2.217,
- 2.227,
- 2.237,
- 2.247,
- 2.257,
- 2.267,
- 2.277,
- 2.287,
- 2.297,
- 2.307,
- 2.317,
- 2.327,
- 2.336,
- 2.346,
- 2.356,
- 2.366,
- 2.376,
- 2.386,
- 2.396,
- 2.406,
- 2.416,
- 2.426,
- 2.436,
- 2.446,
- 2.456,
- 2.466,
- 2.476,
- 2.486,
- 2.496,
- 2.506,
- 2.512
], - "Landcover codes": [
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 8,
- 8,
- 7,
- 7,
- 3,
- 7,
- 3,
- 3,
- 3,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 1,
- 1,
- 1,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 1,
- 1,
- 1,
- 1,
- 1,
- 1,
- 1,
- 1,
- 1,
- 1,
- 1,
- 1,
- 1,
- 1,
- 1,
- 1,
- 1,
- 1,
- 1,
- 8,
- 8,
- 8,
- 8,
- 8,
- 8,
- 8,
- 8,
- 8,
- 8,
- 7,
- 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,
- 8,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7,
- 7
], - "Landcover heights": [
- 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,
- 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,
- 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,
- 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
], - "Fresnel": [
- 0,
- -1.85,
- -2.61,
- -3.19,
- -3.68,
- -4.1,
- -4.49,
- -4.84,
- -5.16,
- -5.46,
- -5.74,
- -6.01,
- -6.27,
- -6.51,
- -6.74,
- -6.96,
- -7.18,
- -7.38,
- -7.58,
- -7.77,
- -7.96,
- -8.13,
- -8.31,
- -8.48,
- -8.64,
- -8.8,
- -8.95,
- -9.1,
- -9.25,
- -9.39,
- -9.53,
- -9.67,
- -9.8,
- -9.93,
- -10.06,
- -10.18,
- -10.3,
- -10.42,
- -10.53,
- -10.65,
- -10.76,
- -10.86,
- -10.97,
- -11.07,
- -11.17,
- -11.27,
- -11.37,
- -11.47,
- -11.56,
- -11.65,
- -11.74,
- -11.83,
- -11.91,
- -12,
- -12.08,
- -12.16,
- -12.24,
- -12.32,
- -12.39,
- -12.47,
- -12.54,
- -12.61,
- -12.68,
- -12.75,
- -12.81,
- -12.88,
- -12.94,
- -13.01,
- -13.07,
- -13.13,
- -13.19,
- -13.24,
- -13.3,
- -13.36,
- -13.41,
- -13.46,
- -13.51,
- -13.56,
- -13.61,
- -13.66,
- -13.71,
- -13.75,
- -13.8,
- -13.84,
- -13.88,
- -13.92,
- -13.96,
- -14,
- -14.04,
- -14.07,
- -14.11,
- -14.14,
- -14.18,
- -14.21,
- -14.24,
- -14.27,
- -14.3,
- -14.33,
- -14.36,
- -14.38,
- -14.41,
- -14.43,
- -14.46,
- -14.48,
- -14.5,
- -14.52,
- -14.54,
- -14.56,
- -14.58,
- -14.59,
- -14.61,
- -14.62,
- -14.64,
- -14.65,
- -14.66,
- -14.67,
- -14.68,
- -14.69,
- -14.7,
- -14.71,
- -14.71,
- -14.72,
- -14.72,
- -14.73,
- -14.73,
- -14.73,
- -14.73,
- -14.73,
- -14.73,
- -14.73,
- -14.73,
- -14.72,
- -14.72,
- -14.71,
- -14.7,
- -14.7,
- -14.69,
- -14.68,
- -14.67,
- -14.66,
- -14.65,
- -14.63,
- -14.62,
- -14.6,
- -14.59,
- -14.57,
- -14.55,
- -14.53,
- -14.51,
- -14.49,
- -14.47,
- -14.45,
- -14.42,
- -14.4,
- -14.37,
- -14.35,
- -14.32,
- -14.29,
- -14.26,
- -14.23,
- -14.2,
- -14.17,
- -14.13,
- -14.1,
- -14.06,
- -14.02,
- -13.99,
- -13.95,
- -13.91,
- -13.87,
- -13.82,
- -13.78,
- -13.74,
- -13.69,
- -13.64,
- -13.59,
- -13.54,
- -13.49,
- -13.44,
- -13.39,
- -13.34,
- -13.28,
- -13.22,
- -13.17,
- -13.11,
- -13.05,
- -12.98,
- -12.92,
- -12.86,
- -12.79,
- -12.72,
- -12.65,
- -12.58,
- -12.51,
- -12.44,
- -12.36,
- -12.29,
- -12.21,
- -12.13,
- -12.05,
- -11.97,
- -11.88,
- -11.8,
- -11.71,
- -11.62,
- -11.53,
- -11.43,
- -11.34,
- -11.24,
- -11.14,
- -11.04,
- -10.93,
- -10.82,
- -10.72,
- -10.6,
- -10.49,
- -10.37,
- -10.26,
- -10.13,
- -10.01,
- -9.88,
- -9.75,
- -9.62,
- -9.48,
- -9.34,
- -9.2,
- -9.05,
- -8.9,
- -8.74,
- -8.58,
- -8.42,
- -8.25,
- -8.07,
- -7.89,
- -7.7,
- -7.51,
- -7.31,
- -7.1,
- -6.88,
- -6.66,
- -6.42,
- -6.18,
- -5.92,
- -5.64,
- -5.35,
- -5.04,
- -4.71,
- -4.35,
- -3.95,
- -3.51,
- -2.99,
- -2.36,
- -1.48
], - "dBm": [
- -97.3,
- -109.1,
- -116.1,
- -121.2,
- -125.1,
- -128.4,
- -131.2,
- -133.5,
- -135.4,
- -128.5,
- -128.6,
- -129.1,
- -128.2,
- -130.6,
- -133.1,
- -135.2,
- -135.9,
- -142.1,
- -143.5,
- -145.2,
- -146.4,
- -147.4,
- -148.6,
- -149.8,
- -149.6,
- -149.7,
- -150.3,
- -150.5,
- -150.7,
- -151,
- -151.3,
- -151.7,
- -152,
- -152.5,
- -152.9,
- -153.2,
- -153.9,
- -154.2,
- -154.7,
- -155.2,
- -155.7,
- -156.2,
- -156.8,
- -157.3,
- -157.8,
- -158.3,
- -157.2,
- -155.6,
- -155.9,
- -152.7,
- -151.5,
- -146,
- -147.4,
- -146.1,
- -137.2,
- -135.8,
- -155.4,
- -161.5,
- -166.2,
- -171.9,
- -169.7,
- -169.9,
- -171.7,
- -168.1,
- -166.3,
- -165.3,
- -163.6,
- -164.1,
- -165.5,
- -165.2,
- -168.6,
- -169.6,
- -170.9,
- -171.4,
- -171.5,
- -171.8,
- -172.2,
- -171.3,
- -171,
- -169.7,
- -168.6,
- -167.5,
- -166.7,
- -166.7,
- -168.1,
- -168,
- -168.2,
- -168.1,
- -167.9,
- -167.9,
- -167.7,
- -167.6,
- -167.5,
- -167.3,
- -167.3,
- -167.1,
- -167,
- -167.1,
- -167.1,
- -167,
- -167,
- -167,
- -167,
- -167,
- -166.4,
- -165.7,
- -164.9,
- -163.7,
- -163,
- -162.6,
- -163,
- -170.2,
- -172.7,
- -174.5,
- -172.7,
- -171.8,
- -171.2,
- -170.4,
- -169.9,
- -169.4,
- -168.4,
- -167.9,
- -167.1,
- -167.3,
- -166.3,
- -164.7,
- -162.6,
- -161.4,
- -160.1,
- -159.3,
- -159.1,
- -159.2,
- -159.6,
- -160.1,
- -168.2,
- -169.6,
- -171.7,
- -174.5,
- -174.6,
- -174.6,
- -177,
- -174.5,
- -173.4,
- -171.9,
- -171.3,
- -172,
- -173.6,
- -175.8,
- -176.5,
- -177.4,
- -176.4,
- -176.1,
- -176,
- -175.8,
- -175.7,
- -178.1,
- -177.9,
- -177.8,
- -177.8,
- -177.8,
- -177.9,
- -178.1,
- -177.5,
- -177.1,
- -176.8,
- -176.5,
- -176.7,
- -176.8,
- -177.6,
- -178.6,
- -181.1,
- -184.1,
- -180.8,
- -178.6,
- -180.2,
- -177.5,
- -176,
- -179.2,
- -177.4,
- -176.6,
- -175.5,
- -174.4,
- -173.8,
- -173.5,
- -173.5,
- -173.9,
- -180.4,
- -182.3,
- -185.5,
- -190,
- -190.7,
- -192.1,
- -193,
- -193.6,
- -195.6,
- -196.6,
- -196.5,
- -198.7,
- -196.3,
- -196.2,
- -197.1,
- -196.5,
- -197.4,
- -197.5,
- -196.7,
- -197.6,
- -197.7,
- -198.2,
- -196.6,
- -199.9,
- -200,
- -198,
- -196,
- -193.9,
- -191.7,
- -188,
- -187.4,
- -186.9,
- -186.3,
- -185.6,
- -184.9,
- -183.9,
- -183.8,
- -184.4,
- -187.7,
- -194,
- -199.8,
- -195.7,
- -194.3,
- -193.5,
- -192,
- -192.4,
- -192.8,
- -193.2,
- -193.3,
- -193.2,
- -193,
- -192.2,
- -191.7,
- -191.3,
- -191.1,
- -190.8,
- -190.5,
- -191.1,
- -191.8,
- -198.1,
- -201.9,
- -203.9,
- -205.3,
- -206.4,
- -208,
- -206.5,
- -205.6
], - "dB": [
- 117.3,
- 129.1,
- 136.1,
- 141.2,
- 145.1,
- 148.4,
- 151.2,
- 153.5,
- 155.4,
- 148.5,
- 148.6,
- 149.1,
- 148.2,
- 150.6,
- 153.1,
- 155.2,
- 155.9,
- 162.1,
- 163.5,
- 165.2,
- 166.4,
- 167.4,
- 168.6,
- 169.8,
- 169.6,
- 169.7,
- 170.3,
- 170.5,
- 170.7,
- 171,
- 171.3,
- 171.7,
- 172,
- 172.5,
- 172.9,
- 173.2,
- 173.9,
- 174.2,
- 174.7,
- 175.2,
- 175.7,
- 176.2,
- 176.8,
- 177.3,
- 177.8,
- 178.3,
- 177.2,
- 175.6,
- 175.9,
- 172.7,
- 171.5,
- 166,
- 167.4,
- 166.1,
- 157.2,
- 155.8,
- 175.4,
- 181.5,
- 186.2,
- 191.9,
- 189.7,
- 189.9,
- 191.7,
- 188.1,
- 186.3,
- 185.3,
- 183.6,
- 184.1,
- 185.5,
- 185.2,
- 188.6,
- 189.6,
- 190.9,
- 191.4,
- 191.5,
- 191.8,
- 192.2,
- 191.3,
- 191,
- 189.7,
- 188.6,
- 187.5,
- 186.7,
- 186.7,
- 188.1,
- 188,
- 188.2,
- 188.1,
- 187.9,
- 187.9,
- 187.7,
- 187.6,
- 187.5,
- 187.3,
- 187.3,
- 187.1,
- 187,
- 187.1,
- 187.1,
- 187,
- 187,
- 187,
- 187,
- 187,
- 186.4,
- 185.7,
- 184.9,
- 183.7,
- 183,
- 182.6,
- 183,
- 190.2,
- 192.7,
- 194.5,
- 192.7,
- 191.8,
- 191.2,
- 190.4,
- 189.9,
- 189.4,
- 188.4,
- 187.9,
- 187.1,
- 187.3,
- 186.3,
- 184.7,
- 182.6,
- 181.4,
- 180.1,
- 179.3,
- 179.1,
- 179.2,
- 179.6,
- 180.1,
- 188.2,
- 189.6,
- 191.7,
- 194.5,
- 194.6,
- 194.6,
- 197,
- 194.5,
- 193.4,
- 191.9,
- 191.3,
- 192,
- 193.6,
- 195.8,
- 196.5,
- 197.4,
- 196.4,
- 196.1,
- 196,
- 195.8,
- 195.7,
- 198.1,
- 197.9,
- 197.8,
- 197.8,
- 197.8,
- 197.9,
- 198.1,
- 197.5,
- 197.1,
- 196.8,
- 196.5,
- 196.7,
- 196.8,
- 197.6,
- 198.6,
- 201.1,
- 204.1,
- 200.8,
- 198.6,
- 200.2,
- 197.5,
- 196,
- 199.2,
- 197.4,
- 196.6,
- 195.5,
- 194.4,
- 193.8,
- 193.5,
- 193.5,
- 193.9,
- 200.4,
- 202.3,
- 205.5,
- 210,
- 210.7,
- 212.1,
- 213,
- 213.6,
- 215.6,
- 216.6,
- 216.5,
- 218.7,
- 216.3,
- 216.2,
- 217.1,
- 216.5,
- 217.4,
- 217.5,
- 216.7,
- 217.6,
- 217.7,
- 218.2,
- 216.6,
- 219.9,
- 220,
- 218,
- 216,
- 213.9,
- 211.7,
- 208,
- 207.4,
- 206.9,
- 206.3,
- 205.6,
- 204.9,
- 203.9,
- 203.8,
- 204.4,
- 207.7,
- 214,
- 219.8,
- 215.7,
- 214.3,
- 213.5,
- 212,
- 212.4,
- 212.8,
- 213.2,
- 213.3,
- 213.2,
- 213,
- 212.2,
- 211.7,
- 211.3,
- 211.1,
- 210.8,
- 210.5,
- 211.1,
- 211.8,
- 218.1,
- 221.9,
- 223.9,
- 225.3,
- 226.4,
- 228,
- 226.5,
- 225.6
]
}, - "calculation_adjusted": [ ],
- "elapsed": 135,
}This endpoint allows users to test many point-to-point links in one call. The points function tests an array of transmitters to one receiver and is designed for route analysis, mesh networks and dynamic modelling. The simplest request requires: transmitter’s array of tuples (latitude, longitude, altitude) locations, antenna, receiver, and output objects defined. Model and environment options enhance accuracy.
| site | string [ 2 .. 50 ] characters Default: "Points" Name of site. |
| network | string [ 2 .. 50 ] characters Default: "Testing" Network name/group. |
object (Transmitter) | |
Array of objects (Point) | |
object (Antenna) | |
object (Receiver) | |
object (Model) | |
object (Environment) | |
object (Output) |
{- "site": "Points",
- "network": "Testing",
- "transmitter": {
- "frq": 446,
- "txw": 1,
- "bwi": 0.1
}, - "points": [
- {
- "lat": 38.916,
- "lon": 1.411,
- "alt": 1
}, - {
- "lat": 38.916,
- "lon": 1.411,
- "alt": 1
}
], - "antenna": {
- "txg": 2.15,
- "txl": 0,
- "ant": 39,
- "azi": 0,
- "tlt": 0,
- "hbw": 0,
- "vbw": 0,
- "pol": "v"
}, - "receiver": {
- "lat": 38.906986,
- "lon": 1.421416,
- "alt": 0.1,
- "rxg": 2.15,
- "rxs": -90
}, - "model": {
- "pm": 1,
- "pe": 2,
- "ked": 0,
- "rel": 95
}, - "environment": {
- "clt": "Minimal.clt",
- "elevation": 1,
- "landcover": 0,
- "buildings": 0,
- "obstacles": 0
}, - "output": {
- "units": "m",
- "out": 2,
- "ber": 0,
- "mod": 1,
- "nf": -104,
- "res": 20
}
}{- "Engine": "Sleipnir 1.18",
- "Frequency MHz": 868,
- "Propagation model": "ITM",
- "Earth dielectric constant": 14,
- "Earth conductivity": 0.01,
- "Radio climate": "Maritime Temperate (Land)",
- "Atmospheric bending constant": 301,
- "Fraction of situations": 90,
- "Fraction of time": 90,
- "Receiver": {
- "Latitude": 38.90699,
- "Longitude": 1.421416,
- "Ground elevation m": 22,
- "Antenna height m": 1,
- "Receiver gain dBd": 0,
- "Receiver gain dBi": 2.15
}, - "Transmitters": {
- "Latitude": 38.916,
- "Longitude": 1.448,
- "Ground elevation m": 1,
- "Antenna height m": 1,
- "Height above sea level m": 2,
- "Distance to receiver km": 2.512,
- "Azimuth to receiver deg": 246.46,
- "Downtilt angle deg": 0,
- "Antenna gain dBd": 0,
- "Antenna gain dBi": 2.15,
- "Polarisation": "Horizontal",
- "Power W": 2,
- "Power dBm": 35.16,
- "ERP W": 2,
- "EIRP W": 3.28,
- "ERP dBm": 3.28,
- "EIRP dBm": 35.16,
- "Free space path loss dB": 92,
- "Bandwidth MHz": 1,
- "Signal power at receiver dBm": -128.9,
- "Signal to Noise Ratio dB": -115.8,
- "Computed path loss dB": 225.6,
- "Model attenuation dB": 130.6,
- "Field strength at receiver dBuV/m": -68.5,
- "Raise RX antenna for LOS": 0,
- "Raise RX antenna for fresnel 60%": 5,
- "Raise RX antenna for full fresnel": 7,
- "server": 1
}, - "calculation_adjusted": [ ],
- "elapsed": 135,
}This powerful GPU endpoint allows you request multiple area calculations in one request and response. The layers are returned as a composite super layer.
This is useful for planning adhoc radio networks with many radios efficiently.
| site | string Site name. |
| network | string Network name/group. |
Array of objects Array of transmitters part of the multisite | |
object Details relating to the receiver in the request. | |
object (Model) | |
object (Environment) | |
object (OutputWithBounds) |
{- "site": "My multisite",
- "network": "My multisite network",
- "transmitters": [
- {
- "lat": 38.916,
- "lon": 1.448,
- "alt": 1,
- "frq": 868,
- "txw": 0.1,
- "bwi": 1,
- "remote": false,
- "antenna": {
- "txg": 2.15,
- "txl": 1,
- "ant": 39,
- "azi": 0,
- "tlt": 0,
- "hbw": 120,
- "vbw": 30,
- "fbr": 0,
- "pol": "v"
}
}
], - "receiver": {
- "alt": 1,
- "rxg": 3,
- "rxs": -90
}, - "model": {
- "pm": 1,
- "pe": 2,
- "ked": 1,
- "rel": 90,
- "rcs": 1
}, - "environment": {
- "clt": "Minimal.clt",
- "elevation": 1,
- "landcover": 0,
- "buildings": 0,
- "obstacles": 0
}, - "output": {
- "units": "m",
- "col": "RAINBOW.dBm",
- "out": 2,
- "ber": 2,
- "mod": 7,
- "nf": -100,
- "res": 20,
- "rad": 5,
- "bounds": {
- "north": -41.272,
- "east": 174.788,
- "south": -41.294,
- "west": 174.773
}
}
}{- "bounds": [
- [
- 38.942844475233805,
- 1.4826338797780443,
- 38.88915552476619,
- 1.413357814658543
]
], - "id": 3930916,
- "sid": "M2ZSaUZuVlVDRno3TTJDTGVqRGJlUT09",
- "area": 0,
- "coverage": "0%",
- "key": [
- [
- {
- "l": "-20dBm",
- "r": 255,
- "g": 19,
- "b": 0
}, - {
- "l": "-24dBm",
- "r": 255,
- "g": 61,
- "b": 0
}, - {
- "l": "-28dBm",
- "r": 255,
- "g": 102,
- "b": 0
}, - {
- "l": "-32dBm",
- "r": 255,
- "g": 144,
- "b": 0
}, - {
- "l": "-36dBm",
- "r": 255,
- "g": 185,
- "b": 0
}, - {
- "l": "-40dBm",
- "r": 255,
- "g": 227,
- "b": 0
}, - {
- "l": "-44dBm",
- "r": 242,
- "g": 255,
- "b": 0
}, - {
- "l": "-48dBm",
- "r": 200,
- "g": 255,
- "b": 0
}, - {
- "l": "-52dBm",
- "r": 159,
- "g": 255,
- "b": 0
}, - {
- "l": "-56dBm",
- "r": 117,
- "g": 255,
- "b": 0
}, - {
- "l": "-60dBm",
- "r": 76,
- "g": 255,
- "b": 0
}, - {
- "l": "-64dBm",
- "r": 34,
- "g": 255,
- "b": 0
}, - {
- "l": "-68dBm",
- "r": 0,
- "g": 255,
- "b": 7
}, - {
- "l": "-72dBm",
- "r": 0,
- "g": 255,
- "b": 49
}, - {
- "l": "-76dBm",
- "r": 0,
- "g": 255,
- "b": 90
}, - {
- "l": "-80dBm",
- "r": 0,
- "g": 255,
- "b": 132
}, - {
- "l": "-84dBm",
- "r": 0,
- "g": 255,
- "b": 173
}, - {
- "l": "-88dBm",
- "r": 0,
- "g": 255,
- "b": 215
}, - {
- "l": "-92dBm",
- "r": 0,
- "g": 254,
- "b": 255
}, - {
- "l": "-96dBm",
- "r": 0,
- "g": 212,
- "b": 255
}, - {
- "l": "-100dBm",
- "r": 0,
- "g": 171,
- "b": 255
}, - {
- "l": "-104dBm",
- "r": 0,
- "g": 129,
- "b": 255
}, - {
- "l": "-108dBm",
- "r": 0,
- "g": 88,
- "b": 255
}, - {
- "l": "-112dBm",
- "r": 0,
- "g": 46,
- "b": 255
}
]
], - "elapsed": 1572,
- "balance": 1,
- "calculation_adjusted": [ ]
}This endpoint returns an omni-directional coverage plot (point-to-multipoint) for HF skywave propagation as an image.
The request payload providing the site properties.
| site required | string [ 1 .. 24 ] characters Default: "HF1" Site name. |
| network required | string [ 1 .. 24 ] characters Default: "Testing" Network name/group. |
required | object (HfTransmitter) |
object (HfAreaReceiver) | |
object (HfAntenna) | |
object (HfAreaModel) | |
required | object (HfAreaOutput) |
{- "site": "Test",
- "network": "HFTest",
- "transmitter": {
- "lat": 51.833992,
- "lon": -2.231319,
- "frq": 4
}, - "antenna": {
- "txg": 2,
- "txl": 0,
- "ant": 1,
- "pol": "h",
- "azi": 90
}, - "model": {
- "month": 7,
- "hour": 0,
- "rel": 50
}, - "output": {
- "col": "SNR1.dB",
- "bounds": {
- "north": "72.499717",
- "east": "40.944650",
- "south": "6.353099",
- "west": "-60.400436"
}, - "nf": -140,
- "out": 4
}
}{- "bounds": [
- [
- 72.499717,
- 40.94465,
- 6.353099,
- 60.400436
]
], - "id": "3930916",
- "sid": "M2ZSaUZuVlVDRno3TTJDTGVqRGJlUT09",
- "key": [
- [
- {
- "l": "40dB",
- "r": 37,
- "g": 131,
- "b": 255
}, - {
- "l": "30dB",
- "r": 49,
- "g": 254,
- "b": 127
}, - {
- "l": "20dB",
- "r": 218,
- "g": 254,
- "b": 60
}, - {
- "l": "10dB",
- "r": 254,
- "g": 72,
- "b": 72
}
]
], - "elapsed": 2364,
- "balance": 1
}This endpoint allows users to analyse a point-to-point path to find the best frequency. The result is a graph showing the SNR for a range of nominal HF frequencies plotted against time. This can be used to determine the MUF and LUF.
The request payload providing the site properties.
| site required | string [ 1 .. 24 ] characters Default: "HF1" Site name. |
| network required | string [ 1 .. 24 ] characters Default: "Testing" Network name/group. |
required | object (HfTransmitter) |
object (HfPredictionReceiver) | |
object (HfAntenna) | |
object (HfPredictionModel) | |
required | object (HfPredictionOutput) |
{- "site": "Test",
- "network": "HFTest",
- "transmitter": {
- "lat": 51.8656,
- "lon": -2.207,
- "frq": 4,
- "txw": 10,
- "alt": 6
}, - "receiver": {
- "lat": 41.86,
- "lon": 12.78,
- "rxg": 2.15
}, - "antenna": {
- "txg": 2.15,
- "ant": 2
}, - "model": {
- "month": 3,
- "sunspots_r12": 50
}, - "output": {
- "nf": -140
}
}{- "Receiver": {
- "Latitude": 51.8656,
- "Longitude": -2.207
}, - "Transmitters": {
- "Latitude": 41.86,
- "Longitude": 12.78
}, - "elapsed": 2364,
- "balance": 1
}This set of endpoints allows the user to use and analyse information from pre-defined networks and layers.
The best site analysis (BSA) endpoint can be used to find the best locations in a wider area for a transmitter. It uses a GPU accelerated Monte Carlo simulation with hundreds of random locations to compare and grade radio intervisibility. Please note that the response of a BSA calculation is not signal strength. It is a normalised heatmap, relative to the best site, with settings for a user defined transmitter. For best results, focus onto a single feature, like a valley or a ridge, not an entire mountain range.
There are two methods to define an area of interest for a BSA caluclation:
transmitter.lat and transmitter.lon, along with the output.rad to define the circular area of interest.edges, each with a lat and lon which defines the area of interest. When using this method, you should ensure that the transmitter.lat and transmitter.lon are not set.The response for BSA is a greyscale image.
| site | string [ 1 .. 24 ] characters Default: "BSA" Name of site. |
| network | string [ 1 .. 24 ] characters Default: "BSA" Network name/group. |
object (Transmitter) | |
object An array of edges which can be used to define a bounding box for your area of interest for BSA. When using this please remove your transmitter.lat and transmitter.lon values. | |
object (Antenna) | |
object | |
object |
{- "site": "BSA",
- "network": "BSA",
- "transmitter": {
- "lat": 38.916,
- "lon": 1.448,
- "alt": 1,
- "frq": 868,
- "txw": 0.1,
- "bwi": 1
}, - "edges": [
- {
- "lat": 38.90932,
- "lon": 1.43935
}, - {
- "lat": 38.902789,
- "lon": 1.436619
}, - {
- "lat": 38.905711,
- "lon": 1.424938
}, - {
- "lat": 38.903652,
- "lon": 1.419708
}, - {
- "lat": 38.911647,
- "lon": 1.42024
}, - {
- "lat": 38.910872,
- "lon": 1.434714
}
], - "antenna": {
- "txg": 2.15,
- "txl": 1,
- "ant": 39,
- "azi": 0,
- "tlt": 0,
- "hbw": 120,
- "vbw": 30,
- "fbr": 0,
- "pol": "v"
}, - "receiver": {
- "alt": 1,
- "rxg": 3
}, - "output": {
- "units": "metric",
- "res": 20,
- "rad": 5
}
}{- "bounds": [
- [
- 38.96091398221914,
- 1.5057877843205172,
- 38.871086017780854,
- 1.3902122156794827
]
], - "id": 4371076,
- "sid": "bjdRdXlOUUpJV0FEOGpwUFh5bS91QT09",
- "area": 0,
- "coverage": 0,
- "key": [
- [
- {
- "l": "100%",
- "r": 107,
- "g": 254,
- "b": 1
}, - {
- "l": "90%",
- "r": 147,
- "g": 251,
- "b": 5
}, - {
- "l": "80%",
- "r": 184,
- "g": 248,
- "b": 8
}, - {
- "l": "70%",
- "r": 219,
- "g": 244,
- "b": 12
}, - {
- "l": "60%",
- "r": 241,
- "g": 230,
- "b": 16
}, - {
- "l": "50%",
- "r": 237,
- "g": 192,
- "b": 20
}, - {
- "l": "40%",
- "r": 234,
- "g": 157,
- "b": 23
}, - {
- "l": "30%",
- "r": 230,
- "g": 124,
- "b": 27
}, - {
- "l": "20%",
- "r": 227,
- "g": 64,
- "b": 34
}, - {
- "l": "10%",
- "r": 223,
- "g": 64,
- "b": 34
}, - {
- "l": "00%",
- "r": 220,
- "g": 38,
- "b": 38
}
]
], - "elapsed": 1572,
- "balance": 1
}This endpoint returns a consolidated layer of many area calculations as a single super layer.
Stronger signals are promoted over weaker ones regardless of colour schema but units must match eg. dBm.
Merging a dozen sites should take only a few seconds.
Merging a large network or at very high resolution can take minutes. If you experience a timeout on a long running API request it can still succeed later if you check back in your archive.
| network required | string Example: network=100_repeaters_nationwide. Network name. |
| name required | string Example: name=National_map Super layer name. |
This endpoint compares a set pre-calculated 'signal' sites with a set of pre-calculated 'noise' sites to calculate the Jamming-to-Signal ratio, considering frequency, power and bandwidth. Signal sites can be specified with either a network name s_network or an array of site names s_sites, jammers are specified similarly with j_network and j_sites.
| s_network | string Name of the 'signal' network. |
| s_sites | Array of strings A list of 'signal' sites. |
| j_network | string Name of the 'noise' network. |
| j_sites | Array of strings A list of "noise" sites which are potentially interfering. |
| name | string Interference layer name. |
| colour_key | string Colour key name. |
{- "s_network": "MyNetwork",
- "s_sites": [
- "1125164804_MyNetwork_A",
- "1125164815_MyNetwork_B"
], - "j_network": "OtherNetwork",
- "j_sites": [
- "1125164804_OtherNetwork_A",
- "1125164815_OtherNetwork_B"
], - "name": "InterferenceExample",
- "colour_key": "JS.dB"
}{- "bounds": [
- [
- 51.99872,
- -2.186565,
- 51.78911,
- -2.396179
]
], - "id": 3930917,
- "sid": "bjRRWno0aUF3ekN2QW9ISWc2UlcrZz10",
- "key": [
- [
- {
- "l": "12dB",
- "r": 254,
- "g": 0,
- "b": 0
}, - {
- "l": "11dB",
- "r": 254,
- "g": 21,
- "b": 0
}, - {
- "l": "10dB",
- "r": 254,
- "g": 43,
- "b": 0
}, - {
- "l": "9dB",
- "r": 254,
- "g": 64,
- "b": 0
}, - {
- "l": "8dB",
- "r": 254,
- "g": 85,
- "b": 0
}, - {
- "l": "7dB",
- "r": 254,
- "g": 106,
- "b": 0
}, - {
- "l": "6dB",
- "r": 254,
- "g": 128,
- "b": 0
}, - {
- "l": "5dB",
- "r": 254,
- "g": 149,
- "b": 0
}, - {
- "l": "4dB",
- "r": 254,
- "g": 170,
- "b": 0
}, - {
- "l": "3dB",
- "r": 254,
- "g": 191,
- "b": 0
}, - {
- "l": "2dB",
- "r": 254,
- "g": 212,
- "b": 0
}, - {
- "l": "1dB",
- "r": 254,
- "g": 234,
- "b": 0
}, - {
- "l": "0dB",
- "r": 254,
- "g": 254,
- "b": 0
}, - {
- "l": "-1dB",
- "r": 234,
- "g": 254,
- "b": 0
}, - {
- "l": "-2dB",
- "r": 213,
- "g": 254,
- "b": 0
}, - {
- "l": "-3dB",
- "r": 191,
- "g": 254,
- "b": 0
}, - {
- "l": "-4dB",
- "r": 170,
- "g": 254,
- "b": 0
}, - {
- "l": "-5dB",
- "r": 149,
- "g": 254,
- "b": 0
}, - {
- "l": "-6dB",
- "r": 128,
- "g": 254,
- "b": 0
}, - {
- "l": "-7dB",
- "r": 106,
- "g": 254,
- "b": 0
}, - {
- "l": "-8dB",
- "r": 85,
- "g": 254,
- "b": 0
}, - {
- "l": "-9dB",
- "r": 64,
- "g": 254,
- "b": 0
}, - {
- "l": "-10dB",
- "r": 43,
- "g": 254,
- "b": 0
}, - {
- "l": "-11dB",
- "r": 21,
- "g": 254,
- "b": 0
}, - {
- "l": "-12dB",
- "r": 0,
- "g": 254,
- "b": 0
}
]
], - "elapsed": 1572,
- "balance": 1,
- "calculation_adjusted": [
- "Removing site '1125164804_testJ_A' from jammer list as it exists in signal list"
], - "resolution": 10,
- "percentage_above_js": [
- {
- "js": 12,
- "percentage": 0
}, - {
- "js": 9,
- "percentage": 0.3437902879243661
}, - {
- "js": 6,
- "percentage": 0.9454232917920069
}, - {
- "js": 3,
- "percentage": 3.1800601633003867
}, - {
- "js": 0,
- "percentage": 21.22905027932961
}, - {
- "js": -3,
- "percentage": 43.704340352385046
}, - {
- "js": -6,
- "percentage": 73.31327889987108
}, - {
- "js": -9,
- "percentage": 89.42844864632575
}, - {
- "js": -12,
- "percentage": 95.05801461108723
}
]
}This endpoint allows users to query the network to find the best server(s) for a given receiver/customer location. A previously generated network is required. This method returns more data than the points API as it includes the arrays for terrain, landcover, obstructions, and path loss for each server.
| net required | string Network name. |
| nam required | string Super layer name. |
| lat required | number <float> Latitude in decimal degrees. |
| lon required | number <float> Longitude in decimal degrees. |
| alt required | number <float> Height above ground level in meters. |
| rxg | number <float> Receiver gain in dBi. |
This endpoint allows users to query sites to find areas of mutual interest where a signal might be. It uses receiver power measurements (including nil returns) and modelling to produce a much more accurate output than legacy trilateration using circles. The accuracy is determined by both the modelling and the errordB value which lets users specify trilateration error. About 10dB is recommended.
| colourKey | string Colour key name. Recommended value is 9 (Greyscale) |
| errordB | number <float> Trilateration error in decibels. This should be set with care as too low will produce no matches and too high will show signals everywhere. Recommend 10dB. |
Array of objects Array of sites and rssi values from where a signal has been detected | |
Array of objects Array of sites from where a signal has NOT been detected |
{- "colourKey": 9,
- "errordB": 10,
- "connected": [
- {
- "site": "0320153726_Trilateration-demo_A",
- "rssi": -90
}
], - "disconnected": [
- {
- "site": "0320153755_Trilateration-demo_B"
}
]
}{- "areaKm2": 0.1,
- "areaPx": 77,
- "pngBounds": [
- [
- 38.942844475233805,
- 1.4826338797780443,
- 38.88915552476619,
- 1.413357814658543
]
]
}This endpoint allows you to model 3D propagation inside a user-supplied building or tunnel. It can handle reflections, material attenuation, fast-fading (dead-spots), 3D antenna patterns and multisite requests for many transmitters. This uses GPU acceleration and is resource intensive.
One of "res" and "megavoxels" is required, and calculation speed can be increased significantly by reducing "megavoxels" or increasing "res".
Array of objects Array of transmitters part of the 3D multisite request | |
object (3d) | |
object Details relating to the output file. | |
object Details relating to the receiver in the request. | |
object | |
Array of objects An array of custom materials as used within the input. Optional. |
{- "transmitters": [
- {
- "frq": 868,
- "txw": 0.1,
- "pos": {
- "x": 0,
- "y": 0,
- "z": 0
}, - "up": {
- "x": 0,
- "y": 1,
- "z": 0
}, - "fwd": {
- "x": 0,
- "y": 0,
- "z": 1
}, - "antenna": {
- "txg": 2.15,
- "txl": 1,
- "ant": 39,
- "azi": 0,
- "tlt": 0,
- "hbw": 120,
- "vbw": 30,
- "fbr": 0,
- "pol": "v"
}
}
], - "3d": {
- "input_file": "subway.glb",
- "max_reflections": 1
}, - "output": {
- "res": 0.5,
- "megavoxels": 20,
- "col": "RAINBOW.dBm",
- "out": 2
}, - "receiver": {
- "rxg": 3,
- "rxs": -90
}, - "default_material": {
- "reflection_loss": 3,
- "transmission_loss": 15,
- "diffusion": 0.5
}, - "materials": [
- {
- "keys": [
- "Wood",
- "Gravel"
], - "reflection_loss": 3,
- "transmission_loss": 15,
- "diffusion": 0.5
}, - {
- "keys": [
- "Metal",
- "Glass"
], - "reflection_loss": 1,
- "transmission_loss": 30,
- "diffusion": 0.7
}
]
}{- "model_file_uncompressed": "https://api.cloudrf.com/3d/model/download/?uid=40843&model=1718708130-subway.glb&uncompressed=1",
- "file_size_MB": 0.657,
- "file_size_uncompressed_MB": 19.024,
- "elapsed_s": 18.06,
- "megavoxels": 20,
- "resolution": 0.235,
- "calculation_adjusted": [ ]
}Upload a GLB model which can be used in combination with the /3d request.
Please note that only a single model can be uploaded with each request.
The example below gives a named value of file, but this can be anything. The API doesn't look for a particular name, rather it takes the first file which was sent.
| file required | string <binary> The file to upload. |
{- "message": "Model uploaded OK",
- "file": "subway.glb",
- "file_size_MB": 18.356,
- "storage_used_MB": 526.522,
- "storage_remaining_MB": 474
}This set of endpoints allow the user to administer data, including enumeration, deletion, and exporting of data in open formats.
This endpoint allows users to list area and path calculations - sorted by time and limited to the last few hundred. To fetch all for a given network append a "net" filter with the network name.
| n | number <float> Example: n=65 North bounding box. WGS84 decimal degrees. |
| e | number <float> Example: e=2 East bounding box. WGS84 decimal degrees. |
| s | number <float> Example: s=50 South bounding box. WGS84 decimal degrees. |
| w | number <float> Example: w=-5 West bounding box. WGS84 decimal degrees. |
Warning! You could lose data. This endpoint deletes the entry from the database and the file from the disk. This deletes a single calculation from the database and from your folder.
| cid required | integer Unique calculation ID number. |
This endpoint downloads your data in a format suitable for a third-party viewer such as Google Earth or ESRI Arcmap. Supported formats:
| file required | string Calculation file name. |
| fmt required | string Enum: "kml" "kmzppa" "shp" "tiff" "zip" Required file format: KML; KMZ; SHP; GeoTIFF or ATAK ZIP |
This endpoint supports upload of GeoJSON lineString and polygon features to your account.
| name | string Default: "Clutter" |
| type | string Default: "FeatureCollection" |
Array of objects (Feature) |
{- "name": "Clutter",
- "type": "FeatureCollection",
- "features": [
- {
- "type": "Feature",
- "features": {
- "geometry": "Polygon",
- "coordinates": [
- [
- -2.648749,
- 51.639982
], - [
- -2.648814,
- 51.641129
], - [
- -2.647935,
- 51.641446
], - [
- -2.646937,
- 51.64096
], - [
- -2.647176,
- 51.640137
], - [
- -2.646178,
- 51.639692
], - [
- -2.647154,
- 51.638546
], - [
- -2.647827,
- 51.639544
], - [
- -2.648749,
- 51.639982
]
], - "properties": {
- "height": "4",
- "material": "1"
}
}
}
]
}{- "info": "Added 1 item(s) of clutter. Rejected 0 item(s) of clutter. Total 1 items(s) of clutter exist on your profile."
}This endpoint fetches private clutter items for the given co-ordinates out to 1 decimal degree radius (approximately 120 km at the equator).
Results are limited to 100 items sorted by nearest first.
GeoJSON coordinates are passed as a clean URL, for example, https://api.cloudrf.com/clutter/get/51.637723/-2.649606
| latitude required | number <float> Example: 51.637723 GeoJSON coordinate latitude in decimal degrees. |
| longitude required | number <float> Example: -2.649606 GeoJSON coordinate longitude in decimal degrees. |
{- "features": {
- "type": "Feature",
- "features": {
- "geometry": "Polygon",
- "coordinates": "[-2.646178,51.639692]",
- "properties": {
- "height": "4",
- "material": "1"
}
}
}, - "id": {
- "id": "643"
}
}Delete a private clutter item referenced by its id passed as a clean URL. For example, /clutter/delete/123
The id is returned by the get clutter endpoint (/clutter/get)
Please note that if you pass in an id value of 0 then all clutter for your profile will be deleted.
| id required | integer Clutter |
{- "info": "Deleted a total of 1 clutter entries. ID #2858 deleted."
}| frequency | number <integer> Center frequency in megahertz for the noise data. |
| noise | number <integer> [ -144 .. -20 ] Noise data value in dBm. |
| latitude | number <float> Latitude of noise value in WGS84 decimal degrees. |
| longitude | number <float> Longitude of noise value in WGS84 decimal degrees. |
[- {
- "frequency": 446,
- "noise": -87,
- "latitude": 38.912706,
- "longitude": 1.439883
}, - {
- "frequency": 446,
- "noise": -85,
- "latitude": 38.913,
- "longitude": 1.44
}, - {
- "frequency": 446,
- "noise": -90,
- "latitude": 38.914,
- "longitude": 1.441
}
]{- "message": "Noise data successfully stored."
}| frequency | number <integer> Center frequency in megahertz for the noise data to retrieve. |
| bandwidth | number Bandwidth in MHz. |
| latitude | number <float> Latitude of noise value in WGS84 decimal degrees. |
| longitude | number <float> Longitude of noise value in WGS84 decimal degrees. |
| radius | number <integer> [ 1 .. 200 ] Radius from the latitude/longitude location to include noise data. |
[- {
- "frequency": 446,
- "bandwidth": 0.1,
- "latitude": 38.912706,
- "longitude": 1.439883,
- "radius": 5
}, - {
- "frequency": 446,
- "bandwidth": 0.1,
- "latitude": 38.913,
- "longitude": 1.44,
- "radius": 5
}, - {
- "frequency": 446,
- "bandwidth": 0.1,
- "latitude": 38.914,
- "longitude": 1.441,
- "radius": 5
}
][- [
- {
- "latitude": 38.912706,
- "longitude": 1.439883,
- "average_noise_dBm": -102
}, - {
- "latitude": 38.913,
- "longitude": 1.44,
- "average_noise_dBm": -100
}, - {
- "latitude": 38.914,
- "longitude": 1.441,
- "average_noise_dBm": -105
}
]
]Returns an 8-bit greyscale geotiff where the value of each pixel is abs(noise floor) in dBm. Used for the user interface so users can see the noise.
| frequency | number Example: frequency=446 Center frequency in megahertz for the noise data to retrieve. |
| north | number Example: north=38.92 North bound of the noise map. |
| south | number Example: south=38.9 South bound of the noise map. |
| east | number Example: east=1.45 East bound of the noise map. |
| west | number Example: west=1.43 West bound of the noise map. |
| resolution | number Example: resolution=20 The resolution of the noise map in meters. |
| point_limit | integer Example: point_limit=20 The maximum number of noise data points to use in calculating noise map. |
Get a detailed breakdown of metrics and statistics for your account API usage over your purchase period. This includes a breakdown of total API requests and their types, along with the different types of requests which were made on each day.
{- "from": "2022-07-10 13:06:36.851",
- "count_total": 2279,
- "time_series": [
- {
- "2022-07-11": [
- {
- "area": 1,
- "path": 0,
- "points": 0,
- "mesh": 0,
- "interference": 0,
- "network": 0,
- "best_site_analysis": 0
}
]
}, - {
- "2022-07-12": [
- {
- "area": 102,
- "path": 6,
- "points": 15,
- "mesh": 6,
- "interference": 6,
- "network": 6,
- "best_site_analysis": 0
}
]
}, - {
- "2022-07-13": [
- {
- "area": 45,
- "path": 1,
- "points": 2,
- "mesh": 1,
- "interference": 1,
- "network": 1,
- "best_site_analysis": 0
}
]
}, - {
- "2022-07-14": [
- {
- "area": 31,
- "path": 3,
- "points": 6,
- "mesh": 3,
- "interference": 3,
- "network": 3,
- "best_site_analysis": 0
}
]
}, - {
- "2022-07-15": [
- {
- "area": 45,
- "path": 4,
- "points": 73,
- "mesh": 4,
- "interference": 4,
- "network": 4,
- "best_site_analysis": 0
}
]
}, - {
- "2022-07-18": [
- {
- "area": 62,
- "path": 25,
- "points": 23,
- "mesh": 6,
- "interference": 6,
- "network": 13,
- "best_site_analysis": 0
}
]
}, - {
- "2022-07-20": [
- {
- "area": 217,
- "path": 76,
- "points": 40,
- "mesh": 20,
- "interference": 20,
- "network": 20,
- "best_site_analysis": 0
}
]
}, - {
- "2022-07-21": [
- {
- "area": 30,
- "path": 2,
- "points": 6,
- "mesh": 3,
- "interference": 3,
- "network": 3,
- "best_site_analysis": 0
}
]
}, - {
- "2022-07-22": [
- {
- "area": 0,
- "path": 22,
- "points": 0,
- "mesh": 0,
- "interference": 0,
- "network": 0,
- "best_site_analysis": 0
}
]
}, - {
- "2022-07-25": [
- {
- "area": 102,
- "path": 3,
- "points": 0,
- "mesh": 0,
- "interference": 0,
- "network": 0,
- "best_site_analysis": 35
}
]
}, - {
- "2022-07-26": [
- {
- "area": 134,
- "path": 0,
- "points": 375,
- "mesh": 0,
- "interference": 0,
- "network": 0,
- "best_site_analysis": 20
}
]
}, - {
- "2022-07-27": [
- {
- "area": 11,
- "path": 1,
- "points": 29,
- "mesh": 1,
- "interference": 1,
- "network": 1,
- "best_site_analysis": 4
}
]
}, - {
- "2022-07-28": [
- {
- "area": 10,
- "path": 53,
- "points": 2,
- "mesh": 1,
- "interference": 1,
- "network": 1,
- "best_site_analysis": 0
}
]
}, - {
- "2022-07-29": [
- {
- "area": 0,
- "path": 37,
- "points": 0,
- "mesh": 0,
- "interference": 0,
- "network": 0,
- "best_site_analysis": 0
}
]
}, - {
- "2022-08-01": [
- {
- "area": 50,
- "path": 1,
- "points": 19,
- "mesh": 1,
- "interference": 3,
- "network": 1,
- "best_site_analysis": 9
}
]
}, - {
- "2022-08-02": [
- {
- "area": 56,
- "path": 4,
- "points": 8,
- "mesh": 1,
- "interference": 2,
- "network": 4,
- "best_site_analysis": 0
}
]
}, - {
- "2022-08-03": [
- {
- "area": 109,
- "path": 11,
- "points": 92,
- "mesh": 11,
- "interference": 14,
- "network": 11,
- "best_site_analysis": 0
}
]
}, - {
- "2022-08-04": [
- {
- "area": 1,
- "path": 0,
- "points": 0,
- "mesh": 0,
- "interference": 0,
- "network": 0,
- "best_site_analysis": 0
}
]
}, - {
- "2022-08-05": [
- {
- "area": 15,
- "path": 0,
- "points": 0,
- "mesh": 0,
- "interference": 0,
- "network": 0,
- "best_site_analysis": 23
}
]
}, - {
- "2022-08-08": [
- {
- "area": 1,
- "path": 0,
- "points": 0,
- "mesh": 0,
- "interference": 0,
- "network": 0,
- "best_site_analysis": 3
}
]
}, - {
- "2022-08-09": [
- {
- "area": 30,
- "path": 1,
- "points": 2,
- "mesh": 0,
- "interference": 0,
- "network": 1,
- "best_site_analysis": 0
}
]
}
], - "types_total": {
- "area": 1052,
- "path": 250,
- "points": 692,
- "mesh": 58,
- "interference": 64,
- "network": 69,
- "best_site_analysis": 94
}, - "remaining_calculations_since_last_purchase": 2983
}This set of endpoints allow the user to manage reusable radio templates with pre-defined values.
Get the content of a template. This is requested in one of 2 ways:
id of the custom template which you have previously created.name of the system template which is available. Please note that some system templates may not have the same number of response values as a custom template.| id required | integer The |
{- "version": "CloudRF-API-v3.4.0",
- "template": {
- "name": "MPU5",
- "service": "Cloud-RF https://api.cloudrf.com",
- "created_at": "2022-10-25T09:49:49+00:00",
- "owner": 1,
- "bom_value": 0
}, - "site": "Site",
- "network": "Network",
- "engine": 2,
- "coordinates": 1,
- "transmitter": {
- "lat": 38.913,
- "lon": 1.44,
- "alt": 1,
- "frq": 446,
- "txw": 1,
- "bwi": 0.1,
- "powerUnit": "W"
}, - "receiver": {
- "lat": 38.906986,
- "lon": 1.421416,
- "alt": 0.1,
- "rxg": 3,
- "rxs": -100
}, - "feeder": {
- "flt": 1,
- "fll": 0,
- "fcc": 0
}, - "antenna": {
- "mode": "template",
- "txg": 2.15,
- "txl": 0,
- "ant": 39,
- "azi": 0,
- "tlt": 0,
- "hbw": 120,
- "vbw": 120,
- "fbr": 2.15,
- "pol": "v"
}, - "model": {
- "pm": 1,
- "pe": 2,
- "ked": 1,
- "rel": 90
}, - "environment": {
- "clt": "Minimal.clt",
- "elevation": 1,
- "landcover": 0,
- "buildings": 0,
- "obstacles": 0
}, - "output": {
- "units": "m",
- "col": "RAINBOW.dBm",
- "out": 2,
- "ber": 2,
- "mod": 7,
- "nf": -100,
- "res": 20,
- "rad": 5
}
}Download the content of a template. Please note that this request returns exactly the same JSON as /template/{id|name}
The id|name is requested in one of 2 ways:
id of the custom template which you have previously created.name of the system template which is available. Please note that some system templates may not have the same number of response values as a custom template.| id|name required | integer The |
Delete a custom template which has been created by your user account.
| id required | integer The |
{- "message": "Successfully deleted template with ID 59324."
}Unfavourite a system template.
| name required | string The |
{- "message": "Successfully unfavourited template 'MPU5'."
}Store a new custom template. This endpoint accepts either a JSON data payload, or it can be requested by sending multipart form data of a JSON file with the same contents as the JSON data payload.
This endpoint accepts either a JSON data payload, or it can be requested by sending multipart form data of a JSON file with the same contents as the JSON data payload.
| site | string Site name |
| network | string Network name |
| engine | number <integer> The processing engine associated with the template.
|
| coordinates | number <integer> The coordinates system associated with the template.
|
object | |
object (Receiver) | |
object | |
object | |
object | |
object (Environment) | |
object |
{- "site": "Site",
- "network": "Network",
- "engine": 2,
- "coordinates": 1,
- "transmitter": {
- "lat": 38.913,
- "lon": 1.44,
- "alt": 1,
- "frq": 446,
- "txw": 1,
- "bwi": 0.1,
- "powerUnit": "W"
}, - "receiver": {
- "lat": 38.906986,
- "lon": 1.421416,
- "alt": 0.1,
- "rxg": 3,
- "rxs": -100
}, - "feeder": {
- "flt": 1,
- "fll": 0,
- "fcc": 0
}, - "antenna": {
- "mode": "template",
- "txg": 2.15,
- "txl": 0,
- "ant": 39,
- "azi": 0,
- "tlt": 0,
- "hbw": 120,
- "vbw": 120,
- "fbr": 2.15,
- "pol": "v"
}, - "model": {
- "pm": 1,
- "pe": 2,
- "ked": 1,
- "rel": 90,
- "month": 6,
- "hour": 12,
- "sunspots_r12": 100
}, - "environment": {
- "clt": "Minimal.clt",
- "elevation": 1,
- "landcover": 0,
- "buildings": 0,
- "obstacles": 0
}, - "output": {
- "units": "m",
- "col": "RAINBOW.dBm",
- "out": 2,
- "ber": 2,
- "mod": 7,
- "nf": -100,
- "res": 20,
- "rad": 5
}
}{- "message": "Successfully stored template."
}This endpoint returns a paginated list of TLE results (Over 6000 active satellites) from the database. The data is updated regularly from a third party source.
| name | string Example: name=skynet Satellite name. Not case sensitive and can be partial eg skynet* |
| norad_cat_id | integer Example: norad_cat_id=20776 NORAD catalogue number |
This GPU accelerated endpoint allows you to test coverage from a satellite, by name, to a defined box on the earth.
| satellites | Array of strings Array of satellites to test, listed by name |
| date_time | string ISO-8601 timestamp for querying TLE data. |
object Details relating to the receiver in the request. | |
object (Environment) | |
object Details relating to the output |
{- "satellites": [
- "SKYNET 4C"
], - "date_time": "2024-07-23T04:54:28Z",
- "receiver": {
- "alt": 1
}, - "environment": {
- "clt": "Minimal.clt",
- "elevation": 1,
- "landcover": 0,
- "buildings": 0,
- "obstacles": 0
}, - "output": {
- "col": "GREEN.dBm",
- "res": 10,
- "rx_units": "m",
- "bounds": {
- "north": -41.272,
- "east": 174.788,
- "south": -41.294,
- "west": 174.773
}
}
}{- "bounds": [
- [
- 38.942844475233805,
- 1.4826338797780443,
- 38.88915552476619,
- 1.413357814658543
]
], - "id": 3930916,
- "sid": "M2ZSaUZuVlVDRno3TTJDTGVqRGJlUT09",
- "area": 0,
- "coverage": "0%",
- "key": [
- [
- {
- "l": "-20dBm",
- "r": 255,
- "g": 19,
- "b": 0
}, - {
- "l": "-24dBm",
- "r": 255,
- "g": 61,
- "b": 0
}, - {
- "l": "-28dBm",
- "r": 255,
- "g": 102,
- "b": 0
}, - {
- "l": "-32dBm",
- "r": 255,
- "g": 144,
- "b": 0
}, - {
- "l": "-36dBm",
- "r": 255,
- "g": 185,
- "b": 0
}, - {
- "l": "-40dBm",
- "r": 255,
- "g": 227,
- "b": 0
}, - {
- "l": "-44dBm",
- "r": 242,
- "g": 255,
- "b": 0
}, - {
- "l": "-48dBm",
- "r": 200,
- "g": 255,
- "b": 0
}, - {
- "l": "-52dBm",
- "r": 159,
- "g": 255,
- "b": 0
}, - {
- "l": "-56dBm",
- "r": 117,
- "g": 255,
- "b": 0
}, - {
- "l": "-60dBm",
- "r": 76,
- "g": 255,
- "b": 0
}, - {
- "l": "-64dBm",
- "r": 34,
- "g": 255,
- "b": 0
}, - {
- "l": "-68dBm",
- "r": 0,
- "g": 255,
- "b": 7
}, - {
- "l": "-72dBm",
- "r": 0,
- "g": 255,
- "b": 49
}, - {
- "l": "-76dBm",
- "r": 0,
- "g": 255,
- "b": 90
}, - {
- "l": "-80dBm",
- "r": 0,
- "g": 255,
- "b": 132
}, - {
- "l": "-84dBm",
- "r": 0,
- "g": 255,
- "b": 173
}, - {
- "l": "-88dBm",
- "r": 0,
- "g": 255,
- "b": 215
}, - {
- "l": "-92dBm",
- "r": 0,
- "g": 254,
- "b": 255
}, - {
- "l": "-96dBm",
- "r": 0,
- "g": 212,
- "b": 255
}, - {
- "l": "-100dBm",
- "r": 0,
- "g": 171,
- "b": 255
}, - {
- "l": "-104dBm",
- "r": 0,
- "g": 129,
- "b": 255
}, - {
- "l": "-108dBm",
- "r": 0,
- "g": 88,
- "b": 255
}, - {
- "l": "-112dBm",
- "r": 0,
- "g": 46,
- "b": 255
}
]
], - "elapsed": 1572,
- "balance": 1,
- "calculation_adjusted": [ ],
- "satellites": [ ]
}