Read-only broker-aligned market context
Connect Lumiere to IBKR Paper TWS without giving it order authority.
The Lumiere Local Connector runs on your Mac beside IBKR Paper TWS or Paper Gateway. It can supply quotes, chart bars, daily volume, and health status to a pre-trade review. Version 0.1.0-beta.1 does not transmit customer paper or live orders and does not store broker credentials.
Direct answer
What does the Lumiere Local Connector do?
It is a local, entitlement-gated bridge from an IBKR Paper TWS or Paper Gateway socket to Lumiere's review workflow. The connector checks the local socket, completes the API handshake, requests market context, and reports source and health state. It does not need broker credentials, balances, positions, orders, or order permissions to perform its V1 job.
Compare connector fit: who should use it—and who should not?
Good fit
Paper TWS context matters
You already use IBKR Paper TWS or Paper Gateway on a Mac and want broker-aligned quote, chart, daily-bar, volume, freshness, and connection labels inside the Lumiere review.
Hosted-only fit
You do not need broker context
Use the hosted review without the connector when Polygon or public fallback context is sufficient. Mentor Pro does not require a local IBKR connection.
Not supported
You want order automation
Do not use this beta as an execution bridge. Customer paper orders, live orders, autonomous trading, broker custody, and multi-broker routing are outside the V1 connector.
Stop condition
The session is not clearly Paper
Stop before connecting if TWS or Gateway does not clearly identify the intended simulated session. A port number alone does not prove which account is open.
The read-only contract in one view
127.0.0.1:4182.That every local network, firewall, Python, or TWS configuration will work.Mac-first beta setup
- Confirm the Paper session.Open IBKR Paper TWS or Paper Gateway and verify the visible simulated-account state before changing API settings.
- Download the versioned artifact.Sign in with an eligible Local IBKR Beta or Educator entitlement and download connector version 0.1.0-beta.1 from the account page.
- Prepare the local runtime.The current beta uses a shell starter, Node.js for the Lumiere server, and Python 3 with pip for the isolated IBKR worker. It is not yet a signed macOS app.
- Enable only the socket access needed.Enable ActiveX and Socket Clients, keep Read-Only API on, and allow localhost connections only.
- Match the configured port.The connector defaults to
IBKR_PORT=7497for Paper TWS. IBKR documents 4002 as the Paper Gateway default; either value can be changed, but the connector and broker host must match. - Verify health in layers.Start the connector, open
http://127.0.0.1:4182/health, then confirm socket, worker, handshake, and market-data readiness before relying on the IBKR source label.
Configuration source reviewed August 4, 2026: IBKR Campus: Installing & Configuring TWS for the API. IBKR documents the socket-client control, Read-Only setting, TWS defaults 7496/7497, Gateway defaults 4001/4002, and the requirement that the client and host ports match.
Paper-environment source reviewed August 4, 2026: IBKR Campus: Paper Trading Account. IBKR identifies paper trading as simulated and documents data, fill, order-type, and account-configuration limitations.
Market-data source reviewed August 4, 2026: IBKR TWS API: Delayed market data. IBKR describes delayed mode as 15–20 minutes delayed when available; market-data permissions and supported request types still apply.
What the four health layers mean
- Socket
- The configured localhost port is listening. This does not prove the intended Paper account, a completed API handshake, or usable market data.
- Worker
- The isolated Python service is reachable on the local health endpoint. The web interface remains separate so a broker API delay cannot freeze the hosted review.
- Handshake
- The worker completed the IBKR API handshake. A handshake does not grant missing market-data subscriptions or make delayed data realtime.
- Market data
- The worker returned the quote, chart, and daily-bar set Lumiere expects. IBKR describes delayed mode as 15–20 minutes delayed when available. If the set is incomplete, Lumiere preserves the limitation or fallback label instead of claiming IBKR readiness.
For error 502, upgrade regressions, codes 1100–1102 and 1300, market-data permissions, and sensitive-log handling, use the source-backed Paper TWS setup and troubleshooting guide.
Local IBKR Beta
Request the versioned read-only connector.
Sign-in confirms eligibility; it does not place an order or connect a broker session by itself.