helium_py.api.dc_burns.DCBurns

class helium_py.api.dc_burns.DCBurns(host=None, port=None, user_agent=None, base_path=None)

Bases: API

DC Burns client class for Helium Blockchain API.

https://docs.helium.com/api/blockchain/dc-burns

__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.
all()	Yield all data credits burn events.
get_stats()	Return current statistics for Data Credits burned.
get_total(params)	Return total data credits burned for given params.

Attributes

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

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

Yield all data credits burn events.

property client: Client

Return a client singleton per API.

get_stats() → dict

Return current statistics for Data Credits burned.

get_total(params: Optional[dict]) → dict

Return total data credits burned for given params.