helium_py.api.locations.Locations

class helium_py.api.locations.Locations(host=None, port=None, user_agent=None, base_path=None)

Bases: API

Locations client class for Helium Blockchain API.

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

__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.
get_location(h3_index)	Return location details for a provided h3 hex index.

Attributes

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

property client: Client

Return a client singleton per API.

get_location(h3_index: str) → dict

Return location details for a provided h3 hex index.

Args:

h3_index: The h3 hex index to fetch location details.