Helium API

Home

About

Introduction

Hello and welcome to yet another Helium blog! I made this blog to complement the Helium Documentation specifically the APIs:

https://docs.helium.com/api

Here, run a "name" query to list all hotspots that contain a name string e.g "dragon", "chipmunk", "raccoon".

Or run a "geocode" query to list all hotspots that contain a geocode string e.g "berlin", "usa", "elm street".

And much more!



What you should already know

This blog will explain how to run queries and obatin information on the existing Helium network; hotspot details and financial details.

The hotspot details include the following:

  • Name
  • Geocode (Location)
  • Address
  • Longitude
  • Latitude
  • Timestamp_Added
  • Status
  • Reward_Scale
  • Payer
  • Owner
  • Nonce
  • Mode
  • Location_Hex
  • Location
  • Last_POC_Challenge
  • Last_Change_Block
  • Gain
  • Elevation
  • Block_Added
  • Block


    • The financial queries will return the following data:

  • Address
  • Staked_balance
  • Nonce
  • Balance
  • Sec_balance
  • Block
  • Dc_nonce
  • Dc_balance
  • Sec_nonce
  • Mobile_balance
  • Iot_balance


    • API Query - Name

    To run a query and find all names that contain the string "dragon" for example, execute the API call with the following:

    http://www.rexythebot.com:3000/name/dragon

    Of course you may try any other string aside from "dragon".

    For names that contain multiple words, include a "-" for example "feisty-beige":

    http://www.rexythebot.com:3000/name/feisty-beige


    API Query - Geocode (Location)

    To execute an API call for a specific location, say to find all hotspots in "berlin" use the following:

    http://www.rexythebot.com:3000/geocode/berlin

    If the geocode includes a space, no problem:

    http://www.rexythebot.com:3000/geocode/san francisco


    API Query - Duplicates

    To run a query and find all DUPLICATE names i.e 2 or more, execute the API call with the following:

    http://www.rexythebot.com:3000/duplicates


    API Query - Owners with Multiple Hotspots

    To run a query and find owners with more than 1 hotspot (descending order), execute the API call with the following:

    http://www.rexythebot.com:3000/omh


    API Query - Owner

    To return details for a specific owner, say for the owner "13qSBpq4SttoMkMtFLgJUt5MtYijAjsT1HYPE7yCJUswyyue9aG" use the following:

    http://www.rexythebot.com:3000/owner/13qSBpq4SttoMkMtFLgJUt5MtYijAjsT1HYPE7yCJUswyyue9aG



    API Queries - Address

    We can also run address queries and return hotspot and financial data.

    To run a hotspot query from an address, for example "11vG2tfcFjSg3pJvZgNTQWYKtVfoH8BeYfi6ygmXGeDuCRCzuT4", execute the following API call:

    http://www.rexythebot.com:3000/address-details/11vG2tfcFjSg3pJvZgNTQWYKtVfoH8BeYfi6ygmXGeDuCRCzuT4


    Similarly, to run a financial query on an address, for instance "1335kMcTiC4A39XxvhyUS3aJHbX1jn1YgJMPuFJ6Hfr1qVakw7i", execute the API call:

    http://www.rexythebot.com:3000/address-financials/1335kMcTiC4A39XxvhyUS3aJHbX1jn1YgJMPuFJ6Hfr1qVakw7i