HeliumGeek API Documentation

website·Indexed 31 days ago

https://docs.heliumgeek.com

Technical documentation and API reference for the Helium Network, including guides and endpoints for querying solaccounts, gateways, and mobile rewards.

Tokens: 2.2K
Snippets: 47
Records: 56
Agent score: 0%

What's inside HeliumGeek

Monitor HeliumGeek API plan usage
HeliumGeek tracks the number of distinct gateways an API client accesses during a monthly billing cycle. Usage telemetry is included in every gateway- and radio-related response to help users avoid hitting enforcement limits.
https://docs.heliumgeek.com/meta/index.jsonwebsitellms
Filter historical data using time-series windows
Endpoints exposing historical data support min_time and max_time query parameters to define the observation window for the requested data.
https://docs.heliumgeek.com/meta/index.jsonwebsitellms
Handle cursor-based pagination in HeliumGeek API
HeliumGeek endpoints that return collections use cursor-based pagination. Each response contains the current set of items and a pointer (cursor) to be used for fetching the subsequent page of results.
https://docs.heliumgeek.com/meta/index.jsonwebsitellms
Get started with the HeliumGeek API
The HeliumGeek API provides fleet-management and analytics for the Helium network. All REST endpoints are hosted at https://api.heliumgeek.com and use the /v0 prefix (e.g., /v0/gateways). Requests are scoped per account and require an API key passed via the x-api-key header.
https://docs.heliumgeek.com/meta/index.jsonwebsitellms
List active radios for a gateway
Returns the active radios currently associated with a gateway identified by its address.
```
GET /gateways/{address}/radios
```
https://docs.heliumgeek.com/api/reference/radios-for-the-gatewaywebsitellms
Get network gateway counts per epoch
Returns the total number of gateways captured at the end of each reward epoch.
```
GET /network/stats/gateways
```
https://docs.heliumgeek.com/meta/index.jsonwebsitellms
Retrieve network radio counts
Returns the total number of radios captured at the end of each reward epoch.
```
GET /network/stats/radios
```
https://docs.heliumgeek.com/api/reference/network-radio-countswebsitellms
Retrieve last-epoch mobile usage details
The GET /v0/gateways/{address} endpoint includes a recent.epoch.usageDetails block for API clients with Mobile scope. This snapshot allows developers to separate default usage traffic from unrewarded demand-sampling traffic (found in the sampled bucket).
https://docs.heliumgeek.com/meta/index.jsonwebsitellms
Get mobile network data volumes
Retrieve mobile network data transfer volumes organized per reward epoch.
```
GET /network/stats/data/mobile
```
https://docs.heliumgeek.com/api/reference/mobile-network-data-volumeswebsitellms
Authenticate HeliumGeek API requests
Most HeliumGeek endpoints require an API key to identify the tenant and enforce the associated usage plan. This key must be provided in the x-api-key header of the request.
https://docs.heliumgeek.com/meta/index.jsonwebsitellms
Get IoT reward sums for all gateways in a wallet
Retrieve a paginated history of IoT reward sums for all gateways associated with a specific wallet address.
```
GET /solaccounts/{address}/gateways/iot/rewards/sum
```
https://docs.heliumgeek.com/api/reference/io-t-reward-sums-of-all-gateways-of-the-walletwebsitellms
Get aggregated mobile speedtest averages for a gateway
Retrieve the aggregated mobile speedtest average data for a specific gateway address.
```
GET /gateways/{address}/mobile/speedtests/averages
```
https://docs.heliumgeek.com/meta/index.jsonwebsitellms