Skip to main content

Hotspots


List Hotspots

GET https://api.helium.io/v1/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.

The filter_modes parameter can be used to filter hotspot by how they were added to the blockchain. Supported values are full, dataonly, or light. A comma separated list (no whitespace) can be used to filter for multiple modes.

Query Parameters

paramTypeNote
cursor (optional)stringCursor for the page to fetch
filter_modes (optional)stringFilter hotspot types

Hotspot for Address

GET https://api.helium.io/v1/hotspots/:address

Fetch a hotspot with a given address.

Path Parameters

paramTypeNote
address (optional)stringAddress of hotspot to fetch

Hotspots for Name

GET https://api.helium.io/v1/hotspots/name/: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

paramTypeNote
namestringName of hotspot(s) to fetch

GET https://api.helium.io/v1/hotspots/name?search=<term>

Fetch the hotspots which match a search term in the given search term query parameter. The search parameter needs to be at least one character, with 3 or more recommended.

Query Parameters

paramTypeNote
searchstringThe name fragment to search for

GET https://api.helium.io/v1/hotspots/location/distance

Fetch the hotspots which are within a given number of meters from the given lat and lon coordinates. This route is paged using a cursor.

Query Parameters

paramTypeNote
latfloatLatitude of the location to search around
lonfloatLongitude of the location to search around
distanceintegerDistance (in meters) from location to search within
GET https://api.helium.io/v1/hotspots/location/box

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

Query Parameters

paramTypeNote
swlatfloatLatitude of the south-west corner
swlonfloatLongitude of the south-west corner
nelatfloatLatitude of the north-east corner
nelonfloatLongitude of the north-east corner

Hotspots for H3 Index

GET https://api.helium.io/v1/hotspots/hex/:h3_index

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

Path Parameters

paramTypeNote
h3_indexstringThe h3 index to fetch hotspots for

Hotspot Activity

GET https://api.helium.io/v1/hotspots/:address/activity
caution

The /activity route will be deprecated on May 1, 2022 and will be replaced by /roles, described below

Lists all blockchain transactions that the given Hotspot was involved in. This route is paged using a cursor.

Path Parameters

paramTypeNote
address (optional)stringB58 address of the hotspot

Query Parameters

paramTypeNote
cursor (optional)stringCursor for page of results to fetch
filter_types (optional)stringComma separated list of transaction types
min_time (optional)stringFirst time to include data for
max_time (optional)stringLast time to include data for
limit (optional)numberMaximum number of items to return

Hotspot Roles

GET https://api.helium.io/v1/hotspots/:address/roles

Lists all blockchain transactions that the given Hotspot was involved in. This route is paged using a cursor.

Path Parameters

paramTypeNote
address (optional)stringB58 address of the hotspot

Query Parameters

paramTypeNote
cursor (optional)stringCursor for page of results to fetch
filter_types (optional)stringComma separated list of transaction types
min_time (optional)stringFirst time to include data for
max_time (optional)stringLast time to include data for
limit (optional)numberMaximum number of items to return

Hotspots Roles Counts

GET https://api.helium.io/v1/hotspots/:address/roles/count

Count transactions that indicate a Hotspot as a participant.

The results are a map keyed by the given filter_types and the count of transaction of that type.

Path Parameters

paramTypeNote
address (required)stringHotspot B58 address to fetch counts for

Query Parameters

paramTypeNote
filter_typesstringComma separated list of transaction types

Hotspot Elections

GET https://api.helium.io/v1/hotspots/:address/elections

Lists the consensus group transactions that the given hotspot was involved in. This route is paged using a cursor.

Path Parameters

paramTypeNote
address (required)numberB58 address of the hotspot to look up

Query Parameters

paramTypeNote
cursor (optional)stringCursor for the page to fetch
min_time (optional)stringFirst time to include data for
max_time (optional)stringLast time to include data for
limit (optional)numberMaximum number of items to return

Currently Elected Hotspots

GET https://api.helium.io/v1/hotspots/elected

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

No Parameters


Hotspot Challenges

GET https://api.helium.io/v1/hotspots/:address/challenges

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

Path Parameters

paramTypeNote
address (optional)stringB58 address of the hotspot to look up

Query Parameters

paramTypeNote
cursor (optional)stringCursor for the page to fetch
min_time (optional)stringFirst time to include data for
max_time (optional)stringLast time to include data for
limit (optional)numberMaximum number of items to return

Rewards for a Hotspot

GET https://api.helium.io/v1/hotspots/:address/rewards

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.

The result will be a list of rewards between min_time and max_time both given in UTC. Both default to "now" which means that at least one of the two parameters is required.

The result includes a type field which is the type of activity that generated the reward.

This route is paged using a cursor.

info

For older reward results, if the type is null the amount is a total for that hotspot in the given block.

Path Parameters

paramTypeNote
address (required)stringB58 address of the hotspot

Query Parameters

paramTypeNote
cursor (optional)stringCursor for page of rewards to fetch
max_time (optional)stringLast timestamp to include rewards for
min_time (required)stringFirst timestamp to include rewards for

Rewards in a Rewards Block for a Hotspot

GET https://api.helium.io/v1/hotspots/:address/rewards/:block

Returns rewards for a given hotspot for a given block.

The result includes a type field which is the type of activity that generated the reward.

This route is paged using a cursor.

info

For older reward results, if the type is null the amount is a total for that hotspot in the given block.

Path Parameters

paramTypeNote
address (required)stringB58 address of the hotspot

Reward Total for a Hotspot

GET https://api.helium.io/v1/hotspots/:address/rewards/sum

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

paramTypeNote
address (required)stringB58 address of the hotspot

Query Parameters

paramTypeNote
max_time (optional)stringLast timestamp to include rewards for
min_time (required)stringFirst timestamp to include rewards for
bucket (optional)stringGet data in buckets ( hour / month / week )

Witnesses for a Hotspot

GET https://api.helium.io/v1/hotspots/:address/witnesses

Retrieves the list of witnesses for a given hotspot over about the last 5 days of blocks.

Path Parameters

paramTypeNote
address (required)stringB58 address for a hotspot to look up

Witnessed for a Hotspot

GET https://api.helium.io/v1/hotspots/:address/witnessed

Retrieves the list of hotspots the given hotspot witnessed over the last 5 days.

Path Parameters

paramTypeNote
address (required)stringB58 address for a hotspot to look up