Code Monkey home page Code Monkey logo

investec's Introduction

Investec Open Banking CLI

An interactive CLI application for communicating with the Investec Open Banking APIs.

Built with Deno.

Install

Assuming you already have deno installed.

deno install --allow-net=openapi.investec.com --allow-env https://raw.githubusercontent.com/adrianhopebailie/investec/master/investec.ts

Usage

To use the application you'll need your client id and client secret from Investec.

  1. Login to Investec Online.
  2. Navigate to the Programmable Banking landing page.
  3. Select the Open API tab.
  4. Select the Enroll button.

To run the application simply run:

$ investec

If that doesn't work it's possible that your Deno bin folder is not in your path (see the error that would have been logged when you did the install). Make sure you have something like export PATH=$HOME/.deno/bin:$PATH in your shell config.

You can type help to get a list of available commands or quit to... quit.

Login

The application will try to create an authenticated session when running any command if one doesn't already exist. However you can explicitly login using the login command.

The provided credentials will be kept in memory as long as the application is running.

To skip typing in the login credentials these can be provided as environment variables called INVESTEC_CLIENT_ID and INVESTEC_CLIENT_SECRET.

$ INVESTEC_CLIENT_ID=uytfqwed76r5quwdtfo86twef INVESTEC_CLIENT_SECRET=98uy978y23ry8 investec

Accounts

Using the accounts or accts command will list your accounts and prompt you to select an account that will be used for further operations such as transaction and balance enquiries. You can skip setting a selected account by simply hitting โŽ (Enter).

Transactions

The transactions and txs command will get a list of transactions for the currently selected account and prompt to select an account if one hasn't already been selected.

Balance

The balance and bal command will get the current balance for the currently selected account and prompt to select an account if one hasn't already been selected.

TODO

  • Auto-fetch balances when getting account list
  • Better management of credential state (secure storage?)
  • Use currency from balance query for tx list

investec's People

Contributors

adrianhopebailie avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.