akahu.client

class akahu.client.Client(config: Config = None, **kwargs: Unpack[Config])

Bases: ApiBase

Akahu API client.

Arguments:

config (Client.Config): (optional) Configuration for the Akahu API client.

class Config(app_token: str, user_token: str, base: str = 'https://api.akahu.io/v1', app_token_header_name: str = 'X-Akahu-Id')

Bases: object

Configuration for the Akahu API client.

Attributes:

app_token (str): The application token. user_token (str): The user token. base (str): (optional) Override the base URL for the API. Defaults to “https://api.akahu.io/v1”. app_token_header_name (str): (optional) Override the header name for the application token. Defaults to “X-Akahu-Id”.

app_token: str

app_token_header_name: str = 'X-Akahu-Id'

base: str = 'https://api.akahu.io/v1'

user_token: str

property accounts: AccountsEndpoint

Endpoints for retreiving accounts.

property endpoint: str

property me: MeEndpoint

Endpoints for retreiving current user information.

property payments: PaymentsEndpoint

Endpoints for retreiving payments.

property pending_transactions: PendingTransactionsEndpoint

Endpoints for retreiving pending transctions.

property refresh: RefreshEndpoint

Endpoints for requesting a data refresh.

property transactions: TransactionsEndpoint

Endpoints for retreiving transactions.

property transfers: TransfersEndpoint

Endpoints for retreiving transfers.