202min

Helium Blockchain API

Useful links

Introduction

Helium is a decentralized, open wireless network built on a new blockchain for the physical world. It relies on a novel type of work called Proof of Coverage, and a new consensus algorithm. The Helium Network is used to route data for long-range, lower power IoT devices that use Helium's LongFi protocol.

This plugin will allow you to easily interact with the Helium network to build applications & services for the Helium ecosystem.

How To Setup

There is no authentication required for interacting with Helium's & The API is not rate limited.

Every endpoint has both action and get data call. Below is an example of how to use the endpoints in either scenario.

Data Call

A simple example of using this plugin's data-calls is with a Bubble text element. Draw a text element to your page, focus the editable input & click dynamic data.

Document image

Select the option 'Get data from an external API'

Document image

Here you can choose any of the plugin's API calls to use

Document image

In this example we have selected 'List Richest Accounts'. This will return a custom datatype not readable in text format so we must complete the expression by calling a field.

Document image

Balances or anything referring to HNT (Heliums native token is in $USD) and can be divided by 100000000 for easier reading.

Document image



You will notice when clicking the expression a panel on the left will appear showing some inputs to control the returned data, some these are required while others are optional.

Bubble's editor doesn't prompt you that it must be filled in so refer to the respective documentation. In our example, the 'Version' path parameter is required but the 'limit' query parameter is not.

Document image

You can easily find the documentation for every call in the plugins tab, see the image below.

Document image

Action Call

To use action calls in your workflows either use the search input or click the plugins tab to find the list.​

Document image

Then in your subsequent action, you can use the output data from this action with the 'Result of Step n' operator.

Document image

Stats

Blockchain Stats

Retrieve basic stats for the blockchain such as total token supply, and average block and election times over a number of intervals.

Response

JS
|

Token Supply

Returns the circulating token supply.

Response

JS
|

Blocks

Block Height

Gets the current height of the blockchain.What Is Block Height? - https://www.investopedia.com/terms/b/block-height.asp

Query Parameters

Name

Tags

Description

Example

Type

max_height

optional

Last time to include in height search.

2021-01-01

ISO8601 timestamp

Response

JS
|



Block Stats

Get statistics on block production times.

JS
|

Block Descriptions

Retrieves block descriptions. Blocks descriptions are paged. A cursor field will be in the response when more results are available.

Query Parameters

Name

Tags

Description

Example

Type

height

optional

Cursor for the page to fetch.

eyJiZWZvcmUiOjQzNTIwMX0

text

Response

JS
|

Block at Height

Get block descriptor for the block at height

Query Parameters

Name

Tags

Description

Example

Type

height

required

Blockchain Height.

644081

number

Response

JS
|

Block at Height Transactions

Get transactions for a block at a given height. The list of returned transactions is paged. A cursor field is present if more results are available.

Query Parameters

Name

Tags

Description

Example

Type

height

required

Blockchain Height.

644081

number

cursor

optional

Cursor for page to fetch.

eyJiZWZvcmUiOjQzNTIwMX0

text

Response

JS
|

Block at Hash

Get block descriptor for the given block hash.

Query Parameter

Name

Tags

Description

Example

Type

hash

required

Block hash for the block to fetch.

o5o8cBL1Zvp1KmA1d8vYJ38wXXWVxf1HW2e1uZxVJYg

text

Response

JS
|

Block at Hash Transactions

Get transactions for a block at a given block hash. The list of returned transactions is paged. A cursor field is present if more results are available.

Query Parameters

Name

Tags

Description

Example

Type

hash

required

Block hash for the block to fetch.

o5o8cBL1Zvp1KmA1d8vYJ38wXXWVxf1HW2e1uZxVJYg

text

cursor

optional

Cursor for page to fetch.

eyJiZWZvcmUiOjQzNTIwMX0

text

Response

JS
|

List Accounts

Retrieve basic stats for the blockchain such as total token supply, and average block and election times over a number of intervals.

Query Parameters

Name

Tags

Description

Example

Type

