Voraussetzungen
- Python 3.10 bis 3.14
- Terminalzugang (macOS, Linux oder WSL)
Installation
# Kerninstallation (nur deterministische Parser)
pip install bankstatementparser
Optionale Extras für zusätzliche Funktionen:
# Text-LLM-Pfad für digitale PDFs (litellm + pypdf)
pip install 'bankstatementparser[hybrid]'
# Genauere Tabellenextraktion (fügt pdfplumber hinzu)
pip install 'bankstatementparser[hybrid-plus]'
# Vision-LLM-Pfad für gescannte PDFs (fügt pypdfium2 hinzu)
pip install 'bankstatementparser[hybrid-vision]'
# LLM-gestützte Transaktionskategorisierung
pip install 'bankstatementparser[enrichment]'
# REST API-Microservice (FastAPI + uvicorn)
pip install 'bankstatementparser[api]'
# Optionale Polars DataFrame-Unterstützung
pip install 'bankstatementparser[polars]'
Schnellstart
Automatisch erkennen und jedes strukturierte Format parsen
from bankstatementparser import create_parser, detect_statement_format
fmt = detect_statement_format("transactions.ofx")
parser = create_parser("transactions.ofx", fmt)
df = parser.parse() # pandas DataFrame
print(df.head())
Dies funktioniert mit .xml (CAMT/PAIN.001), .csv, .ofx, .qfx, .mt940 und .sta Dateien.
CAMT.053 parsen
from bankstatementparser import CamtParser
parser = CamtParser("statement.xml")
transactions = parser.parse()
PAIN.001 parsen
from bankstatementparser import Pain001Parser
parser = Pain001Parser("payment.xml")
payments = parser.parse()
PDF-Kontoauszüge parsen (Hybride Pipeline)
Die hybride Pipeline leitet PDFs intelligent über drei Extraktionspfade:
from bankstatementparser.hybrid import smart_ingest
result = smart_ingest("statement.pdf")
print(result.source_method) # "deterministic" | "llm" | "vision"
print(result.verification.status) # VERIFIED | DISCREPANCY | FAILED
print(result.transactions) # List of extracted transactions
Jede Extraktion wird mit der Golden Rule geprüft: opening + credits − debits == closing.
Streaming großer Dateien
Für Dateien mit Tausenden von Transaktionen nutzen Sie Streaming, um den Speicher begrenzt zu halten:
parser = CamtParser("large_statement.xml")
for transaction in parser.parse_streaming(redact_pii=True):
process(transaction) # Memory stays constant
In-Memory-Parsing
Parsen aus Bytes ohne Festplatten-I/O — nützlich für SFTP- oder API-Workflows:
xml_bytes = download_from_sftp()
parser = CamtParser.from_bytes(xml_bytes, source_name="daily.xml")
transactions = parser.parse()
Parallele Dateiverarbeitung
Mehrere Dateien gleichzeitig parsen:
from bankstatementparser import parse_files_parallel
results = parse_files_parallel([
"statements/jan.xml",
"statements/feb.xml",
"statements/mar.xml",
])
for r in results:
print(r.path, r.status, len(r.transactions), "rows")
Massenverarbeitung ganzer Verzeichnisse
Komplette Ordnerstrukturen mit automatischer Deduplizierung verarbeiten:
from bankstatementparser.hybrid import scan_and_ingest
batch = scan_and_ingest("statements/2026/", pattern="**/*.pdf")
print(f"Processed: {len(batch.results)} files")
print(f"Unique transactions: {batch.unique_count}")
Deduplizierung
Idempotente Transaktions-Hashes für sichere inkrementelle Aufnahme:
from bankstatementparser import CamtParser, Deduplicator
parser = CamtParser("statement.xml")
dedup = Deduplicator()
result = dedup.deduplicate(dedup.from_dataframe(parser.parse()))
print(f"Unique: {len(result.unique_transactions)}")
print(f"Exact duplicates: {len(result.exact_duplicates)}")
print(f"Suspected matches: {len(result.suspected_matches)}")
Transaktionskategorisierung (Anreicherung)
Transaktionen automatisch mit LLM-gestützter Klassifizierung kategorisieren:
from bankstatementparser.enrichment import Categorizer
categorizer = Categorizer()
enriched = categorizer.categorize_batch(transactions)
for txn in enriched:
print(f"{txn.description}: {txn.category}")
Ledger-Export (hledger / beancount)
Transaktionen in Plaintext-Accounting-Journalformate exportieren:
from bankstatementparser.export import to_hledger, to_beancount
journal = to_hledger(transactions, account="Assets:Bank:Checking")
beancount_journal = to_beancount(transactions, account="Assets:Bank:Checking")
Multi-Währungs-Saldoprüfung
Salden unabhängig pro Währungsgruppe verifizieren:
from bankstatementparser.hybrid import verify_balance_multi_currency
results = verify_balance_multi_currency(transactions)
for currency, verification in results.items():
print(f"{currency}: {verification.status}")
REST API
Als FastAPI-Microservice bereitstellen:
# API-Server starten
bankstatementparser-api --port 8000
# Für Container-Deployments
bankstatementparser-api --host 0.0.0.0 --port 9000
Endpunkte:
POST /ingest-- Kontoauszugsdatei parsenGET /health-- Health-Check
Sichere ZIP-Verarbeitung
Gezippte XML-Dateien mit integrierten Sicherheitsprüfungen verarbeiten (Bomb-Schutz, Ablehnung verschlüsselter Einträge):
from bankstatementparser import iter_secure_xml_entries, CamtParser
for entry in iter_secure_xml_entries("statements.zip"):
parser = CamtParser.from_bytes(entry.xml_bytes, source_name=entry.source_name)
print(f"{entry.source_name}: {len(parser.parse())} transactions")
Export
parser = CamtParser("statement.xml")
parser.export_csv("output.csv")
parser.export_json("output.json")
# Polars (requires bankstatementparser[polars])
polars_df = parser.to_polars()
# Excel
parser.camt_to_excel("output.xlsx")
CLI-Nutzung
# Strukturierte Formate parsen
bankstatementparser --type camt --input statement.xml
bankstatementparser --type pain001 --input payment.xml
# Hybride PDF-Pipeline
bankstatementparser --type ingest --input statement.pdf
bankstatementparser --type ingest --input statement.pdf --output ledger.csv
# Interaktiver Prüfmodus
bankstatementparser --type review --input result.json
bankstatementparser --type review --input result.json --output reviewed.json
# Nach CSV mit Streaming exportieren
bankstatementparser --type camt --input statement.xml --output transactions.csv
bankstatementparser --type camt --input statement.xml --streaming --show-pii
CLI-Optionen:
--type {camt,pain001,ingest,review}-- Parser-Typ oder Modus--input <path>-- Eingabedatei--output <path>-- Exportdatei (CSV oder JSON)--streaming-- Große Dateien streamen--show-pii-- Sensible Felder anzeigen (standardmäßig geschwärzt)--max-size <MB>-- Dateigrößenlimit
Lokale Entwicklungsumgebung
git clone https://github.com/sebastienrousseau/bankstatementparser.git
cd bankstatementparser
python3 -m venv .venv && source .venv/bin/activate
pip install poetry && poetry install --with dev
make install-hooks # pre-commit hook runs `make verify` before every commit
Testsuite ausführen:
pytest
API-Referenz
Parser-Klassen
| Klasse | Format | Import |
|---|---|---|
CamtParser |
CAMT.053 (ISO 20022) | from bankstatementparser import CamtParser |
Pain001Parser |
PAIN.001 (ISO 20022) | from bankstatementparser import Pain001Parser |
CsvStatementParser |
CSV | from bankstatementparser import CsvStatementParser |
OfxParser |
OFX | from bankstatementparser import OfxParser |
QfxParser |
QFX | from bankstatementparser import QfxParser |
Mt940Parser |
MT940 | from bankstatementparser import Mt940Parser |
smart_ingest() |
PDF (hybride Pipeline) | from bankstatementparser.hybrid import smart_ingest |
Hilfsfunktionen
| Funktion | Zweck |
|---|---|
detect_statement_format(path) |
Dateiformat automatisch erkennen |
create_parser(path, fmt) |
Passenden Parser erstellen |
parse_files_parallel(paths) |
Mehrere Dateien gleichzeitig parsen |
iter_secure_xml_entries(zip_path) |
ZIP-Einträge sicher iterieren |
smart_ingest(path) |
Hybride PDF-Extraktion mit Verifizierung |
scan_and_ingest(dir, pattern) |
Massenverarbeitung von Verzeichnissen |
verify_balance_multi_currency(txns) |
Saldoprüfung pro Währung |
to_hledger(txns, account) |
Export im hledger-Journalformat |
to_beancount(txns, account) |
Export im beancount-Journalformat |
Datenklassen
| Klasse | Zweck |
|---|---|
Deduplicator |
Doppelte Transaktionen erkennen |
DeduplicationResult |
Ergebnis mit eindeutigen, exakten und vermuteten Übereinstimmungen |
InputValidator |
Dateipfade und Formate validieren |
Transaction |
Normalisierter Transaktionsdatensatz |
FileResult |
Ergebnis der parallelen Verarbeitung |
ZipXMLSource |
ZIP-Member-Wrapper |
IngestResult |
Ergebnis der hybriden Pipeline mit Verifizierung |
VerificationResult |
Ergebnis der Saldoprüfung |
Categorizer |
LLM-gestützte Transaktionskategorisierung |
AccountMapper |
Regex-basierte Kontenzuordnungsregeln |
Ausnahmen
| Ausnahme | Wird ausgelöst bei |
|---|---|
ParserError |
Parsing-Fehlern |
ExportError |
Export-Fehlern (CSV/JSON/Excel) |
ValidationError |
Eingabevalidierungsfehlern |
ZipSecurityError |
ZIP-Sicherheitsprüfungsfehlern |