Class Object Details

class main.Session(API_KEY)

createUser(email='', mobile='')

Creates User.

Creates user and returns User object.

Parameters:

• email (str) – User’s email. Optional if mobile entered.
• mobile (str) – User’s mobile number. Optional if email entered.

Returns:

Returns the created User class object.

Return type:

User (obj)

deleteUser(userID)

Delete user.

Parameters:userID (str) – User’s ID. Returns:Indicates success Return type:True

getInstitutions()

Fetches institutions

Fetches user and returns dict of institutions.

Parameters:None – Returns:Returns dict of institutions. Return type:dict

getInstitutionsJSON()

Fetches institutions JSON

Fetches user and returns raw json of institutions.

Parameters:None – Returns:Returns raw json of institutions. Return type:json

getUser(userID)

Fetches user

Fetches user and returns User object.

Parameters:userID (str) – User’s ID. Returns:Returns the created User class object. Return type:User (obj)

searchInstitutions(searchTerm)

Finds institutions based on search

Parameters:searchTerm (str) – Search term of bank (eg. ‘Westpac’) Returns:Returns dict of search results. Return type:dict

class main.User(user_json, header)

addConnection(loginID='', password='', institutionID='')

Add’s bank account connection to user.

Returns a job object that monitor’s API progress.

Parameters:

• loginID (str) – User’s login username for banking account
• password (str) – User’s password for banking account
• institutionID (str) – Bank’s ID.

Returns:

Returns Job object that monitor’s connection progress

Return type:

Job (obj)

getAccounts(input_filter=None)

Fetches all user accounts

Parameters:None – Returns:Returns list of Account objects linked with user. Return type:list

getConnections(input_filter=None)

Fetches list of user’s connections.

Parameters:None – Returns:Returns list of Connection objects Return type:list

getExpenses()

Fetches user’s expenses summary.

Fetches user’s expenses summary and returns an Expense object.

Parameters:None – Returns:Returns the user’s expenses in form of Expense class object. Return type:Expense (obj)

getIncome()

Fetches user’s income summary.

Fetches user’s income summary and returns an Income object.

Parameters:None – Returns:Returns the user’s income in form of Income class object. Return type:Income (obj)

getTransaction(transactionID)

Fetches transaction.

Fetches transactions and returns list of Transaction objects.

Parameters:transactionID – transactionID string Returns:Returns list of Transaction objects. (max: 500) Return type:list

getTransactions(input_filter=None)

Fetches transactions.

Fetches transactions and returns list of Transaction objects.

Parameters:None – Returns:Returns list of Transaction objects. (max: 500) Return type:list

refreshAllConnections()

Refreshes all of user’s connections.

Ensure’s most up-to-date information.

Parameters:None – Returns:returns list of Job objects that monitor connections’ update Return type:list

refreshConnection(connectionID)

Refreshes specific connection, ensuring most up-to-date information.

Parameters:connectionID (str) – ID of connection to be refreshed. Returns:Returns Job object to monitor progress Return type:Job (obj)

to_dict()

Convert object details to dict.

Hidden method for converting object to pandas dataframe.

Parameters:None – Returns:Returns dict of object. Return type:dict

update(email='', mobile='')

Updates user’s details.

Parameters:

• email (str) – Email to be updated. Optional if mobile entered.
• mobile (str) – Mobile to be updated. Optional if email entered.

Returns:

Indicates success.

Return type:

True

class main.Connection(connect_json, header)

getAccounts(input_filter=None)

Fetches accounts linked with connection.

Returns a list of Account objects.

Parameters:None – Returns:Returns a list of Account objects linked with the connection. Return type:list

getTransactions(input_filter=None)

Fetches all transactions linked with connection.

Parameters:None – Returns:Returns a list of Transaction objects linked with connection. Return type:list

refresh()

Refreshes specific connection, ensuring most up-to-date information.

Parameters:connectionID (str) – ID of connection to be refreshed. Returns:Returns Job object to monitor progress Return type:Job (obj)

to_dict()

Convert object details to dict.

Hidden method for converting object to pandas dataframe.

Parameters:None – Returns:Returns dict of object. Return type:dict

class main.Account(account_json, header)

getTransactions(input_filter=None)

Fetches transactions linked with account.

Parameters:None – Returns:Returns list of Transaction objects linked with account. Return type:list

to_dict()

Convert object details to dict.

Hidden method for converting object to pandas dataframe.

Parameters:None – Returns:Returns dict of object. Return type:dict

class main.Transaction(transact_json, header)

to_dict()

Convert object details to dict.

Hidden method for converting object to pandas dataframe.

Parameters:None – Returns:Returns dict of object. Return type:dict

class Job.Job(job_json, header)

getStatus()

Gets status of job

Parameters:None – Returns:Returns dict of job status Return type:dict

isComplete()

Checks if job is fully complete.

Parameters:None – Returns:Returns if job is complete. Return type:bool

refresh()

Refreshes job status

Parameters:None – Returns:Indicate success. Return type:True

class Income.Income(income_json, header)

class Expense.Expense(expense_json, header)