cursor

optional

Cursor for page to fetch. Note: The cursor for accounts is valid for a limited time.

eyJoZWlnaHQiOjQzNTIzOSwiYmVmb3JlX2Jsb2NrIjo0MTM3MDIsImJlZm9yZV9hZGRyZXNzIjoiMTRpdndTNnRBQXVzRFo0QXVucTZXZ2dUc285cEZFbXZ2eXM5S1NXYUJDRENMd1UyMURkIn0

text

Response



JS
|

List Richest Accounts

Returns up to 100 of the accounts sorted by highest token balance.

Query Parameters

Name

Tags

Description

Example

Type

limit

optional

counts to return. Default 100, max 100.

10

number

Response

JS
|

Account for Address

Retrieve a specific account record. The account details for a record include additional speculative nonces that indicate what the expected nonce for the account is for a specific balance. Any transactions affecting the given balance type should use an adjusted speculative nonce for that balance type.

Path Parameters

Name

Tags

Description

Example

Type

address

required

Account B58 address to fetch details for

14GWyFj9FjLHzoN3aX7Tq7PL6fEg4dfWPY8CrK8b9S5ZrcKDz6S

text

Response

JS
|

Hotspots for Account

Fetches hotspots owned by a given account address.The list of returned hotspots is paged. If a cursor field is present more results are available.

Path Parameters

Name

Tags

Description

Example

Type

address

required

Account B58 address to fetch details for

14GWyFj9FjLHzoN3aX7Tq7PL6fEg4dfWPY8CrK8b9S5ZrcKDz6S

text

Query Parameters

Name

Tags

Description

Example

Type

cursor

optional

Cursor for the next page of hotspots to fetch.

eyJiZWZvcmUiOjQzNTIwMX0

text

Response

JS
|

OUIs for Account

Fetches OUIs owned by a given account address.The list of returned OUIs is paged. If a cursor field is present more results are available.

Path Parameters

Name

Tags

Description

Example

Type

address

required

Account B58 address to fetch details for

13tyMLKRFYURNBQqLSqNJg9k41maP1A7Bh8QYxR13oWv7EnFooc

text

Query Parameters

Name

Tags

Description

Example

Type

cursor

optional

Cursor for the next page of OUIs to fetch.

eyJiZWZvcmUiOjQzNTIwMX0

text

Response

JS
|

Activity for Account

Fetches transactions that indicate activity for an account. This includes any transaction that involves the account, usually as a payer, payee or owner.

Path Parameters

Name

Tags

Description

Example

Type

address

required

Account B58 address to fetch details for

13GCcF7oGb6waFBzYDMmydmXx4vNDUZGX4LE3QUh8eSBG53s5bx

text

Query Parameters

Name

Tags

Description

Example

Type

cursor

optional

Cursor for the next page of activity to fetch.

eyJtaW5fYmxvY2siOjk2MDg3LCJibG9jayI6ODU4NzAwLCJhbmNob3JfYmxvY2siOjg1ODcwMH0

text

Response

JS
|

Activity Counts for Account

Fetches transactions that indicate activity for an account. This includes any transaction that involves the account, usually as a payer, payee or owner.Count transactions that indicate activity for an account. This includes any transaction that involves the account, usually as a payer, payee or owner.The results are a map keyed by the given filter_types and the count of transaction of that type.

Path ParameterNs

Name

Tags

Description

Example

Type

address

required

Account B58 address to fetch activity counts for.

13GCcF7oGb6waFBzYDMmydmXx4vNDUZGX4LE3QUh8eSBG53s5bx

text

Transaction Types

