Accounts


List Accounts

GET https://api.helium.io/v1/accounts

Retrieve the current set of known accounts.The result is paged. A cursor field is present if more results are available.

Note: The cursor for accounts is valid for a limited time. If you receive a 400 http response code for a cursor based request, you will need to start fetching accounts from the beginning of the list.

Query Parameters

paramTypeNote
cursor (optional)stringCursor for the page of accounts to fetch

List Richest Accounts

GET https://api.helium.io/v1/accounts/rich

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

Query Parameters

paramTypeNote
limit (optional)stringNumber of accounts to return. Default 1000, max 1000

Account for Address

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

For example, when constructing a payment transaction, get the speculative_nonce field for the source account and use speculative_nonce + 1 for the new transaction nonce.Currently only the speculative_nonce is supported. It indicates the expected nonce for the account

Path Parameters

paramTypeNote
address (required)stringAccount B58 address to fetch details for

Hotspots for Account

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

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.

Note: The cursor for accounts is valid for a limited time. If you receive a 400 http response code for a cursor based request, you will need to start fetching accounts from the beginning of the list.

Path Parameters

paramTypeNote
address (required)stringAccount B58 address to fetch details for

Query Parameters

paramTypeNote
cursor (optional)stringCursor for the next page of hotspots to fetch

OUIs for Account

GET https://api.helium.io/v1/accounts/:address/ouis

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

paramTypeNote
address (required)stringAccount B58 address to fetch details for

Query Parameters

paramTypeNote
cursor (optional)stringCursor for the next page of OUIs to fetch

Activity for Account

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

Fetches 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 paged. If a cursor field is present in the response, more results are available.

Path Parameters

paramTypeNote
address (required)stringAccount B58 address to fetch activity for

Activity Counts for Account

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

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 Parameters

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

Query Parameters

paramTypeNote
filter_typesstringComma separated list of transasction types

Elections for Account

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

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

The results are paged. If a cursor field is present in the response, more results are available.

Path Parameters

paramTypeNote
address (required)stringAccount B58 address to fetch activity for

Challenges for Account

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

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

The results are paged. If a cursor field is present in the response, more results are available.

Path Parameters

paramTypeNote
address (required)stringAccount B58 address to fetch activity for

Pending Transactions for Account

GET https://api.helium.io/v1/accounts/:address/pending_transactions

Fetches the outstanding transactions for the given account. See Pending Transactions for details.The list of returned pending transactions is paged. If a cursor field is present more results are available.

Path Parameters

paramTypeNote
address (required)stringAccount B58 address to fetch details for

Query Parameters

paramTypeNote
cursor (optional)stringCursor for the next page of transactions to fetch

Rewards for an Account

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

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

paramTypeNote
address (required)stringAccount B58 address to fetch details for

Query Parameters

paramTypeNote
cursor (optional)stringCursor for the next page of transactions to fetch

Reward Totals for an Account

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

Returns the total rewards for a given account in a given timeframe. Timestamps can be given in ISO 8601 format (e.g. 2020-08-27T00:00:00Z) or in relative time (e.g. -1 week, which when url esacped becomes -1%20week). When ommitted the current time is assumed.

The results can also 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).

For example to get the last 7 days of rewards bucketed by day use the following path/parameters: ?min_time=-7%20day&bucket=day

The block that contains the max_time timestamp is excluded from the result.

Path Parameters

paramTypeNote
address (required)stringAccount B58 address to fetch details for

Query Parameters

paramTypeNote
min_time (required)stringFirst time to include rewards for
max_time (required)stringLast time to include rewards for
bucket (optional)stringBucket specifier

Stats for Account

GET https://api.helium.io/v1/accounts/:address/stats

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

paramTypeNote
address (required)stringAccount B58 address to fetch stats for