add_payment_method
ChatGPTAdd A New Payment Method (e.g. A Credit Card Name). Returns The Created Payment Method With Its ID.
add_recurring_transaction
ChatGPTAdd A New Recurring Transaction Rule. The System Will Automatically Create Transactions According To The Recurrence Schedule. Returns The List Of All Active Recurring Transactions.
add_tag
ChatGPTCreate A New Tag Within A Spending Category. Tags Let You Further Classify Transactions Within A Category (e.g. "Groceries" Within The Food Category). Returns The Created Tag.
add_trade
ChatGPTRecord A New Trade (Buy Or Sell). Pass dry_run=true To Preview: It Returns The Trade That Would Be Recorded And The Current Position For That Account And Ticker, And Saves Nothing. The Server's Checks (e.g. Selling More Than You Hold) Only Run When The Trade Is Actually Recorded. Returns The Created Trade Record.
add_transaction
ChatGPTAdd A New Transaction. Returns The Created Transaction (transaction_data) Plus The Month's New Totals (monthly_summary With transaction_count, specific_category, categorical_overview).
add_watchlist_item
ChatGPTAdd A Ticker To The Watchlist. Returns The Created Watchlist Item.
create_split
ChatGPTCreate A New Shared Expense Split. Creates A Transaction For The Payer And Mirror Transactions For Each Participant. Automatically Updates Budgets And Connection Balances. Returns The Created Split With Participant Details, Your Copy Of The Transaction (transaction_data) And The Month's New Totals.
delete_trade
ChatGPTDelete A Trade Record And Reverse Its Effect On The Position. Fails If Later Sells Depend On The Shares This Trade Added. Pass dry_run=true To See The Trade That Would Be Deleted Without Deleting It. Returns Confirmation Of Deletion.
delete_transaction
ChatGPTDelete A Transaction. Pass dry_run=true To See The Transaction That Would Be Deleted Without Deleting It. Returns The Month's New Totals After The Deletion.
get_balance_detail
ChatGPTGet Detailed Balance History With A Specific Connected User. Returns The Overall Balance, All Shared Splits (With Per-Expense Settlement Status), And All Settlement Records Between You And The Specified User.
get_categorical_overview
ChatGPTGet Categorical Spending Overview For A Specific Month. Returns Total Spending, Spending Percentages Per Category (Keyed By Category ID, Plus spending_percentages_by_name), And Category Breakdowns With category_name For The Given Month.
get_categories
ChatGPTGet Spending Categories With Their Budgets And Totals For A Specific Month. Returns Each Category's Monthly Spend, Budget Amount, Icon, And Color, With category And category_name. display_category (And display_category_name) Is The Category The App Shows In That Slot When The User Has Swapped It.
get_equity_compensation
ChatGPTGet Employee Equity: Stock Options, RSUs, ESPP And Warrants, With Vesting And Value. Each Grant Has Its Quantity, Strike, Share Price (Live Underlying, Else manual_price), Intrinsic Value Per Share, vested_quantity, unvested_quantity, next_vest_date, next_vest_quantity, vested_value, total_value, exercise_cost_total (Strike x Quantity), counted_value (What Counts Toward Net Worth) And vesting_unknown (True When No Vesting Schedule Is Set; It Then Counts As Fully Vested). totals Sums The Grants; count_mode Is The User's equity_comp_in_net_worth Setting. Grants Are Kept Out Of Unrealized Gains, Total Return And Allocation In get_portfolio_summary.
get_exchange_rate
ChatGPTGet The Current Exchange Rate Between Two Currencies. Returns The Exchange Rate.
get_investment_accounts
ChatGPTGet All Investment Accounts. Returns A List Of Investment Accounts With Their Names, Types, Institutions, Groups, Currencies, And Associated Positions.
get_live_prices
ChatGPTGet Live Market Prices For A List Of Tickers. Returns Current Price Data For Each Ticker.
get_monthly_summary
ChatGPTGet The Monthly Spending Summary For A Specific Month. Returns Monthly Spend, Monthly Earn, And Every Transaction For The Given Month/Year. Each Transaction Has category And category_name, Plus split (Payer, total_amount, Participants With share_amount And settled_at) When It Is A Shared Expense — Its amount_spent Is Then Your Share. Use get_transactions To Filter Or Page.
get_net_worth_history
ChatGPTGet Net Worth History Converted With Each Snapshot's Own FX Rates. Returns Points With Total, Change Since The Previous Snapshot, Per-Account Values (Keyed By Account) And Any Unattributed Amount (Backdated Totals With No Breakdown).
get_on_launch_data
ChatGPTGet All Data Needed On App Launch For A Specific Month. This Is A Combined Endpoint That Returns The User Profile, Monthly Summary, Categories, Tags, Payment Methods, And Other Data Needed To Render The Main Screen. Returns Everything The App Needs On Launch In A Single Response.
get_portfolio_summary
ChatGPTGet The Portfolio Summary Computed By The Server. Includes Net Worth, Invested Value, Cash, Book Cost, Unrealized And Realized Gains, Day Change, Per-Account Totals, Holdings (Merged Across Accounts) And Allocation By Account, Account Type, Group, Holding And Currency — All In One Currency.
get_positions
ChatGPTGet Investment Positions (Holdings). Can Be Filtered By Account, Group, Or Active Status. Returns A List Of Positions With Ticker, Quantity, Book Cost, And Account Info.
get_profile
ChatGPTGet The Authenticated User's Profile. Returns User Profile Information Including Name, Email, Country, And Subscription Status.
get_recurring_transactions
ChatGPTGet All Active Recurring Transactions. Returns A List Of Recurring Transaction Rules Including Frequency, Next Occurrence, End Conditions, And The Associated Transaction Template.
get_trades
ChatGPTGet Trade History, Newest First. Supports Filtering And Pagination. Each Trade Has id, account (id And name), ticker_yahoo, ticker_display, side (BUY/SELL), quantity, price_total, sale_price_total, currency, exchange_rate, date And Option Fields. The Result Has total (Matches Before Paging) And has_more.
get_transactions
ChatGPTGet Or Search Transactions For One Month Or A Date Range, Newest First. Pass month And year For One Month, Or start_date/end_date For A Range Spanning Months (Up To 36 Months Per Call). Each Transaction Has id, date, amount_spent (Positive = Expense; Income Is Category 3), category And category_name, title, subtitle, tags, payment_forms, And split When It Is A Shared Expense (amount_spent Is Then Your Share). The Result Also Has total (Matches Before Paging), has_more, And sum_amount_spent Over All Matches, So Totals Don't Need Every Page.
get_watchlist
ChatGPTGet The User's Stock Watchlist With Current Prices. Returns Watchlist Items With Current Prices And Period Change.
list_balances
ChatGPTList Running Balances With All Connected Users. Returns The Amount Owed To Or From Each Connected User. Positive Amount Means You Owe Them, Negative Means They Owe You.
list_category_catalog
ChatGPTList Every Spending Category: Its ID, Name And Emoji. Category IDs Run 1-30: 1 Healthcare, 2 Car, 3 Income, 4 Hobbies, 5 Investments, 6 Eating Out, 7 Groceries, 8 Travel, 9 Subscriptions, 10 Rent, 11 Savings, 12 Transportation, 13 Beauty, 14 Social Events, 15 Clothing, 16 Pets, 17 Home, 18 Drinks, 19 Loans, 20 Utilities, 21 Coffee Shops, 22 School, 23 Insurance, 24 Miscellaneous, 25 Gadgets, 26 Donations, 27 Wellness, 28 Gym + Sports, 29 Emergency Fund, 30 Taxes. Category 3 (Income) Counts As Earnings, Not Spending.
send_feedback
ChatGPTTell the Maple Budget team when you can't do what the user asked with these tools, or something looks wrong: a tool you needed that doesn't exist, a missing field or option, a result that didn't match the user's accounts, an error, or a description that misled you. Say what you were trying to do and what would have helped. It doesn't change the user's data. Don't include card numbers, passwords or other secrets.
settle_split
ChatGPTMark A Split Participant As Settled (Paid). Sets The settled_at Timestamp And Adjusts The Connection Balance. Returns The Updated Settlement Status.
update_trade
ChatGPTEdit A Trade In Place. Positions Are Rebuilt From Trade History Automatically. Only The Fields You Pass Are Changed. Use This Instead Of Deleting And Re-Adding. For A SELL, Changing The Quantity Or Date Without Passing price_total Recomputes The Cost Basis. Edits That Would Sell More Than Was Held On That Date Are Rejected. Returns The Updated Trade.
update_transaction
ChatGPTUpdate An Existing Transaction. Only The Fields You Provide Will Be Changed; Omitted Fields Keep Their Current Value. Shared-Expense (Split) Transactions Can't Be Edited Here, And A Transaction's Tags Must Belong To Its Category, So Changing The Category Of A Tagged Transaction Is Rejected. Pass dry_run=true To See The Before And After Without Saving Anything. Returns The Updated Transaction (transaction_data) Plus The Month's New Totals.