Multipoint Beta Simulation Documentation
You are charged 2 credits per call up to 10 simulations. Best to do debug mode first to play around with it!
e.g. You want to simulate 7 points, 2 points or even 10 points, you’re charged 2 credits.
At this time this doesn’t return $HNT rewards, but does return Reward/Transmit scale.
You will only be returned the reward/transmit scale, RF data, and KMZ files of the simulated areas and an all-in-one KMZ file of the simulated areas. We’ve chosen to release a beta version of multipoint for those that are needing it due to deployment of sensors and the like. Expect full release and version 2.0 of our API on next portal release.
Since this is beta, be aware that this will not be logged into your history and not available in the portal.
Debug
If you’re wanting to test and not burn credits:
https://app.api.hotspotrf.com/v1?multi=true&debug=true
Your API Key
You will need to have an API key from https://hotspotrf.com/api/ and use it as so:
https://app.api.hotspotrf.com/v1?multi=true&sims=[('name': 'my cool simulation', 'lat': '30.583676', 'lng': '-74.437985', 'ht': '10', 'fq': '915', 'env': 'clear', 'ant': '2.3', 'cbl': '0', 'unit': 'ft'),('name': 'my other awesome simulation', 'addy': '1437 Cherry St, South Plainfield, NJ 07080', 'ht': '10', 'fq': '915', 'env': 'clear', 'ant': '2.3', 'cbl': '0', 'unit': 'ft')]&key={MYAPIKEY}
Address or Lat/Lng
The API can handle direct address input e.g: 1437 Cherry St, South Plainfield, NJ 07080. It can handle other country addresses as well. Please be aware that the address format follows your country’s address standardization. Here’s an example:
https://app.api.hotspotrf.com/v1?multi=true&sims=[('name': 'my cool simulation', 'addy': '1437 Cherry St, South Plainfield, NJ 07080', 'ht': '10', 'fq': '915', 'env': 'clear', 'ant': '2.3', 'cbl': '0', 'unit': 'ft'),('name': 'my other awesome simulation', 'addy': '1437 Cherry St, South Plainfield, NJ 07080', 'ht': '10', 'fq': '915', 'env': 'clear', 'ant': '2.3', 'cbl': '0', 'unit': 'ft')]&key={MYAPIKEY}
When in doubt, use lat/lng:
https://app.api.hotspotrf.com/v1?multi=true&sims=[('name': 'my cool simulation', 'lat': '30.583676', 'lng': '-74.437985', 'ht': '10', 'fq': '915', 'env': 'clear', 'ant': '2.3', 'cbl': '0', 'unit': 'ft'),('name': 'my other awesome simulation', 'lat': '30.583676', 'lng': '-74.437985', 'ht': '10', 'fq': '915', 'env': 'clear', 'ant': '2.3', 'cbl': '0', 'unit': 'ft')]&v=true&key={MYAPIKEY}
You can mix it up if you so choose:
https://app.api.hotspotrf.com/v1?multi=true&sims=[('name': 'my cool simulation', 'lat': '30.583676', 'lng': '-74.437985', 'ht': '10', 'fq': '915', 'env': 'clear', 'ant': '2.3', 'cbl': '0', 'unit': 'ft'),('name': 'my other awesome simulation', 'addy': '1437 Cherry St, South Plainfield, NJ 07080', 'ht': '10', 'fq': '915', 'env': 'clear', 'ant': '2.3', 'cbl': '0', 'unit': 'ft')]&key={MYAPIKEY}
Terrain - New for July!
Currently there are five options:
- suburbs
https://app.api.hotspotrf.com/v1?multi=true&sims=[('name': 'my cool simulation', 'lat': '30.583676', 'lng': '-74.437985', 'ht': '10', 'fq': '915', 'env': 'suburbs', 'ant': '2.3', 'cbl': '0', 'unit': 'ft'),('name': 'my other awesome simulation', 'addy': '1437 Cherry St, South Plainfield, NJ 07080', 'ht': '10', 'fq': '915', 'env': 'clear', 'ant': '2.3', 'cbl': '0', 'unit': 'ft')]&key={MYAPIKEY}
- mix
https://app.api.hotspotrf.com/v1?multi=true&sims=[('name': 'my cool simulation', 'lat': '30.583676', 'lng': '-74.437985', 'ht': '10', 'fq': '915', 'env': 'mix', 'ant': '2.3', 'cbl': '0', 'unit': 'ft'),('name': 'my other awesome simulation', 'addy': '1437 Cherry St, South Plainfield, NJ 07080', 'ht': '10', 'fq': '915', 'env': 'mix', 'ant': '2.3', 'cbl': '0', 'unit': 'ft')]&key={MYAPIKEY}
- urban
https://app.api.hotspotrf.com/v1?multi=true&sims=[('name': 'my cool simulation', 'lat': '30.583676', 'lng': '-74.437985', 'ht': '10', 'fq': '915', 'env': 'urban', 'ant': '2.3', 'cbl': '0', 'unit': 'ft'),('name': 'my other awesome simulation', 'addy': '1437 Cherry St, South Plainfield, NJ 07080', 'ht': '10', 'fq': '915', 'env': 'clear', 'ant': '2.3', 'cbl': '0', 'unit': 'ft')]&key={MYAPIKEY}
- wooded
https://app.api.hotspotrf.com/v1?multi=true&sims=[('name': 'my cool simulation', 'lat': '30.583676', 'lng': '-74.437985', 'ht': '10', 'fq': '915', 'env': 'wooded', 'ant': '2.3', 'cbl': '0', 'unit': 'ft'),('name': 'my other awesome simulation', 'addy': '1437 Cherry St, South Plainfield, NJ 07080', 'ht': '10', 'fq': '915', 'env': 'clear', 'ant': '2.3', 'cbl': '0', 'unit': 'ft')]&key={MYAPIKEY}
- clear
https://app.api.hotspotrf.com/v1?multi=true&sims=[('name': 'my cool simulation', 'lat': '30.583676', 'lng': '-74.437985', 'ht': '10', 'fq': '915', 'env': 'clear', 'ant': '2.3', 'cbl': '0', 'unit': 'ft'),('name': 'my other awesome simulation', 'addy': '1437 Cherry St, South Plainfield, NJ 07080', 'ht': '10', 'fq': '915', 'env': 'clear', 'ant': '2.3', 'cbl': '0', 'unit': 'ft')]&key={MYAPIKEY}
Each one is dependent on the environment/terrain of the area. Clear standing for “clear line of sight”.
Frequency (MHz)
- US/CAN - 915 MHz
https://app.api.hotspotrf.com/v1?multi=true&sims=[('name': 'my cool simulation', 'lat': '30.583676', 'lng': '-74.437985', 'ht': '10', 'fq': '915', 'env': 'clear', 'ant': '2.3', 'cbl': '0', 'unit': 'ft'),('name': 'my other awesome simulation', 'addy': '1437 Cherry St, South Plainfield, NJ 07080', 'ht': '10', 'fq': '915', 'env': 'clear', 'ant': '2.3', 'cbl': '0', 'unit': 'ft')]&key={MYAPIKEY}
- Europe - 868 MHz
https://app.api.hotspotrf.com/v1?multi=true&sims=[('name': 'my cool simulation', 'lat': '30.583676', 'lng': '-74.437985', 'ht': '10', 'fq': '868', 'env': 'clear', 'ant': '2.3', 'cbl': '0', 'unit': 'ft'),('name': 'my other awesome simulation', 'addy': '1437 Cherry St, South Plainfield, NJ 07080', 'ht': '10', 'fq': '915', 'env': 'clear', 'ant': '2.3', 'cbl': '0', 'unit': 'ft')]&key={MYAPIKEY}
- UK & Ireland - 868 MHz
https://app.api.hotspotrf.com/v1?multi=true&sims=[('name': 'my cool simulation', 'lat': '30.583676', 'lng': '-74.437985', 'ht': '10', 'fq': '868', 'env': 'clear', 'ant': '2.3', 'cbl': '0', 'unit': 'ft'),('name': 'my other awesome simulation', 'addy': '1437 Cherry St, South Plainfield, NJ 07080', 'ht': '10', 'fq': '915', 'env': 'clear', 'ant': '2.3', 'cbl': '0', 'unit': 'ft')]&key={MYAPIKEY}
- Australia - 915 MHz
https://app.api.hotspotrf.com/v1?multi=true&sims=[('name': 'my cool simulation', 'lat': '30.583676', 'lng': '-74.437985', 'ht': '10', 'fq': '915', 'env': 'clear', 'ant': '2.3', 'cbl': '0', 'unit': 'ft'),('name': 'my other awesome simulation', 'addy': '1437 Cherry St, South Plainfield, NJ 07080', 'ht': '10', 'fq': '915', 'env': 'clear', 'ant': '2.3', 'cbl': '0', 'unit': 'ft')]&key={MYAPIKEY}
- Asia - 923 MHz
https://app.api.hotspotrf.com/v1?multi=true&sims=[('name': 'my cool simulation', 'lat': '30.583676', 'lng': '-74.437985', 'ht': '10', 'fq': '923', 'env': 'clear', 'ant': '2.3', 'cbl': '0', 'unit': 'ft'),('name': 'my other awesome simulation', 'addy': '1437 Cherry St, South Plainfield, NJ 07080', 'ht': '10', 'fq': '915', 'env': 'clear', 'ant': '2.3', 'cbl': '0', 'unit': 'ft')]&key={MYAPIKEY}
- China - 470 MHz
https://app.api.hotspotrf.com/v1?multi=true&sims=[('name': 'my cool simulation', 'lat': '30.583676', 'lng': '-74.437985', 'ht': '10', 'fq': '470', 'env': 'clear', 'ant': '2.3', 'cbl': '0', 'unit': 'ft'),('name': 'my other awesome simulation', 'addy': '1437 Cherry St, South Plainfield, NJ 07080', 'ht': '10', 'fq': '915', 'env': 'clear', 'ant': '2.3', 'cbl': '0', 'unit': 'ft')]&key={MYAPIKEY}
Again, feel free to mix and match.
Antenna Gain (dBi)
Simply just the antenna gain of your hotspot. In this example it’s 2.3 under ant, just replace that with your antenna gain:
https://app.api.hotspotrf.com/v1?multi=true&sims=[('name': 'my cool simulation', 'lat': '30.583676', 'lng': '-74.437985', 'ht': '10', 'fq': '915', 'env': 'clear', 'ant': '2.3', 'cbl': '0', 'unit': 'ft'),('name': 'my other awesome simulation', 'addy': '1437 Cherry St, South Plainfield, NJ 07080', 'ht': '10', 'fq': '915', 'env': 'clear', 'ant': '2.3', 'cbl': '0', 'unit': 'ft')]&key={MYAPIKEY}
Cable Loss (dB)
Cable loss your hotspot may experience - if any. In this example it’s 0 under cbl, just replace that with your cable loss:
https://app.api.hotspotrf.com/v1?multi=true&sims=[('name': 'my cool simulation', 'lat': '30.583676', 'lng': '-74.437985', 'ht': '10', 'fq': '915', 'env': 'clear', 'ant': '2.3', 'cbl': '0', 'unit': 'ft'),('name': 'my other awesome simulation', 'addy': '1437 Cherry St, South Plainfield, NJ 07080', 'ht': '10', 'fq': '915', 'env': 'clear', 'ant': '2.3', 'cbl': '0', 'unit': 'ft')]&key={MYAPIKEY}
Height
How high will your hotspot be? In this example it’s 10 under ht, just replace that with your actual height:
https://app.api.hotspotrf.com/v1?multi=true&sims=[('name': 'my cool simulation', 'lat': '30.583676', 'lng': '-74.437985', 'ht': '10', 'fq': '915', 'env': 'clear', 'ant': '2.3', 'cbl': '0', 'unit': 'ft'),('name': 'my other awesome simulation', 'addy': '1437 Cherry St, South Plainfield, NJ 07080', 'ht': '10', 'fq': '915', 'env': 'clear', 'ant': '2.3', 'cbl': '0', 'unit': 'ft')]&key={MYAPIKEY}
Units
You can choose either ft or meters. In this example it’s ft under unit, just replace that with your preferred unit of measurement:
https://app.api.hotspotrf.com/v1?multi=true&sims=[('name': 'my cool simulation', 'lat': '30.583676', 'lng': '-74.437985', 'ht': '10', 'fq': '915', 'env': 'clear', 'ant': '2.3', 'cbl': '0', 'unit': 'ft'),('name': 'my other awesome simulation', 'addy': '1437 Cherry St, South Plainfield, NJ 07080', 'ht': '10', 'fq': '915', 'env': 'clear', 'ant': '2.3', 'cbl': '0', 'unit': 'ft')]&key={MYAPIKEY}
Verbose (optional)
Will report back how long it took to execute:
https://app.api.hotspotrf.com/v1?multi=true&sims=[('name': 'my cool simulation', 'lat': '30.583676', 'lng': '-74.437985', 'ht': '10', 'fq': '915', 'env': 'clear', 'ant': '2.3', 'cbl': '0', 'unit': 'ft'),('name': 'my other awesome simulation', 'addy': '1437 Cherry St, South Plainfield, NJ 07080', 'ht': '10', 'fq': '915', 'env': 'clear', 'ant': '2.3', 'cbl': '0', 'unit': 'ft')]&v=true&key={MYAPIKEY}
Placement (optional) - New for July!
You can now select whether you’ll be placing the hotspot outside, inside or if you’re unsure or prefer legacy; that’s fine too!
- Indoor
https://app.api.hotspotrf.com/v1?multi=true&sims=[('name': 'my cool simulation', 'lat': '30.583676', 'lng': '-74.437985', 'ht': '10', 'fq': '915', 'env': 'clear', 'ant': '2.3', 'cbl': '0', 'unit': 'ft', 'plc':'indoor'),('name': 'my other awesome simulation', 'addy': '1437 Cherry St, South Plainfield, NJ 07080', 'ht': '10', 'fq': '915', 'env': 'clear', 'ant': '2.3', 'cbl': '0', 'unit': 'ft', 'plc':'indoor')]&key={MYAPIKEY}
- Outdoor
https://app.api.hotspotrf.com/v1?multi=true&sims=[('name': 'my cool simulation', 'lat': '30.583676', 'lng': '-74.437985', 'ht': '10', 'fq': '915', 'env': 'clear', 'ant': '2.3', 'cbl': '0', 'unit': 'ft', 'plc':'outdoor'),('name': 'my other awesome simulation', 'addy': '1437 Cherry St, South Plainfield, NJ 07080', 'ht': '10', 'fq': '915', 'env': 'clear', 'ant': '2.3', 'cbl': '0', 'unit': 'ft', 'plc':'outdoor')]&key={MYAPIKEY}
- Unsure
https://app.api.hotspotrf.com/v1?multi=true&sims=[('name': 'my cool simulation', 'lat': '30.583676', 'lng': '-74.437985', 'ht': '10', 'fq': '915', 'env': 'clear', 'ant': '2.3', 'cbl': '0', 'unit': 'ft', 'plc':'unsure'),('name': 'my other awesome simulation', 'addy': '1437 Cherry St, South Plainfield, NJ 07080', 'ht': '10', 'fq': '915', 'env': 'clear', 'ant': '2.3', 'cbl': '0', 'unit': 'ft', 'plc':'unsure')]&key={MYAPIKEY}
Mix & Match
Remember you can always mix and match your simulations with different frequencies or have one use lat/lng and another use an address.
Feedback!
Being that this is beta - reach out to us if you want something added - either reply here or e-mail us at hello@hotspotrf.com that way it can be included in the next release.