py-ibkr

A modern, Pydantic-based parser for Interactive Brokers (IBKR) Flex Query reports. This version replaces the legacy ibflex library with strict type checking and improved support for newer IBKR XML fields.

Features

• Pydantic Models: All data is parsed into typed Pydantic models with validation.
• Robust Parsing: Handles "messy" IBKR data (e.g., legacy enums like Deposits/Withdrawals, inconsistent date formats).
• Forward Compatible: Designed to handle new fields gracefully.

Installation

uv pip install py-ibkr
# or
pip install py-ibkr

Command Line Interface

py-ibkr includes a CLI for downloading Flex Queries, built on treaty so scripts and AI agents get a stable contract.

export PY_IBKR_TOKEN=your_token        # or --token-from-file PATH / --token-from-env VAR
export PY_IBKR_QUERY_ID=your_query_id  # or -q / --query-id, or query_id in .py-ibkr.toml

# Download the query's default period
py-ibkr download -o report.xml

# Download a date range (YYYY-MM-DD or YYYYMMDD)
py-ibkr download -o jan.xml --from-date 2026-01-01 --to-date 2026-01-31

• Output: the report is written to -o/--output; stdout carries a JSON envelope (plain text at a terminal) with the path, size, and the date range actually requested. --format id prints only the path
• Dates: IBKR accepts weekdays only and has no data for today, so weekend ends move inward and a to-date of today or later is capped at yesterday, each with a warning in the envelope
• Secrets: the token is never accepted on the command line and is redacted from all output
• Exit codes: 2 invalid arguments or settings (nothing was sent), 4 missing query ID or output directory, 10 IBKR stopped responding (--request-timeout), 11 rate limited, 79 token or query rejected, 80 locked out after failed attempts, 81 report still generating after --max-retries, 82 other IBKR errors
• Discovery: py-ibkr manifest and py-ibkr download --schema describe every flag, output field, and exit code; -v/--verbose becomes --verbose, -vv becomes --debug

Setup: Obtaining your Token and Query ID

To use the automated downloader, you must enable the Flex Web Service in your Interactive Brokers account:

1. Log in to the IBKR Client Portal.
2. Navigate to Performance & Reports > Flex Queries.
3. Obtain Token: Click the gear icon or Flex Web Service Configuration. Enable the service and copy the Current Token.
4. Obtain Query ID: Create a new Flex Query (e.g., Activity). After saving it, the Query ID will be visible in the list of your Flex Queries.

Usage

Downloading a Flex Query Report

You can automatically download reports using the FlexClient. This requires a Token and Query ID from the IBKR Client Portal.

from py_ibkr import FlexClient, parse

# 1. Initialize the client
client = FlexClient()

# 2. Download the report (handles the request-poll-fetch protocol)
xml_data = client.download(
    token="YOUR_IBKR_TOKEN",
    query_id="YOUR_QUERY_ID"
)

# 3. Parse the downloaded data
response = parse(xml_data)

print(f"Query Name: {response.queryName}")

Parsing a Flex Query File

for statement in response.FlexStatements: print(f"Account: {statement.accountId}")

# Access Trades
for trade in statement.Trades:
    print(f"Symbol: {trade.symbol}, Quantity: {trade.quantity}, Price: {trade.tradePrice}")
    
# Access Cash Transactions
for cash_tx in statement.CashTransactions:
    print(f"Type: {cash_tx.type}, Amount: {cash_tx.amount}")

### Models

You can import models directly for type hinting:

```python
from py_ibkr import Trade, CashTransaction

def process_trade(trade: Trade):
    print(trade.symbol)