Basiq Rapid Documentation

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

Getting started

Get started with our Quickstart Guide.

Read about the API at basiq.io.

Contents

• Quickstart Guide
• Sessions
  • Creating a session
  • Capabilities
    • Create a User
    • Get a User by ID
    • Get dict of institutions
    • Get institutions JSON
    • Search for an institution code
    • Delete User
• Users
  • Creating a user
  • Capabilities
    • Basics
    • Update user details
    • Get transactions
    • Get transaction
    • Get income
    • Get Expenses
    • Add Connection
    • Get Accounts
    • Get Account
    • Get Connections
    • Get Connection
• Connections
  • Creating a connection
  • Capabilities
    • Basics
    • Refresh connection
    • Get accounts
    • Get transactions
• Transactions
  • Creating a transaction
  • Capabilities
    • Basics
• Filters
  • Creating a filter
  • Options
    • Equal to (eq)
    • Between (bt)
    • Greater than (gt)
    • Greater than or equal to (gteq)
    • Less than (lt)
    • Less than or equal to (lteq)
  • Usage
• Utilities
  • To Pandas Dataframe
• Class Object Details