Append the version on the transaction type name, eg: payment_v1

  • add gateway - Add a new gateway to the Helium Network. For the purposes of transactions, a “gateway” is the term for a Helium-compliant Miner that is mining and providing coverage.
  • assert location - Assert a gateway’s location on the Helium Network. This happens after a gateway has been added via the add gateway transaction. Once asserted, this location is then used as part of Proof of Coverage challenges. A Miner’s location can be asserted more than once but each subsequent assertion will a) cost a fee and b) reset that Miner’s score to neutral (.15)
  • chain vars - Change a chain variable.
  • coinbase - Similar to the bitcoin blockchain’s coinbase transaction but used only during testnet phases of the Helium blockchain. The rewards transaction has taken its place.
  • coinbase data credits - Created the initial 10,000 Data Credits required to bring the first group of Miners online.
  • consensus group - Marks the election of a new consensus group, responsible for mining during the next epoch.
  • create hashed timelock - Creates a transaction that can only be redeemed by providing the correct pre-image to the hashlock within the specified timelock.
  • create proof of coverage request - Submitted by a Miner wishing to initiate a challenge.
  • data credits - Burn HNT for DCs at the current oracle price and deliver them to the target wallet address.
  • genesis gateway - Used to define the initial group of Miners that bootstrapped the blockchain.
  • multi-payment - Used to send $HNT from one wallet to multiple wallets.
  • OUI - Create a OUI for a new router on the Helium network. In the Helium blockchain, Miners forward packets to Routers that own them based on their OUI as stored in the blockchain.
  • payment - Used to send $HNT from one wallet to another.
  • proof of coverage receipts - The result of a POC submitted to the network upon completion.
  • redeem hashed timelock - Redeem the transaction created using the create hashed timelock transaction.
  • reward - A token payout for a specific event on the network such as submitting a valid proof of coverage request, participating in a consensus group, etc.
  • rewards - Bundles multiple reward transactions at the end of each epoch and distributes all $HNT produced in that block to wallets that have earned them.
  • routing - Update the routing information associated with an OUI.
  • security coinbase - Distribution of security tokens in the genesis block.
  • security exchange - The transfer of security tokens from one address to another.
  • state channel open - Opens a new state channel on a Helium Router
  • state channel close - Closes a specific state channel on a Helium Router
  • token burn exchange rate - Change the exchange rate for burning $HNT to DCs.

Query Parameters

Name

Tags

Description

Example

Type

optional

Comma separated list of transaction types.

rewards_v1 ,

payment_v1

array enum

Response

JS
|

Elections for Account

Fetches elections that hotspots for the given account are elected in.​

Path Parameters

Name

Tags

Description

Example

Type

address

required

Account B58 address to fetch elections for

14GWyFj9FjLHzoN3aX7Tq7PL6fEg4dfWPY8CrK8b9S5ZrcKDz6S

text

Query Parameters

Name

Tags

Description

Example

Type

cursor

optional

Cursor for the next page of elections to fetch.

eyJtaW5fYmxvY2siOjk2MDg3LCJibG9jayI6ODU4NzAwLCJhbmNob3JfYmxvY2siOjg1ODcwMH0

text

Response

JS
|

Challenges for Account

Fetches challenges that hotspots owned by the given account are involved in as a challenger, challengee, or witness.

Path Parameters

Name

Tags

Description

Example

Type

address

required

Account B58 address to fetch challenges for

14GWyFj9FjLHzoN3aX7Tq7PL6fEg4dfWPY8CrK8b9S5ZrcKDz6S

text

Query Parameters

Name

Tags

Description

Example

Type

cursor

optional

Cursor for the next page of challenges to fetch.

eyJtaW5fYmxvY2siOjk2MDg3LCJibG9jayI6ODU4NzAwLCJhbmNob3JfYmxvY2siOjg1ODcwMH0

text

Response

JS
|

Pending Transactions for Account

Fetches the outstanding transactions for the given account.

Path Parameters

Name

Tags

Description

Example

Type

address

required

Account B58 address to fetch pending transactions for

14GWyFj9FjLHzoN3aX7Tq7PL6fEg4dfWPY8CrK8b9S5ZrcKDz6S

text

Query Parameters

Name

Tags

Description

Example

Type

cursor

optional

Cursor for the next page of challenges to fetch.

eyJtaW5fYmxvY2siOjk2MDg3LCJibG9jayI6ODU4NzAwLCJhbmNob3JfYmxvY2siOjg1ODcwMH0

