helium_py.api.accounts.Accounts

class helium_py.api.accounts.Accounts(host=None, port=None, user_agent=None, base_path=None)

Bases: API

Accounts client class for Helium Blockchain API.

https://docs.helium.com/api/blockchain/accounts

__init__(host=None, port=None, user_agent=None, base_path=None)

Allow for overriding API details at instantiation.

Methods

__init__([host, port, user_agent, base_path])	Allow for overriding API details at instantiation.
account_for_address(address)	Return account for a given address.
all()	Yield all accounts.
challenges_for_account(address, params)	Yield all challenges for given account address.
get_account_elections(address, params)	Return account elections for given account address.
get_account_rewards(address, params)	Yield all account rewards for given account address.
get_account_rewards_total(address, params)	Return account rewards totals for given account address.
get_roles(address, params)	Yield all roles for given account address.
get_roles_counts(address, params)	Return account roles for given account address.
get_stats_for_account(address)	Return stats for given account address.
hotspots_for_account(address, params)	Yield all hotspots for given account address.
ouis_for_account(address)	Yield all OUIs for given account address.
pending_transactions_for_account(address)	Yield all pending transactions for given account address.
richest(params)	Return list of richest acounts.
validators_for_account(address)	Yield all validators for given account address.

Attributes

base_path
client	Return a client singleton per API.
host
port
user_agent

account_for_address(address: str) → dict

Return account for a given address.

all() → Generator[dict, None, None]

Yield all accounts.

challenges_for_account(address: str, params: Optional[dict]) → Generator[dict, None, None]

Yield all challenges for given account address.

property client: Client

Return a client singleton per API.

get_account_elections(address: str, params: Optional[dict]) → List[dict]

Return account elections for given account address.

get_account_rewards(address: str, params: Optional[dict]) → Generator[dict, None, None]

Yield all account rewards for given account address.

get_account_rewards_total(address: str, params: Optional[dict]) → dict

Return account rewards totals for given account address.

get_roles(address: str, params: Optional[dict]) → Generator[dict, None, None]

Yield all roles for given account address.

get_roles_counts(address: str, params: Optional[dict]) → dict

Return account roles for given account address.

get_stats_for_account(address: str) → dict

Return stats for given account address.

hotspots_for_account(address: str, params: Optional[dict]) → Generator[dict, None, None]

Yield all hotspots for given account address.

ouis_for_account(address: str) → Generator[dict, None, None]

Yield all OUIs for given account address.

pending_transactions_for_account(address: str) → Generator[dict, None, None]

Yield all pending transactions for given account address.

richest(params: Optional[dict]) → List[dict]

Return list of richest acounts.

validators_for_account(address: str) → Generator[dict, None, None]

Yield all validators for given account address.