Install obp cliΒΆ
Note
The cli requires you use python version 3 or higher. On some systems this means your pip is called pip3 rather than pip
pip3 install --user obp-python # Requires at least python 3
Verify installationΒΆ
obp --help
Expected output:ΒΆ
Usage: obp [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
Commands:
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
getviews π§ Get views by provider
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
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
Congratulations! If you see the help menu output, you have installed the obp cli.
Note
You can also view additional help on individual commands,
such as obp addrole --help
to get more help on the
addrole
command. For example:
obp addrole --help Usage: obp addrole [OPTIONS] π§ Add a role for current user Options: --role-name TEXT Name of the role/entitelment [required] --bank-id TEXT Some roles need a bank id --user-id TEXT Add role to a differnt user --help Show this message and exit.