text

Response

JS
|

Rewards for an Account

Returns reward entries by block and gateway for a given account in a timeframe. Timestamps are given in ISO 8601 format. The block that contains the max_time timestamp is excluded from the result.

Path Parameters

Name

Tags

Description

Example

Type

address

required

Account B58 address to fetch pending transactions for

14GWyFj9FjLHzoN3aX7Tq7PL6fEg4dfWPY8CrK8b9S5ZrcKDz6S

text

The results can be bucketed in time by specifying a bucket query parameter which buckets information per bucket in the given timeframe. Data is bucketed per hotspot and time for the account to make hotspot performance comparison possible. Valid bucket values include hour, dayand week).

Query Parameters

Name

Tags

Description

Example

Type

cursor

optional

Cursor for the next page of pending transactions to fetch.

eyJtaW5fYmxvY2siOjk2MDg3LCJibG9jayI6ODU4NzAwLCJhbmNob3JfYmxvY2siOjg1ODcw

ISO8601 timestamp or relative time

Response

JS
|

Reward Totals for an Account

Returns reward entries by block and gateway for a given account in a timeframe. Timestamps are given in ISO 8601 format. The block that contains the max_time timestamp is excluded from the result.

Path Parameters

Name

Tags

Description

Example

Type

address

required

Account B58 address to fetch pending transactions for

14GWyFj9FjLHzoN3aX7Tq7PL6fEg4dfWPY8CrK8b9S5ZrcKDz6S

text

The results can be bucketed in time by specifying a bucket query parameter which buckets information per bucket in the given timeframe. Data is bucketed per hotspot and time for the account to make hotspot performance comparison possible. Valid bucket values include hour, day and week).

Query Parameters

Name

Tags

Description

Example

Type

min_time

required

First time to include rewards sum for.

2020-08-27T00:00:00Z

ISO8601 timestamp or relative time

max_time

required

Last time to include rewards for.

-1 week

ISO8601 timestamp or relative time

bucket

optional

Bucket specifier.

day

enum

Response

JS
|

Stats for Account

Fetches account statistics for a given account. This currently includes account balance information (in bones) for the last month (daily), last week (every 8 hours), and daily (hourly)

Path Parameters

Name

Tags

Description

Example

Type

address

required

Account B58 address to fetch pending transactions for

14GWyFj9FjLHzoN3aX7Tq7PL6fEg4dfWPY8CrK8b9S5ZrcKDz6S

text

Response

JS
|

List Hotspot Cities

List all known hotspot cities with the total hotspot count for each city.

Query Parameters

Name

Tags

Description

Example

Type

search

optional

Term to limit the list of cities with.

Saint

text

cursor

optional

Cursor for page to fetch.

eyJyYW5rIjoiQWx2YSIsImNpdHlfaWQiOiJhbHZhZmxvcmlkYXVuaXRlZCBzdGF0ZXMifQ

text

Response

JS
|

List Hotspots for a City

Lists all known hotspots for a given city_id.

Query Parameters

Name

Tags

Description

Example

Type

city_id

required

The id for the city are returned by the cities list.

c2FpbnRlLW1hcmllLWF1eC1jaMOqbmVzZ3JhbmQgZXN0ZnJhbmNl



cursor

optional

Cursor for page to fetch.

eyJyYW5rIjoiQWx2YSIsImNpdHlfaWQiOiJhbHZhZmxvcmlkYXVuaXRlZCBzdGF0ZXMifQ

text

Response

JS
|

List Hotspots

List known hotspots as registered on the blockchain.The results are paged. If a cursor field is present in the response, more results are available.

Query Parameters

Name

Tags

Description

Example

Type

cursor

optional

Cursor for page to fetch.

eyJoZWlnaHQiOjM5NzAyMywiYmVmb3JlX2Jsb2NrIjozNzcyNDAsImJlZm9yZV9hZGRyZXNzIjoiMTE3dWNvcmlqRldKNjYySEgxcTZhWXo3OFk1cTJGZkY5RE15eDRLYTczdkJxc0V1dU1HIn0

