Skip to main content

Beta Open Bank Project Python Utilities

Project description

Open Bank Project CLI

A command line utility (CLI) to work with the Open Bank Project sandbox called obp.

With the obp cli you can:

  • Initiate an api connection to the sandbox
    • note you still need to sign-up from the sandbox homepage first to create your username & password
  • Get your DirectLogin token
  • Get your user information
  • Get your user id
  • Get banks
  • Get (your) accounts held at the bank

Also, depending on your account access you may:

  • Create a bank account
  • Add roles to a user
  • Import/Delete branches
  • Import dummy bank data


pip install --user obp-python # Requires at least python 3

Warning: If your operating system defaults to python 2, your pip command might be:

pip3 install --user obp-python
pip3.6 install --user obp-python


Usage: obp [OPTIONS] COMMAND [ARGS]...

  --help  Show this message and exit.

  addaccount              ๐Ÿ“ Add a bank account
  addbank                 ๐Ÿฆ Add a bank
  addcustomer             ๐Ÿง™ Add a customer
  addfx                   ๐Ÿ“‰ Add exchange rate (FX)
  addrole                 ๐Ÿšง Add a role for current user
  adduser                 ๐Ÿ“ Add a user
  addview                 ๐Ÿง Add a view
  answerconsent           ๐Ÿšง Answer consent
  createconsent           ๐Ÿšง Add a consent
  deletebranches          โš ๏ธ ๐Ÿฆ Delete all branches
  deletecardbyid          โš ๏ธ ๐Ÿ’ณ Delete card by id
  getaccountbyid          ๐Ÿ“ Get account by id (includes balance)
  getaccountsheld         ๐Ÿ“ Get list of accounts held
  getaccounttransactions  ๐Ÿ“ Get transactions for an account
  getauth                 ๐Ÿ”‘ Get your DirectLogin token
  getbanks                ๐Ÿฆ Get list of banks
  getcardbyid             ๐Ÿ’ณ Get card by id
  getcardbynumber         ๐Ÿ’ณ Get card by card number
  getcards                ๐Ÿ’ณ Get list of cards at bank
  getconsents             ๐Ÿšง Get consents
  getconsentstatus        ๐Ÿšง Get consent status- with certificate
  getcustomers            ๐Ÿ‘ฅ Get list of customers
  getuser                 ๐Ÿ˜ƒ Get your user info
  getuserid               ๐Ÿ“‹ Get your user id
  getuseridbyusername     ๐Ÿ“‹ Get user id by username
  getusers                ๐Ÿ˜ƒ Get all users
  importaccounts          ๐Ÿšœ Import accounts from spreadsheet template
  importbranches          ๐Ÿšœ Import branches from spreadsheet template
  importcardattribues     ๐Ÿšœ Import card attributes from spreadsheet template
  importcards             ๐Ÿšœ Import cards from spreadsheet template
  importcustomers         ๐Ÿšœ Import customers from spreadsheet template
  importfx                ๐Ÿšœ ๐Ÿ“‰ Load all foreign exchange rates (FX) to all...
  importtransactions      ๐Ÿšœ Import transactions from spreadsheet template
  importusers             ๐Ÿšœ Import users from spreadsheet template
  init                    ๐Ÿ’ก Initalize connection to your Open Bank Project...
  linkusertocustomer      ๐Ÿ”— Link user to a customer
  revokeconsent           ๐Ÿšง Revoke consent
  sandboximport           ๐Ÿšœ Bulk import sandbox data from json input


You must initalize the obp cli once, by doing:

obp init

Generate Direct Login Token

obp init 
Please enter your API_HOST:
Please enter your username:
Please enter your password: : 
Repeat for confirmation: 
... generating direct login token
Please enter your OBP_CONSUMER_KEY: # Go to, then "Get API Key" to generate consumer key.
obp getauth # Displays your DirectLogin token


Note You can ignore this is your just using the utlity. This is just for developing the utlity.

To work on this utility as a developer:

# Setup python3 environment
virtualenv -p python3 venv
. venv/bin/activate
git clone <this-repo>
# Building wheels etc
python sdist bdist_wheel
# Installing your edits locally:
pip install -e <path-to-this-repo> # -e means Install  a  project  in editable mode (i.e.  setuptools "developmode")
# Work on utility..submit pull request 

Update history
  • 0.19 Added sandboximport utility obp sandboximport --example
  • 0.0.9 Switch to use OBP_API_HOST instead of OBP_ENDPOINT

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

obp_python-0.206.tar.gz (32.3 kB view hashes)

Uploaded source

Built Distribution

obp_python-0.206-py3-none-any.whl (69.4 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page