Configuration Script

from jupyter_finance.core import *
import os
about()

1. Add New Accounts

  1. Verify with Plaid (and bank providers) via Link provided (get a link_token)
  2. Grab ‘Public Access Token’ and save to local database (to be used for next time)
  3. Retrieve every public access token in our database and query transaction data

Refer to Core APIs (Authentication) and Official Plaid Documentation for detailed steps on how to your data is queried.

Refer to Token Storage to see how your tokens are secured.

email = os.getenv("USER_EMAIL", "default@email.com")
phone = os.getenv("USER_PHONE", "+1 000 0000000")

Verify identity of Client Application and get a Link token

link_token = generate_link_token(email, phone)

We grab ‘Public Access Token’ and save to local database

get_and_save_public_token(link_token, email, phone)

Retrieve every public access token in our database

access_tokens = get_stored_public_access_tokens()
get_and_save_all_account_transactions(first_time=True)

2. Budgetting

For more info on budgets, refer to Budget Flows

insert_new_budget(name="Budget #1", 
                  description="Transportation", 
                  limit=100, cadence="monthly",
                  date_of_week="sat",
                  rules="personal_finance_category = 'TRANSPORTATION' OR personal_finance_category = 'TRAVEL'"
)
insert_new_budget(name="Budget #2", 
                  description="Coffee", 
                  limit=30, cadence="weekly",
                  date_of_week="tue",
                  rules="personal_finance_category_detailed = 'FOOD_AND_DRINK_COFFEE'")

insert_new_budget(name="Budget #3",
                  description="Da Bois",
                  limit=420.69,
                  cadence="monthly",
                  rules="personal_finance_category = 'ENTERTAINMENT' OR personal_finance_category = 'LOAN_PAYMENTS'")

insert_new_budget(name="Budget #4",
                  description="Eating",
                  limit=10000000,
                  cadence="biweekly",
                  date_of_week="sat",
                  rules="personal_finance_category_detailed = 'FOOD_AND_DRINK_FAST_FOOD' AND NOT merchant_name = 'KFC'")

insert_new_budget(name="Budget #5", 
                  description="KFC", 
                  limit=10000000, 
                  cadence="biweekly",
                  date_of_week="sat",
                  rules="personal_finance_category_detailed = 'FOOD_AND_DRINK_FAST_FOOD' AND merchant_name = 'KFC'")

View active budgets

get_all_active_budgets()