text

Response

JS
|

Hotspot for Address

List known hotspots as registered on the blockchain.The results are paged. If a cursor field is present in the response, more results are available.

Path Parameters

Name

Tags

Description

Example

Type

address

required

Address of hotspot to fetch

11cxkqa2PjpJ9YgY9qK3Njn4uSFu6dyK9xV8XE4ahFSqN1YN2db

text

Response

JS
|

Hotspot for Name

Fetch the hotspots which map to the given 3-word animal name. The name must be all lower-case with dashes between the words, e.g. tall-plum-griffin. Because of collisions in the Angry Purple Tiger algorithm, the given name might map to more than one hotspot.

Path Parameters

Name

Tags

Description

Example

Type

name

required

Name of hotspot(s) to fetch

tall-plum-griffin

text

Response

JS
|

Hotspot Location Distance Search

Fetch the hotspots which are within a given number of meters from the given lat and lon coordinates.

Query Parameters

Name

Tags

Description

Example

Type

lat

required

Latitude of the location to search around.

37.784056617819544

float

lon

required

Longitude of the location to search around

-122.39186733984285

float

distance

required

Distance (in meters) from location to search within

200

number

cursor

optional

Cursor for page to fetch

eyJoZWlnaHQiOjM5NzAyMywiYmVmb3JlX2Jsb2NrIjozNzcyNDAsImJlZm9yZV9hZGRyZXNzIjoiMTE3dWNvcmlqRldKNjYySEgxcTZhWXo3OFk1cTJGZkY5RE15eDRLYTczdkJxc0V1dU1HIn0

text

Response

JS
|

Hotspot Location Box Search

Fetch the hotspots which are within a given geographic boundary indicated by it's south-wesetern and north-eastern co-ordinates.

Query Parameters

Name

Tags

Description

Example

Type

swlat

required

Latitude of the south-west corner

38.0795392

float

swlon

required

Longitude of the south-west corner.

-122.5671627

float

nelat

required

Latitude of the north-east corner

38.1588012

float

nelon

required

Longitude of the north-east corner

-122.5046937

float

cursor

optional

Cursor for page to fetch

eyJoZWlnaHQiOjM5NzAyMywiYmVmb3JlX2Jsb2NrIjozNzcyNDAsImJlZm9yZV9hZGRyZXNzIjoiMTE3dWNvcmlqRldKNjYySEgxcTZhWXo3OFk1cTJGZkY5RE15eDRLYTczdkJxc0V1dU1HIn

text

Response

JS
|

Hotspots for H3 Index

Fetch the hotspots which are in the given h3 index. The supported h3 indices are currently limited to resolution 8.

Path Parameters

Name

Tags

Description

Example

Type

h3_index

required

The h3 index to fetch hotspots for

882aa38c2bfffff

text

Response

JS
|

Hotspot Activity

Lists all blockchain transactions that the given hotspot was involved in.

Path Parameters

Name

Tags

Description

Example

Type

address

required

B58 address of the hotspot.

11cxkqa2PjpJ9YgY9qK3Njn4uSFu6dyK9xV8XE4ahFSqN1YN2db

text

Query Parameters

Name

Tags

Description

Example

Type

cursor

optional

Cursor for page of results to fetch.

eyJoZWlnaHQiOjM5NzAyMywiYmVmb3JlX2Jsb2NrIjozNzcyNDAsImJlZm9yZV9hZGRyZXNzIjoiMTE3dWNvcmlqRldKNjYySEgxcTZhWXo3OFk1cTJGZkY5RE15eDRLYTczdkJxc0V1dU1HIn0

text

Response

JS
|

Hotspots Activity Counts

Count transactions that indicate activity for a hotspot.The results are a map keyed by the given filter_types and the count of transaction of that type.

Path Parameters



Name

Tags

Description

Example

Type

address

required

Account B58 address to fetch activity counts fo

