Skip to main content

API Reference

Income

Foundations. Functions from the Income chapter.

wealth_formula()

Wealth from saving part of an income every year.

fixed_cost_ratio()

Fixed costs as a percent of take home pay.

raise_invested_value()

Future value of investing part of a raise.

Tracking Spending

Foundations. Functions from the Tracking Spending chapter.

apply_rules()

Categorize transactions with keyword rules.

subscription_opportunity_cost()

What a subscription would grow to if invested instead.

Budgeting

Foundations. Functions from the Budgeting chapter.

percent_of_income()

An expense as a percent of income.

to_annual()

Convert a daily, weekly, or monthly amount to a yearly amount.

to_monthly()

Convert a daily, weekly, or yearly amount to a monthly amount.

opportunity_cost()

What an amount could grow to if invested instead of spent.

months_to_break_even()

Months until monthly savings cover an upfront cost.

Managing Debt

Foundations. Functions from the Managing Debt chapter.

apr_to_apy()

Convert an APR to an annual percentage yield (APY).

months_to_payoff()

Months to pay off a balance with a fixed payment.

total_interest()

Total interest paid over the life of a loan.

loan_income_ratio()

Total student loans as a multiple of expected starting salary.

monthly_standard_payment()

Monthly payment on a standard student loan repayment plan.

idr_monthly_payment()

Income driven repayment (IDR) monthly payment.

dti_ratio()

Debt to income ratio.

payoff_vs_invest()

Pay off a debt or invest the difference.

order_avalanche()

Order debts for the avalanche method (highest APR first).

order_snowball()

Order debts for the snowball method (smallest balance first).

credit_utilization()

Credit utilization: a card balance as a percent of its limit.

Emergency Fund

Foundations. Functions from the Emergency Fund chapter.

emergency_fund_target()

Emergency fund target.

months_to_ef_goal()

Months to reach an emergency fund target.

monthly_contribution_needed()

Monthly contribution needed to reach an emergency fund target.

ef_growth()

Emergency fund balance after earning interest.

Savings Strategies

Savings. Functions from the Savings Strategies chapter.

savings_rate()

Savings rate: the percent of income not spent.

High-Yield Savings Accounts

Savings. Functions from the High-Yield Savings Accounts chapter.

hysa_balance()

High-yield savings account balance.

Automating Savings

Savings. Functions from the Automating Savings chapter.

monthly_savings()

Monthly amount to pay yourself first.

Investing Basics

Investing. Functions from the Investing Basics chapter.

future_value()

Future value of a single amount with yearly compounding.

rule_of_72()

Years for money to double, by the rule of 72.

future_value_series()

Future value of a fixed contribution made every period.

real_return()

Real (inflation adjusted) return.

Retirement Accounts

Investing. Functions from the Retirement Accounts chapter.

employer_match()

Yearly employer match on retirement contributions.

after_tax_value()

After tax value of a retirement contribution.

Index Funds

Investing. Functions from the Index Funds chapter.

yearly_fee()

Yearly fund fee from an expense ratio.

future_value_after_fees()

Future value of monthly contributions after fund fees.

Asset Allocation

Investing. Functions from the Asset Allocation chapter.

portfolio_return()

Return on a two fund (stock and bond) portfolio.

rebalance_amount()

Amount to buy (positive) or sell (negative) to reach a target.

Taxes

Taxes and insurance. Functions from the Taxes chapter.

income_tax()

Federal income tax for a single filer (2026 brackets).

raise_kept()

How much of a raise you keep after federal income tax.

Insurance

Taxes and insurance. Functions from the Insurance chapter.

break_even_years()

Years of premium savings to cover a higher deductible.

plan_cost()

Yearly cost of a health plan.

Financial Goals

Planning. Functions from the Financial Goals chapter.

monthly_for_goal()

Monthly saving needed to reach a goal.

months_to_fund()

Whole months to fund a goal with no interest.

Major Purchases

Planning. Functions from the Major Purchases chapter.

rent_buy_threshold()

Monthly rent that matches the unrecoverable cost of owning.

mortgage_payment()

Monthly payment on a fixed rate loan.

first_payment_split()

Interest and principal in a loan’s first monthly payment.

Estate Planning

Planning. Functions from the Estate Planning chapter.

net_worth()

Net worth: total assets minus total debts.

beneficiary_share()

Share of assets that pass directly to a named beneficiary.