Portfolio Dividend Tracker

Permanently remove a dividend record. Updates portfolio income totals and recalculates performance metrics. This action cannot be undone.

Permanently remove an expense record. Updates expense totals and recalculates performance metrics. This action cannot be undone.

Permanently remove an investment strategy. All links to securities are removed before deletion. This action cannot be undone.

Permanently remove a buy or sell transaction. Updates portfolio holdings, cash position, and recalculates performance metrics. This action cannot be undone.

Retrieve a single cash booking by ID. Returns booking details including date, amount, broker, and booking type.

Retrieve a single broker by ID. Returns broker details including name and supported import formats. Used to validate broker references in transactions.

Retrieve a single cash correction. Returns the corrected amount and linked symbol quote.

Retrieve closed portfolio positions only. Returns slim realised, total, dividend, transaction, broker, corporate action, and holding period details for positions where closedAt is not null. Results are paginated because closed positions grow over time. Use GetPortfolioHoldings for open positions.

Retrieve a single dividend by ID. Returns dividend details including security, gross amount, tax, exchange rate, and calculated net amount.

Retrieve a single expense by ID. Returns expense details including type, amount, broker, date, and description.

Get the status and results of an import. Returns the current status (waiting, success, failed) and counts of imported transactions, dividends, bookings, and expenses. Poll this endpoint after creating an import to check when processing completes.

Retrieve a single investment strategy by ID. Returns strategy details including name, icon, color, and count of linked securities.

Retrieve the portfolio financial summary, including cash balance, gains, dividends, transaction costs, taxes, and totals. Defaults to the latest snapshot; provide a date for historical view. Use GetPortfolioHoldings for open positions and GetClosedPortfolioHoldings for closed positions.

Analyze portfolio composition by sector, industry, industry group, country, continent, currency, asset type, market capitalization, exchange, broker, and investment strategy. Returns percentage breakdowns for each category based on current holdings. Useful for diversification analysis and identifying concentration risk.

Calculate total portfolio gains and percentage return for a time period. Returns the net gain/loss amount and percentage using the user-selected return method. Defaults to year-to-date.

Retrieve open portfolio positions only. Returns each open holding with its current price, shares, gains/losses, dividends, and weight; partially sold positions remain open while closedAt is null and keep their realised fields. Defaults to the latest snapshot; provide a date for historical view. Use GetClosedPortfolioHoldings for closed positions.

Calculate portfolio performance metrics for a time period. Returns the user-selected rate of return method, total gain/loss, capital growth, and dividend income. Compares portfolio value at period start vs end, accounting for deposits, withdrawals, and transactions. Defaults to year-to-date.

Simulate a custom benchmark blend against the portfolio over a date range. Accepts one or more weighted symbol quotes (e.g. 60% VWRL + 40% AGGH); weights are relative and normalized internally. Buys the blend with the portfolio's starting worth and applies every booking on its date, then returns the resulting chart (cumulative + periodic ticks), total gains percentage, beta vs the portfolio, and per-day / per-year volatility. Defaults to year-to-date. Stops the series at the date the portfolio first beats the blended benchmark, if any (`isBeatenAt`).

Get portfolio performance as a time series chart. Returns data points grouped by day, week, month, quarter, or year. Each tick contains portfolio metrics under `values` (e.g. currentWorth, totalGains, dividendsReceived). Defaults to year-to-date with auto-detected grouping.

Retrieve a single security by ID. Returns detailed information including name, ISIN, ticker, type (stock, ETF, fund, etc.), and metadata. Use SearchSymbols to find securities by name or ticker.

Retrieve a single ticker symbol quote by ID. Returns the security ticker, exchange, and currency information needed for creating transactions. A quote identifies where and in what currency a security trades.

Retrieve a single transaction by ID. Returns full transaction details including security information, broker, amounts, costs, and tax.

Get the authenticated user's profile including name, email, locale, timezone, currency preference, and account status.

Assign securities to investment strategies. Replaces existing strategy assignments for the provided securities. Each security can belong to multiple strategies. Used to categorize holdings by investment thesis for allocation analysis.

List cash bookings (deposits, withdrawals, fees, interest) with optional filtering by date range or broker. Results are paginated and ordered by date descending. Useful for tracking cash flows and reconciling broker statements.

List supported brokerage firms with optional name search. Brokers represent the institutions where portfolio accounts are held. Required when creating transactions, bookings, dividends, and expenses to track which account was affected.

List upcoming events for securities in the current portfolio. Includes earnings dates and dividend payments. Filter by date range, security, or event type.

List cash corrections with optional filtering by symbol quote. Cash corrections adjust the calculated cash position for a security.

List corporate actions (stock splits, ISIN changes, exchange changes) with optional filtering by symbol IDs, symbol quote IDs, type, or date range. Results are paginated and ordered by date descending.

List dividend payments with optional filtering by date range, broker, or security. Results are paginated and ordered by date descending. Useful for tracking income, tax reporting, and analyzing dividend yield across the portfolio.

List historical currency exchange rates between two currencies. Filter by exact date or date range. Rates are used to convert foreign currency transactions to the portfolio base currency. Provide 3-letter ISO currency codes (e.g., USD, EUR).

List portfolio expenses with optional filtering by date range, broker, or expense type. Results are paginated and ordered by date descending. Useful for tracking fees, analyzing cost impact, and tax reporting.

List import history with status and result counts. Results are paginated and ordered by most recent first.

List custom investment strategies with optional name search. Results are paginated and include the count of securities linked to each strategy. Useful for organizing portfolio holdings by investment approach.

List historical portfolio snapshots with financial summaries. Each snapshot represents the portfolio state at a specific date. Filter by date range to analyze portfolio evolution over time. Results are paginated and ordered by date descending. Does not include individual holdings; use GetPortfolioHoldings for open positions and GetClosedPortfolioHoldings for closed positions.

List historical closing prices for a ticker symbol. Filter by exact date or date range. Each price includes both the raw `close` and the `closeAdjusted` value (close divided by the cumulative product of any stock-split multipliers that took effect after the price date), useful for comparing prices across stock splits.

List ticker symbols (quotes) for securities. A symbol quote represents a specific security on a specific exchange in a specific currency. Filter by security ID, ticker code, or exchange. Each quote includes exchange and currency information needed for transactions.

List buy and sell transactions with optional filtering by date range, broker, security, or transaction type. Results are paginated and ordered by date descending (newest first). Useful for reviewing trading activity or generating reports.

Perform look-through analysis of ETF and fund holdings. Reveals the underlying individual stocks owned indirectly through fund positions. Calculates portfolio weight for each underlying holding based on fund allocations. Useful for understanding true diversification and concentration across the entire portfolio.

Search the securities database by name, ISIN, or ticker code. Returns matching stocks, ETFs, funds, and other instruments. Results include a flag indicating whether the security is currently in the portfolio. Useful for finding securities to add to transactions or research.