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.
Contact Support:\n Email: support@cloudrf.com
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"3523402","collectionId":"8f2889e7-f49a-4724-8fa8-3f109e336a96","publishedId":"2sBXcBnNFB","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2026-02-13T13:01:54.000Z"},"item":[{"name":"Create","item":[{"name":"Multipoint coverage heatmap","id":"cd9baaa2-8c3f-4c0d-9b22-4f0ed1d592e1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"site\": \"A1\",\n \"network\": \"Testing\",\n \"transmitter\": {\n \"lat\": 38.916,\n \"lon\": 1.448,\n \"alt\": 2,\n \"frq\": 446,\n \"txw\": 1,\n \"bwi\": 1\n },\n \"receiver\": {\n \"lat\": 0,\n \"lon\": 0,\n \"alt\": 2,\n \"rxg\": 3,\n \"rxs\": -100\n },\n \"antenna\": {\n \"txg\": 2.15,\n \"txl\": 0,\n \"ant\": 0,\n \"azi\": 90,\n \"tlt\": 1,\n \"hbw\": 120,\n \"vbw\": 30,\n \"pol\": \"v\"\n },\n \"environment\": {\n \"clt\": \"Minimal.clt\",\n \"elevation\": 1,\n \"landcover\": 0,\n \"buildings\": 0,\n \"obstacles\": 0\n },\n \"output\": {\n \"units\": \"metric\",\n \"col\": \"RAINBOW.dBm\",\n \"out\": 2,\n \"nf\": -100,\n \"res\": 10,\n \"rad\": 5\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.cloudrf.com/area","description":"This endpoint returns an omni-directional coverage plot (point-to-multipoint) as an image.\nThis function assumes a consistent receiver height at all locations out to fixed radius.\nSpeed can be improved by adjusting the resolution with the \"res\" parameter.\nA standard request requires a transmitter, receiver, antenna and output objects. Providing a model and environment enhances accuracy.
\n","auth":{"type":"apikey","apikey":{"key":"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.
\n","auth":{"type":"apikey","apikey":{"key":"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 and dynamic modelling. The simplest request requires: transmitter values, points array of tuples (latitude, longitude, altitude), generic antenna, receiver, and output objects defined. Model and environment options enhance accuracy.
\n","auth":{"type":"apikey","apikey":{"key":"The multilink function tests an array of radios, each with its own antenna, to each other and is designed for large/fast mesh networks. The simplest request requires an array of radios and output options like resolution. Model and environment options enhance accuracy. The response is terse for scale and you should use path or points for more metadata
\n","auth":{"type":"apikey","apikey":{"key":"This powerful GPU endpoint allows you request multiple area calculations in one request and response. The layers are returned as a composite super layer.\nThis is useful for planning adhoc radio networks with many radios efficiently.
This endpoint returns an omni-directional coverage plot (point-to-multipoint) for HF skywave propagation as an image.
\n","auth":{"type":"apikey","apikey":{"key":"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.
\n","auth":{"type":"apikey","apikey":{"key":"This set of endpoints allows the user to create new links, site heatmaps, routes, and networks.
\n","_postman_id":"0ad175e6-c67e-4dd0-9ee3-f8d0b0993f50","auth":{"type":"apikey","apikey":{"key":"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.
\n","auth":{"type":"apikey","apikey":{"key":"This GPU accelerated endpoint allows you to test coverage from a satellite, by name, to a defined box on the earth.
\n","auth":{"type":"apikey","apikey":{"key":"This endpoint allows you to model 3D propagation inside a user-supplied building or tunnel. \nIt can handle reflections, material attenuation, fast-fading (dead-spots), 3D antenna patterns and multisite requests for many transmitters. \nThis uses GPU acceleration and is resource intensive.
\nOne of \"res\" and \"megavoxels\" is required, and calculation speed can be increased significantly by reducing \"megavoxels\" or increasing \"res\".
\n","auth":{"type":"apikey","apikey":{"key":"The file to upload.
\n","key":"file","type":"file","value":null}]},"url":"https://api.cloudrf.com/3d/model/upload","description":"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.
\nThe 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.
This set of endpoints allows the user to interact with the 3D processing engine.
\n","_postman_id":"2f0e6193-29e4-4527-a7c1-533bfd3a1263","auth":{"type":"apikey","apikey":{"key":"The best site analysis (BSA) endpoint can be used to find the best locations in a wider area for a transmitter.\nIt uses a GPU accelerated Monte Carlo simulation with hundreds of random locations to compare and grade radio intervisibility.\nPlease 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.\nFor best results, focus onto a single feature, like a valley or a ridge, not an entire mountain range.
\nThere are two methods to define an area of interest for a BSA caluclation:
\ntransmitter.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.
\n","auth":{"type":"apikey","apikey":{"key":"This endpoint returns a consolidated layer of many area calculations as a single super layer.\nStronger signals are promoted over weaker ones regardless of colour schema but units must match eg. dBm.\nMerging a dozen sites should take only a few seconds.\nMerging 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.
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.
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.
\n","auth":{"type":"apikey","apikey":{"key":"Network name.
\n","type":"text/plain"},"key":"net","value":"string"},{"description":{"content":"Super layer name.
\n","type":"text/plain"},"key":"nam","value":"string"},{"description":{"content":"Latitude in decimal degrees.
\n","type":"text/plain"},"key":"lat","value":"9039.316088158865"},{"description":{"content":"Longitude in decimal degrees.
\n","type":"text/plain"},"key":"lon","value":"9039.316088158865"},{"description":{"content":"Height above ground level in meters.
\n","type":"text/plain"},"key":"alt","value":"9039.316088158865"},{"description":{"content":"Receiver gain in dBi.
\n","type":"text/plain"},"key":"rxg","value":"9039.316088158865"}],"variable":[]}},"response":[{"id":"37a3727d-017d-4112-a6bd-444761393c80","name":"Success - JSON object returned providing results with a detailed path-profile output for each server.","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"key","value":"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.
\n","auth":{"type":"apikey","apikey":{"key":"This set of endpoints allows the user to use and analyse information from pre-defined networks and layers.
\n","_postman_id":"89cff1cd-64f5-45b8-9c47-ea785cacc89e","auth":{"type":"apikey","apikey":{"key":"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","auth":{"type":"apikey","apikey":{"key":"North bounding box. WGS84 decimal degrees.
\n","type":"text/plain"},"key":"n","value":"65"},{"description":{"content":"East bounding box. WGS84 decimal degrees.
\n","type":"text/plain"},"key":"e","value":"2"},{"description":{"content":"South bounding box. WGS84 decimal degrees.
\n","type":"text/plain"},"key":"s","value":"50"},{"description":{"content":"West bounding box. WGS84 decimal degrees.
\n","type":"text/plain"},"key":"w","value":"-5"}],"variable":[]}},"response":[{"id":"c32ff024-ffcf-4704-9aea-03d5bd61531f","name":"Success - JSON array returned providing of site names and limited metadata.","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"key","value":"Warning! You could lose data. \nThis endpoint deletes the entry from the database and the file from the disk.\nThis deletes a single calculation from the database and from your folder.
\n","auth":{"type":"apikey","apikey":{"key":"Unique calculation ID number.
\n","type":"text/plain"},"key":"cid","value":"9320"}],"variable":[]}},"response":[{"id":"42808bbb-d156-44bc-b35e-45d3c0e5046f","name":"Success - message returned confirming the number of sites deleted and elapsed time.","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"key","value":"Warning! You could lose lots of data. \nThis endpoint deletes all associated child entries from the database and the files from the disk.
\n","auth":{"type":"apikey","apikey":{"key":"Network name.
\n","type":"text/plain"},"key":"nid","value":"string"}],"variable":[]}},"response":[{"id":"e8d07cb3-2168-4124-ba94-e6aa5161b876","name":"A message confirming the number of sites deleted and elapsed time.","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"key","value":"This endpoint downloads your data in a format suitable for a third-party viewer such as Google Earth or ESRI Arcmap.\nSupported formats:
\nCalculation file name.
\n","type":"text/plain"},"key":"file","value":"string"},{"description":{"content":"Required file format: KML; KMZ; SHP; GeoTIFF or ATAK ZIP
\n","type":"text/plain"},"key":"fmt","value":"zip"}],"variable":[]}},"response":[{"id":"1b3fdb7b-bddb-4e25-bc16-290674d8c2a0","name":"Success - file download URL with the MIME type returned.","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"key","value":"This endpoint supports upload of GeoJSON lineString and polygon features to your account.
\n","auth":{"type":"apikey","apikey":{"key":"This endpoint fetches private clutter items for the given co-ordinates out to 1 decimal degree radius (approximately 120 km at the equator). \nResults are limited to 100 items sorted by nearest first. \nGeoJSON coordinates are passed as a clean URL, for example, https://api.cloudrf.com/clutter/get/51.637723/-2.649606
GeoJSON coordinate latitude in decimal degrees.
\n","type":"text/plain"},"type":"any","value":"51.637723","key":"latitude"},{"id":"94d320b4-8ea9-4634-b93c-84365b7e3470","description":{"content":"GeoJSON coordinate longitude in decimal degrees.
\n","type":"text/plain"},"type":"any","value":"-2.649606","key":"longitude"}]}},"response":[{"id":"43814829-ded4-4b19-bb7a-862caa03deb2","name":"Success - JSON Feature Collection array returned.","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"key","value":"Delete a private clutter item referenced by its id passed as a clean URL. For example, /clutter/delete/123\nThe id is returned by the get clutter endpoint (/clutter/get)\nPlease note that if you pass in an id value of 0 then all clutter for your profile will be deleted.
Clutter id number.
Similar to /clutter/delete/{id}, however if you pass an id value of 0 then you will delete all clutter on your profile.
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.
\n","auth":{"type":"apikey","apikey":{"key":"This set of endpoints allow the user to administer data, including enumeration, deletion, and exporting of data in open formats.
\n","_postman_id":"0d3c7d38-1c07-40f1-ab42-cb4508e0a9f5","auth":{"type":"apikey","apikey":{"key":"Get a detailed breakdown of metrics and statistics for your account API usage over your purchase period. \nThis includes a breakdown of total API requests and their types, along with the different types of requests which were made on each day.
\n","auth":{"type":"apikey","apikey":{"key":"This set of endpoints allow the user to manage their account.
\n","_postman_id":"f3e9798e-eef1-4509-a14b-9fd5644e9299","auth":{"type":"apikey","apikey":{"key":"Get an array of all custom templates which have been created by your user account.
\n","auth":{"type":"apikey","apikey":{"key":"Get an array of all system templates which are available on the system.
\n","auth":{"type":"apikey","apikey":{"key":"Get an array of system templates which have been favourited by your user account.
\n","auth":{"type":"apikey","apikey":{"key":"Get the content of a template. This is requested in one of 2 ways:
\nid 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.The id of a custom template which has been created, or the name of a system template which is available.
Download the content of a template. Please note that this request returns exactly the same JSON as /template/{id|name}\nThe 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.The id of a custom template which has been created, or the name of a system template which is available.
Delete a custom template which has been created by your user account.
\n","auth":{"type":"apikey","apikey":{"key":"The id of a custom template which should be deleted.
Favourite a system template.
\n","auth":{"type":"apikey","apikey":{"key":"The name of the system template which you would like to favourite.
Unfavourite a system template.
\n","auth":{"type":"apikey","apikey":{"key":"The name of the system template which you would like to unfavourite.
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.
\n","auth":{"type":"apikey","apikey":{"key":"This set of endpoints allow the user to manage reusable radio templates with pre-defined values.
\n","_postman_id":"0a413a21-2993-4e28-884b-2890f0a09e0a","auth":{"type":"apikey","apikey":{"key":"