ghostfolio

library0.8.0pypypi✓ verified 79d ago

Python API client for Ghostfolio, an open-source personal finance dashboard. Current version 0.8.0 enables portfolio management, holdings, activities, and admin operations. Release cadence is irregular.

payments http-networking crm-productivity

pip install ghostfolio

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · GHOSTFOLIO

ghostfolio

paymentspythonv0.8.0

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

Ghostfolio

✓ from ghostfolio import Ghostfolio

✗ from ghostfolio import GhostfolioClient

Initialize client with base URL and access token, then fetch holdings.

from ghostfolio import GhostfolioClient client = GhostfolioClient( base_url=os.environ.get('GHOSTFOLIO_URL', 'http://localhost:3000'), access_token=os.environ.get('GHOSTFOLIO_ACCESS_TOKEN', '') ) # Fetch all holdings holdings = client.get_holdings() print(holdings)

Debug

Known issues

breakingIn version 0.4.0, the method `get_positions` was renamed to `get_holdings`. Old code will fail.

fix

Use `get_holdings()` instead of `get_positions()`.

affects: >=0.4.0

deprecatedAuthentication via `access_token` query parameter is deprecated; use header-based authentication (Authorization: Bearer <token>) which is the only supported method as of 0.8.0.

fix

Ensure token is passed as header (handled by library). If passing token in URL, update by removing that pattern.

affects: >=0.8.0

gotchaClient does not validate credentials on initialization; invalid tokens or URLs raise exceptions only on first API call. This can mask configuration errors.

fix

Perform a dummy API call (e.g., `client.get_health()`) immediately after init to check connectivity and authentication.

affects: all

Upgrade

Version history

0.8.0latest on PyPI · released Oct 23, 2025

Audit

Dependencies

requestsrequiredHTTP client for API calls

pydanticrequiredData validation and settings management

Agent activity

37 hits · last 30 days

node

OpenAI (training)

Resources

githubhttps://github.com/ms32035/ghostfolio-py ↗

packagehttps://pypi.org/project/ghostfolio/ ↗

homepagehttps://ghostfol.io ↗