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.

Returns: Dictionary containing account information including accounts list and total value

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.

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.

Transfer cash balances between two accounts.

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.

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 returns HTTP 500 on both duplicate-create and some first-time-create paths while still persisting the record, so this tolerates 500). Then PATCHes metadata (name, currency, asset class, optional sub-class). PATCH is the source of truth — if the profile doesn't exist after the POST, PATCH will surface a 404. 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.

Returns: Dictionary containing the list of 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.

Returns: Dictionary containing complete portfolio information including accounts, positions, and summary

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.

Returns: Dictionary containing health status information

Get available platforms.

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

Returns: Dictionary containing available platforms

Get user information and settings.

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

Returns: Dictionary containing user information and settings

Get all items in the user's watchlist.

Retrieves list of all watchlisted symbols.

Returns: Dictionary containing the watchlist items.

Add a symbol to the user's watchlist.

Remove a symbol from the user's watchlist.