11yTLDH2QbVLyRnBykzdLLP2j2DoAzjSp3obNrnxhUXpVdaYCZF

text

Transaction Types

Append the version on the transaction type name, eg: payment_v1

  • add gateway - Add a new gateway to the Helium Network. For the purposes of transactions, a “gateway” is the term for a Helium-compliant Miner that is mining and providing coverage.
  • assert location - Assert a gateway’s location on the Helium Network. This happens after a gateway has been added via the add gateway transaction. Once asserted, this location is then used as part of Proof of Coverage challenges. A Miner’s location can be asserted more than once but each subsequent assertion will a) cost a fee and b) reset that Miner’s score to neutral (.15)
  • chain vars - Change a chain variable.
  • coinbase - Similar to the bitcoin blockchain’s coinbase transaction but used only during testnet phases of the Helium blockchain. The rewards transaction has taken its place.
  • coinbase data credits - Created the initial 10,000 Data Credits required to bring the first group of Miners online.
  • consensus group - Marks the election of a new consensus group, responsible for mining during the next epoch.
  • create hashed timelock - Creates a transaction that can only be redeemed by providing the correct pre-image to the hashlock within the specified timelock.
  • create proof of coverage request - Submitted by a Miner wishing to initiate a challenge.
  • data credits - Burn HNT for DCs at the current oracle price and deliver them to the target wallet address.
  • genesis gateway - Used to define the initial group of Miners that bootstrapped the blockchain.
  • multi-payment - Used to send $HNT from one wallet to multiple wallets.
  • OUI - Create a OUI for a new router on the Helium network. In the Helium blockchain, Miners forward packets to Routers that own them based on their OUI as stored in the blockchain.
  • payment - Used to send $HNT from one wallet to another.
  • proof of coverage receipts - The result of a POC submitted to the network upon completion.
  • redeem hashed timelock - Redeem the transaction created using the create hashed timelock transaction.
  • reward - A token payout for a specific event on the network such as submitting a valid proof of coverage request, participating in a consensus group, etc.
  • rewards - Bundles multiple reward transactions at the end of each epoch and distributes all $HNT produced in that block to wallets that have earned them.
  • routing - Update the routing information associated with an OUI.
  • security coinbase - Distribution of security tokens in the genesis block.
  • security exchange - The transfer of security tokens from one address to another.
  • state channel open - Opens a new state channel on a Helium Router
  • state channel close - Closes a specific state channel on a Helium Router
  • token burn exchange rate - Change the exchange rate for burning $HNT to DCs.

Query Parameters

Name

Tags

Description

Example

Type

optional

Comma separated list of transaction types.

rewards_v1 , payment_v1array

enum

Response

JS
|

Hotspot Elections

Lists all blockchain transactions that the given hotspot was involved in.​https://docs.helium.com/blockchain/consensus-protocol/

Path Parameters

Name

Tags

Description

Example

Type

address

required

B58 address of the hotspot to look up.

11ztQpmCJbfPxv3RjsnvFTozbikpZ72dgmHTYwBQ2n2rABytnLE

text

Query Parameters

Name

Tags

Description

Example

Type

cursor

optional

Cursor for page of results to fetch.

eyJoZWlnaHQiOjM5NzAyMywiYmVmb3JlX2Jsb2NrIjozNzcyNDAsImJlZm9yZV9hZGRyZXNzIjoiMTE3dWNvcmlqRldKNjYySEgxcTZhWXo3OFk1cTJGZkY5RE15eDRLYTczdkJxc0V1dU1HIn0

text

Response

JS
|

Currently Elected Hotspots

Returns the list of hotspots that are currently elected to the consensus group.

Response

JS
|

Hotspot Challenges

Lists the challenge (receipts) that the given hotspot a challenger, challengee or a witness in. This route is paged using a cursor.

Path Parameters

Name

Tags

Description

Example

Type

address

required

B58 address of the hotspot to look up.

11DvZivbwHVRx4PbQwAd5w2DQEAcfSCRVzsW7gjRKQ86nCEJxHJ

