.env.example

# quantcortex environment template
# Copy to `.env` and fill in. NEVER commit your real `.env`.
# Direct Python CLI runs do not load this file automatically; export the values
# or run `set -a; source .env; set +a` in a trusted shell first. Docker Compose
# reads `.env` for variable interpolation.
# Providers and brokers are optional. Core tests, broker mocks, and the labeled
# paper-trading dry run work offline. Research notebooks require an explicit
# owner-supplied real-data CSV or QUANTCORTEX_LIVE_YFINANCE=1.

# --- Research data selection (choose one price source) -----------------------
# QUANTCORTEX_PRICES_CSV=/absolute/path/to/wide_adjusted_closes.csv
# QUANTCORTEX_OHLCV_CSV=/absolute/path/to/single_symbol_ohlcv.csv
# QUANTCORTEX_LIVE_YFINANCE=1

# --- Alpaca (equities; paper + live) ------------------------------------------
ALPACA_API_KEY=your_alpaca_key_here
ALPACA_SECRET_KEY=your_alpaca_secret_here
# Paper:  https://paper-api.alpaca.markets
# Live:   https://api.alpaca.markets
ALPACA_BASE_URL=https://paper-api.alpaca.markets

# --- Interactive Brokers (ib_async -> TWS / IB Gateway) ------------------------
IB_HOST=127.0.0.1
# 7497 = TWS paper, 7496 = TWS live, 4002 = Gateway paper, 4001 = Gateway live
IB_PORT=7497
IB_CLIENT_ID=1
# Required when TWS/Gateway exposes more than one account.
IB_ACCOUNT=your_ib_account_id

# --- CCXT (crypto exchanges; used by both the provider and the broker) --------
CCXT_API_KEY=your_exchange_key_here
CCXT_SECRET=your_exchange_secret_here
# Cash currency used for fail-closed account-equity reporting.
CCXT_ACCOUNT_CURRENCY=USDT

# --- Market data providers ----------------------------------------------------
POLYGON_API_KEY=your_polygon_key_here
FRED_API_KEY=your_fred_key_here
FMP_API_KEY=your_fmp_key_here

# --- Infrastructure -----------------------------------------------------------
# Required by docker-compose.yml. Replace this value before starting the stack.
POSTGRES_PASSWORD=replace_with_a_long_random_password
POSTGRES_USER=quant
POSTGRES_DB=quantcortex
# Leave blank to use the atomic local-JSON execution state backend.
REDIS_URL=
# Example TimescaleDB / PostgreSQL connection string:
# TIMESCALE_URL=postgresql://quant:your_password@localhost:5432/quantcortex
TIMESCALE_URL=

# --- Local state backend (used only when REDIS_URL is unset) ------------------
QC_STATE_PATH=./.qc_state.json