https://github.com/mike-gee/basiqrapid

[Discontinued as of April 2019] A Python 3+ wrapper for the basiq.io API
https://github.com/mike-gee/basiqrapid

api api-wrapper banking basiq finance open-banking python python-3 python-library python3 utility

Last synced: 2 days ago
JSON representation

[Discontinued as of April 2019] A Python 3+ wrapper for the basiq.io API

• Host: GitHub
• URL: https://github.com/mike-gee/basiqrapid
• Owner: mike-gee
• License: mit
• Created: 2019-03-22T00:28:42.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2019-03-25T01:39:56.000Z (over 5 years ago)
• Last Synced: 2024-09-24T09:19:08.649Z (3 days ago)
• Topics: api, api-wrapper, banking, basiq, finance, open-banking, python, python-3, python-library, python3, utility
• Language: Python
• Homepage:
• Size: 55.7 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE.rst

Awesome Lists containing this project

README

        
Basiq Rapid

=====================

**A Python 3+ wrapper for the basiq.io API**

.. image:: https://readthedocs.org/projects/basiq-rapid/badge/?version=latest

.. image:: https://img.shields.io/pypi/v/basiqrapid.svg

----

About

##############

**Basiq Rapid** is a Python wrapper for the `basiq.io `_ API. 

Perfect for the developer and analyst:

:✅:

   API Filters

:✅:

   Quick Integration with Pandas 🐼

:✅:

   Object-oriented wrapper allows for simultaneous users and operations

Refer to `basiq API `_ for API (and thus Basiq Rapid) capabilities.

Basiq Rapid is not affiliated with basiq.io. See disclaimer.

Install

#############

Installation::

   

   pip install basiqrapid

Dependencies: json, requests, pandas

Documentation

##################

`Basiq Rapid Read the Docs `_

Quickstart

############

**Import Basiq Rapid into Python**::

   import basiqrapid as bq

**Create a session**::

   API_KEY = ""

   session = bq.Session(API_KEY)

**Get institutions**::

   institution_dict = session.getInstitutions()

   wbc_code = institution_dict['Westpac Banking Corporation']

**Create a User**::

   usr = session.createUser(email="[email protected]", mobile="+61888000888")

**Create a connection**::

   job = usr.addConnection(loginID="gavinBelson", password="hooli2016", institutionID="AU00000")

   print(job.getStatus())

**Some User Capabilities**::

   transactions = usr.getTransactions() # Returns list of Transaction objects

   connections = usr.getConnections() # Returns list of Connection objects

   income = usr.getIncome()

   income_year = income.regularIncomeYear

**Some Connection Capabilities**::

   first_connection = connections[0]

   first_connection.institution_id # Returns institution ID

   accounts = first_connection.getAccounts()

**Some Account Capabilities**::

   

   first_account = accounts[0]

   transactions = first_account.getTransactions()

**Some Transaction Capabilities**::

   first_transaction = transactions[0]

   print(transaction.balance)

   print(transaction.description)

**Convert to pandas DataFrame**::

   import pandas as pd

   transactions = usr.getTransactions()

   trans_df = bq.to_df(transactions)

   accounts = usr.getAccounts()

   acc_df = bq.to_df(accounts)

**Filters**::

   f = bq.newFilter()

   f.gt("transaction.postDate","2018-01-28")

   transactions = usr.getTransactions(f)