text

Query Parameters

Name

Tags

Description

Example

Type

cursor

optional

Cursor for page of results to fetch.

eyJ0eXBlcyI6InBvY19yZWNlaXB0c192MSIsImJsb2NrIjozOTcwMDAsImFuY2hvcl9ibG9jayI6Mzk3MDAwf

text

Response

JS
|

Rewards for a Hotspot

Returns rewards for a given hotspot per reward block the hotspot is in, for a given timeframe. Timestamps are given in ISO 8601 format. The block that contains the max_time timestamp is excluded from the result.

Path Parameters

Name

Tags

Description

Example

Type

address

required

B58 address of the hotspot to look up.

11DvZivbwHVRx4PbQwAd5w2DQEAcfSCRVzsW7gjRKQ86nCEJxHJ

text

Query Parameters

Name

Tags

Description

Example

Type

cursor

optional

Cursor for page of results to fetch.

eyJ0eXBlcyI6InBvY19yZWNlaXB0c192MSIsImJsb2NrIjozOTcwMDAsImFuY2hvcl9ibG9jayI6Mzk3MDAwf

text

max_time

required

Last timestamp to include rewards for

2020-08-27T00:00:00Z



min_time

required

First timestamp to include rewards for.

-1 week



Untitled









Response

JS
|

Reward Total for a Hotspot

Returns the total rewards earned for a given hotspot over a given time range. Timestamps are given in ISO 8601 format. The block that includes the max_time timestamp is excluded from the result.

Path Parameters

Name

Tags

Description

Example

Type

address

required

B58 address of the hotspot to look up.

11DvZivbwHVRx4PbQwAd5w2DQEAcfSCRVzsW7gjRKQ86nCEJxHJ

text

The results can be bucketed in time by specifying a bucket query parameter which buckets information per bucket in the given timeframe. Data is bucketed per hotspot and time for the account to make hotspot performance comparison possible. Valid bucket values include hour, day and week).

Query Parameters

Name

Tags

Description

Example

Type

min_time

required

First timestamp to include rewards f

-1 week

ISO8601 timestamp or relative time

max_time

required

Last timestamp to include rewards for.

2020-08-27T00:00:00

ISO8601 timestamp or relative time

Response

JS
|

Witnesses for a Hotspot

Retrieves the last known list of witnesses for a given hotspot. In addition to the hotspot result information, the result will also include a witness_for and a witness_info field which are the given hotspot address and bucket histogram information on witnessed signal strengths.

Path Parameters

Name

Tags

Description

Example

Type

address

required

B58 address of the hotspot to look up.

11DvZivbwHVRx4PbQwAd5w2DQEAcfSCRVzsW7gjRKQ86nCEJxHJ

text

Response

JS
|

Get Location

Get geographic information for a given location.

Path Parameters

Name

Tags

Description

Example

Type

location

required

h3 index.

8c28347213117ff

text

Response

JS
|

Current Oracle Price

The current Oracle Price in $USD and at which block it took effect. The last 7 digits are decimals, cent denominations.

Response

JS
|

Current and Historical Oracle Prices

The current and historical Oracle Prices and at which block they took effect. This route is paged using a cursor.

Query Parameters

Name

Tags

Description

Example

Type

cursor

optional

Returned from an initial query, allowing client to fetch more results.

eyJiZWZvcmUiOjQ2NjE5MH0

text

Response

JS
|



Oracle Price Stats

Gets statistics on Oracle prices.

Query Parameters

Name

Tags

Description

Example

Type

min_time

required

First time to include in stats

2020-08-27T00:00:00Z.

ISO8601 timestamp or relative time

max_time

required

Last time to include in stats.

-1 week

ISO8601 timestamp or relative time

Response

JS
|

Oracle Price at a Specific Block

Provides the oracle price at a specific block and at which block it initially took effect.

Path Parameters

Name

Tags

Description

Example

Type

block

required

The block to get the HNT Oracle Price at

471570