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.

Query Parameters

paramTypeNote
cursor (optional)stringCursor for the page to fetch

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

Hotspot Activity

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

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

Hotspots Activity Counts

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

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

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

Query Parameters

paramTypeNote
filter_typesstringComma separated list of transasction 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

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 a challenger, challengee or a 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

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.

Path Parameters

paramTypeNote
address (required)stringB58 address of the hotspot

Query Parameters

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

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 (required)stringLast timestamp to include rewards for
min_time (required)stringFirst timestamp to include rewards for

Witnesses for a Hotspot

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

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

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