HotspotRF API Documentation

Introduction

To begin, at this time you will need to be a subscriber to receive API access: https://hotspotrf.com/pricing/

You do not have to have an account or be a subscriber to test out: https://app.api.hotspotrf.com/v1?debug=true

Are you a subscriber? You can access your API key here: https://hotspotrf.com/api/

Always looking for improvements: feel free to reply to this discussion with those improvement ideas.

Single Point Simulation Documentation

You are charged 1 credit per call. Best to do debug mode first to play around with it!

Pretty straightforward. You can either put in an address or lat/lng to find the estimated $HNT rewards, scale, hotspots you’ll reach, and other information.

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?addy=1437 Cherry St, South Plainfield, NJ 07080

When in doubt, use lat/lng:

https://app.api.hotspotrf.com/v1?lat=40.583676&lng=-74.437985

Terrain - New for July!

Currently, there are five options:

• suburbs https://app.api.hotspotrf.com/v1?lat=40.583676&lng=-74.437985&env=suburbs
• mix https://app.api.hotspotrf.com/v1?lat=40.583676&lng=-74.437985&env=mix
• urban https://app.api.hotspotrf.com/v1?lat=40.583676&lng=-74.437985&env=urban
• wooded https://app.api.hotspotrf.com/v1?lat=40.583676&lng=-74.437985&env=wooded
• clear https://app.api.hotspotrf.com/v1?lat=40.583676&lng=-74.437985&env=clear

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?lat=40.583676&lng=-74.437985&env=clear&fq=915
• Europe - 868 MHz https://app.api.hotspotrf.com/v1?lat=40.583676&lng=-74.437985&env=clear&fq=868
• UK & Ireland - 868 MHz https://app.api.hotspotrf.com/v1?lat=40.583676&lng=-74.437985&env=clear&fq=868
• Australia - 915 MHz https://app.api.hotspotrf.com/v1?lat=40.583676&lng=-74.437985&env=clear&fq=915
• Asia - 923 MHz https://app.api.hotspotrf.com/v1?lat=40.583676&lng=-74.437985&env=clear&fq=923
• China - 470 MHz https://app.api.hotspotrf.com/v1?lat=40.583676&lng=-74.437985&env=clear&fq=470

Antenna Gain (dBi)

The antenna gain of your hotspot.

https://app.api.hotspotrf.com/v1?lat=40.583676&lng=-74.437985&env=clear&fq=915&ant=2.8

Cable Loss (dB)

Cable loss your hotspot may experience - if any.

https://app.api.hotspotrf.com/v1?lat=40.583676&lng=-74.437985&env=clear&fq=915&ant=2.8&cbl=0

Height

How high will your hotspot be?

https://app.api.hotspotrf.com/v1?lat=40.583676&lng=-74.437985&env=clear&fq=915&ant=2.8&cbl=0&ht=5

Units

You can choose either ft or meters:

https://app.api.hotspotrf.com/v1?lat=40.583676&lng=-74.437985&env=clear&fq=915&ant=2.8&cbl=0&ht=5&unit=ft

or

https://app.api.hotspotrf.com/v1?lat=40.583676&lng=-74.437985&env=clear&fq=915&ant=2.8&cbl=0&ht=5&unit=m

Verbose (optional)

Will report back how long it took to execute:

https://app.api.hotspotrf.com/v1?lat=40.583676&lng=-74.437985&env=clear&fq=915&ant=2.8&cbl=0&ht=5&unit=ft&v=true

List Reached (optional)

If you’d like a list of hotspots you’ll be able to reach:

https://app.api.hotspotrf.com/v1?lat=40.583676&lng=-74.437985&env=clear&fq=915&ant=2.8&cbl=0&ht=5&unit=ft&listreach=true

Check (optional)

You may be restricted by a CRM on API timeouts. You can always do a “check”. You just make the same call as you would, but with check=true and you’ll be returned the latest historic information in the last 30 minutes in relation to that call.

https://app.api.hotspotrf.com/v1?lat=40.583676&lng=-74.437985&env=clear&fq=915&ant=2.8&cbl=0&ht=5&unit=ft&check=true

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?lat=40.583676&lng=-74.437985&env=clear&fq=915&placement=indoor
• Outdoor https://app.api.hotspotrf.com/v1?lat=40.583676&lng=-74.437985&env=clear&fq=915&placement=outdoor
• Unsure https://app.api.hotspotrf.com/v1?lat=40.583676&lng=-74.437985&env=clear&fq=915&placement=unsure

Your API Key

You will need to have an API key:

https://app.api.hotspotrf.com/v1?lat=40.583676&lng=-74.437985&env=clear&fq=915&ant=2.8&cbl=0&ht=5&unit=ft&key={MYAPIKEY}

Debug

If you’re wanting to test and not burn credits:

https://app.api.hotspotrf.com/v1?debug=true

When in debug mode, all the data returned is fake data.

Integrations

Zoho CRM - https://github.com/hotspotrf/zoho