Get account balances for a specific account.

Retrieves balance information for a specific account including current balance, currency, and balance history.

Get all accounts in your portfolio including account types and balances.

Retrieves a list of all accounts in your portfolio including account types, balances, and account-specific information.

Create a new account in your portfolio.

Creates a new account with the specified name, currency, and optional balance. This is useful for organizing your investments across different account types or platforms.

Note: current Ghostfolio versions have no boolean "excluded" flag on an account - exclusion from analysis is done by tagging the account, which is outside this tool's scope.

Delete an existing account from your portfolio.

Deletes an account specified by its ID. Be careful, this might delete associated transactions depending on backend rules!

Get details for a specific account.

Update settings or details of an existing account.

Ghostfolio's update endpoint replaces the whole account record, so name, currency and platform_id are required on every request even when they are not changing. Any left unset here are backfilled from the account's current state with a GET before the PUT, so you only need to pass the fields you actually want to change. If name or currency can't be backfilled (e.g. the account doesn't exist), the update stops before the PUT and names them.

Setting balance here applies it as today's entry in the account's balance history (the same series get_account_balances returns and get_portfolio_holdings derives its cash figure from) - it is not a separate stale field. Use create_account_balance to set the balance for a specific past date instead of today.

Transfer cash balances between two accounts.

Set an account's balance for a specific date in its balance history.

This writes directly to the balance-history series that get_account_balances returns and that get_portfolio_holdings derives its cash figure from - it is not the same as the account's summary balance field. Calling this again for the same account and date updates that entry instead of duplicating it, so setting today's balance is just this call with date omitted.

The balance is recorded in the account's own currency; Ghostfolio's API does not accept a separate currency for this endpoint.

Delete a single entry from an account's balance history.

Get all activities/orders from your portfolio, optionally filtered by account.

Retrieves a list of all buy/sell orders in your portfolio, optionally filtered by a specific account.

Create a single new transaction/activity.

Update an existing activity/transaction.

Ghostfolio's update endpoint replaces the whole activity record, so type, symbol, date, quantity, unitPrice, currency, dataSource and fee are required on every request even when they are not changing. Any left unset here (including tags, account_id and comment) are backfilled from the activity's current state with a GET before the PUT, so you only need to pass the fields you actually want to change. If a required field can't be backfilled (Ghostfolio redacts quantity and fee in restricted views), pass it explicitly. A restricted view also redacts comment, and Ghostfolio clears the comment whenever the update carries none, so in that case comment is required too (pass an empty string to clear it).

Ghostfolio identifies the asset by dataSource and symbol together, and the current currency belongs to that asset. So changing either symbol or data_source requires passing symbol, data_source and currency together; backfilling the rest from the old asset would attach the activity to the wrong asset profile or price it in the wrong currency. Ghostfolio ignores an asset change (without an error) when the resulting activity is a FEE, INTEREST or LIABILITY, or a BUY on the MANUAL data source; delete and re-create the activity instead.

The GET and PUT are separate requests, so an edit made to the same activity in between (e.g. in the Ghostfolio UI) is overwritten for every field not passed here.

Delete a single activity/transaction by its ID.

Get asset profile information for a specific symbol.

Retrieves detailed profile information about an asset including company information, sector, industry, and other metadata.

Create-or-update an asset profile.

POSTs an empty profile-data record (idempotent — Ghostfolio answers HTTP 400 "already exists" when the profile is already there, and HTTP 500 on some first-time-create paths while still persisting the record, so this tolerates both). Then PATCHes metadata (name, currency, asset class, optional sub-class, optional country and sector allocations). PATCH is the source of truth — if the profile doesn't exist after the POST, PATCH will surface the error. Calling twice with the same input yields the same end state.

Delete an asset profile.

Removes the profile-data record for the given data source and symbol. Be careful, this might delete associated activities and market data depending on backend rules!

Get all configured benchmarks.

Compare portfolio performance against a benchmark symbol starting from a specific date.

Get the exchange rate for a given currency symbol on a specific date.

Export portfolio activities/transactions data as JSON.

Retrieves portfolio transactions with optional query filters.

Import transactions into your portfolio. This is a write operation.

Imports a batch of transactions (buy/sell orders) into your Ghostfolio portfolio. This is useful for bulk importing historical data or transactions from other platforms.

Fetch historical dividend data formatted for import for a specific symbol.

Get market data for a specific asset.

Retrieves current market data for a specific symbol including price, volume, market cap, and other relevant market information.

Add one or more market data points for a specific asset.

Posts to the market-data endpoint for the given data source and symbol. Same (symbol, date) overwrites the existing point; passing the same input twice yields the same end state.

Get comprehensive portfolio details including accounts, positions, and summary.

Retrieves a complete overview of your portfolio including account information, current positions, performance summary, and portfolio metrics.

Get dividend data grouped by time period showing dividend payments and yield.

Retrieves dividend income data grouped by the specified time period, showing dividend payments, yield, and income patterns over time.

Get portfolio holdings and positions including allocations and asset breakdowns.

Retrieves current portfolio holdings including positions, allocations, and asset breakdowns for the specified time period.

Get investment data grouped by time period showing cash flows and contributions.

Retrieves investment activity data grouped by the specified time period, showing cash flows, contributions, and investment patterns over time.

Get portfolio performance data including returns, benchmarks, and performance metrics.

Retrieves comprehensive performance metrics for your portfolio including returns, benchmarks, and performance comparisons over the specified time period.

Get position details for a specific symbol from a data source.

Retrieves detailed information about a specific position including current value, quantity, performance, and market data.

Get symbol data for a specific asset from a data source.

Retrieves detailed information about a specific symbol including current price, market data, and asset information.

Get historical data for a specific symbol on a specific date.

Retrieves historical market data for a symbol on a specific date, including price and volume information.

Search for symbols using a query string.

Search for financial symbols, stocks, ETFs, and other assets using a text query. Optionally include market indices in the results.

Get system health status.

Retrieves the health status of the Ghostfolio backend service. This is useful to verify if the server is up and running correctly.

Get available platforms.

Retrieves a list of all available platforms (brokers, exchanges, etc.) that can be used when tracking accounts or transactions.

Get user information and settings.

Retrieves information about the current user including settings, preferences, and account details.

Get all items in the user's watchlist.

Retrieves list of all watchlisted symbols.

Add a symbol to the user's watchlist.

Remove a symbol from the user's watchlist.