discover · compare · collections · requirements · contribute · feed · watching · stats · help with your tokens
OpenByteInc/QuantDinger · source
Snapshot 0 · 2026-11-04T12:47:28Z · Python · Apache-2.0
Content fingerprint
5962f1eb5ef34c4e0247eddc47b3b6dff02715f4887864af11864cc800594297GitHub description at capture
Open-source AI Trading OS, agent trading, and vibe trading, with Jev System One integration. Research, build Python strategies, backtest, and paper/live trade across crypto, stocks, and forex. Launch your own multi-tenant trading SaaS with built-in user management, billing, payments, and settlement.
README at capture
<div align="center">
<a href="https://github.com/OpenByteInc/QuantDinger">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="docs/screenshots/logo-dark.png">
<img src="docs/screenshots/logo.png" alt="QuantDinger logo" width="420">
</picture>
</a>
<p><strong>QuantDinger - Open-Source AI Quant Research Platform</strong></p>
<p>Turn trading ideas into Python strategies, backtests, paper trading, live execution, and monitoring — all in one self-hosted stack.</p>
<p><strong>QuantDinger is a product of Open Byte Inc.</strong></p>
<p><em>AI research → Strategy code → Backtest → Paper/Live execution → Monitoring</em></p>
<p>
<a href="README.md"><strong>English</strong></a>
·
<a href="README_CN.md"><strong>简体中文</strong></a>
·
<a href="README_TW.md"><strong>繁體中文</strong></a>
·
<a href="README_JA.md"><strong>日本語</strong></a>
·
<a href="README_KO.md"><strong>한국어</strong></a>
·
<a href="README_DE.md"><strong>Deutsch</strong></a>
·
<a href="README_FR.md"><strong>Français</strong></a>
·
<a href="README_RU.md"><strong>Русский</strong></a>
·
<a href="README_AR.md"><strong>العربية</strong></a>
·
<a href="README_TH.md"><strong>ไทย</strong></a>
·
<a href="README_VI.md"><strong>Tiếng Việt</strong></a>
</p>
<p>
<a href="docs/api/README.md"><strong>API</strong></a>
·
<a href="docs/agent/README.md"><strong>AI Agents & MCP</strong></a>
</p>
<p>
<a href="https://ai.quantdinger.com"><strong>Live App</strong></a>
·
<a href="https://www.quantdinger.com"><strong>Website</strong></a>
·
<a href="https://aws.amazon.com/marketplace/pp/prodview-ywy4zb5wnsari"><strong>Deploy on AWS Marketplace</strong></a>
·
<a href="#watch-quantdinger-in-action"><strong>Video Demo</strong></a>
·
<a href="mailto:support@quantdinger.com"><strong>Official Support Email</strong></a>
</p>
<p>
<a href="https://t.me/quantdinger"><img src="https://img.shields.io/badge/Telegram-Join-26A5E4?style=flat-square&logo=telegram&logoColor=white" alt="Telegram"></a>
<a href="https://discord.com/invite/tyx5B6TChr"><img src="https://img.shields.io/badge/Discord-Server-5865F2?style=flat-square&logo=discord&logoColor=white" alt="Discord"></a>
<a href="https://youtube.com/@quantdinger"><img src="https://img.shields.io/badge/YouTube-%40quantdinger-FF0000?style=flat-square&logo=youtube&logoColor=white" alt="YouTube"></a>
<a href="https://x.com/QuantDinger_EN"><img src="docs/badges/x-quantdinger.svg" alt="X @QuantDinger_EN"></a>
</p>
<p>
<a href="LICENSE"><img src="https://img.shields.io/badge/License-Apache%202.0-blue.svg?style=flat-square" alt="Apache 2.0"></a>
<a href="https://codecov.io/gh/OpenByteInc/QuantDinger"><img src="https://codecov.io/gh/OpenByteInc/QuantDinger/branch/main/graph/badge.svg" alt="Codecov"></a>
<a href="https://scorecard.dev/viewer/?uri=github.com/OpenByteInc/QuantDinger"><img src="https://api.scorecard.dev/projects/github.com/OpenByteInc/QuantDinger/badge" alt="OpenSSF Scorecard"></a>
<a href="https://www.bestpractices.dev/projects/15860"><img src="https://www.bestpractices.dev/projects/15860/baseline" alt="OpenSSF Baseline"></a>
<a href="https://www.bestpractices.dev/projects/15860"><img src="https://www.bestpractices.dev/projects/15860/badge" alt="OpenSSF Best Practices"></a>
<a href="https://sonarcloud.io/summary/new_code?id=OpenByteInc_QuantDinger"><img src="https://sonarcloud.io/api/project_badges/measure?project=OpenByteInc_QuantDinger&metric=alert_status" alt="SonarQube Cloud Quality Gate"></a>
<a href="https://api.reuse.software/info/github.com/OpenByteInc/QuantDinger"><img src="https://api.reuse.software/badge/github.com/OpenByteInc/QuantDinger" alt="REUSE status"></a>
<a href="docs/compliance/OPENCHAIN_ISO_5230_SELF_ASSESSMENT.md" title="Open Byte Inc. OpenChain ISO/IEC 5230 conformant program"><img src="https://img.shields.io/badge/OpenChain_ISO%2FIEC_5230-conformant-0B6B53?style=flat-square" alt="OpenChain ISO/IEC 5230 conformant"></a>
<a href="docs/compliance/OPENCHAIN_ISO_18974_SELF_ASSESSMENT.md" title="Open Byte Inc. OpenChain ISO/IEC 18974 conformant program"><img src="https://img.shields.io/badge/OpenChain_ISO%2FIEC_18974-conformant-0B6B53?style=flat-square" alt="OpenChain ISO/IEC 18974 conformant"></a>
<img src="docs/badges/python-3.12.svg" alt="Python 3.12">
<img src="https://img.shields.io/badge/PostgreSQL-18-4169E1?style=flat-square&logo=postgresql&logoColor=white" alt="PostgreSQL 18">
<img src="https://img.shields.io/badge/Redis-8-DC382D?style=flat-square&logo=redis&logoColor=white" alt="Redis 8">
<a href="#jev-powered-pre-trade-decisions"><img src="https://img.shields.io/badge/JEV-Pre--trade%20Decisions-7C3AED?style=flat-square" alt="JEV pre-trade decisions"></a>
<img src="docs/badges/docker-compose.svg" alt="Docker Compose">
<a href="https://github.com/OpenByteInc/QuantDinger/releases/latest"><img src="docs/badges/latest-release.svg" alt="Latest release"></a>
</p>
<p>
<a href="https://github.com/orgs/OpenByteInc/projects/1"><img src="https://img.shields.io/github/issues/OpenByteInc/QuantDinger/roadmap?style=flat-square&label=Roadmap%20items&color=5319E7" alt="Open roadmap items"></a>
<a href="https://github.com/orgs/OpenByteInc/projects/1/views/4"><img src="https://img.shields.io/github/issues/OpenByteInc/QuantDinger/ready%20for%20contributors?style=flat-square&label=Ready%20tasks&color=0E8A16" alt="Tasks ready for contributors"></a>
</p>
<p><sub>SUPPORTED BY</sub></p>
<p>
<a href="https://www.atlascloud.ai/?utm_source=github&utm_medium=link&utm_campaign=quantdinger" title="Atlas Cloud — AI inference sponsor">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://www.atlascloud.ai/logo-white.svg">
<img src="https://www.atlascloud.ai/logo.svg" alt="Atlas Cloud" width="134" align="middle">
</picture>
</a>
<a href="https://aws.amazon.com/marketplace/pp/prodview-ywy4zb5wnsari" title="Deploy QuantDinger on AWS Marketplace">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://a0.awsstatic.com/libra-css/images/logos/aws_smile-header-desktop-en-white_59x35.png">
<img src="https://upload.wikimedia.org/wikipedia/commons/9/93/Amazon_Web_Services_Logo.svg" alt="Amazon Web Services" width="54" align="middle">
</picture>
</a>
<a href="https://openai.com/" title="OpenAI — open-source development tooling support">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="docs/badges/openai-wordmark-white.svg">
<img src="docs/badges/openai-wordmark-black.svg" alt="OpenAI" width="150" align="middle">
</picture>
</a>
</p>
<p>
<a href="https://www.nvidia.com/en-us/startups/" title="Open Byte Inc. has joined NVIDIA Inception">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="docs/badges/nvidia-inception-member-dark.png">
<img src="docs/badges/nvidia-inception-member.png" alt="NVIDIA Inception Program" width="64" align="middle">
</picture>
</a>
<strong>Open Byte Inc. has joined NVIDIA Inception.</strong>
</p>
</div>
> **Want to contribute?** Explore the
> [public roadmap](https://github.com/orgs/OpenByteInc/projects/1) or claim a
> scoped task from [Ready for contributors](https://github.com/orgs/OpenByteInc/projects/1/views/4).
> QuantDinger can submit real orders when live trading is explicitly enabled.
> Start with paper trading, use restricted API keys, and review the risk and
> compliance requirements for your jurisdiction. This project does not provide
> investment advice.
## Watch QuantDinger in action
<p align="center">
<a href="https://youtu.be/y9EiCZSaIt0">
<img src="docs/screenshots/quantdinger-youtube-overview.png" alt="Watch the latest QuantDinger overview on YouTube" width="800">
</a>
<br>
<strong><a href="https://youtu.be/y9EiCZSaIt0">▶ Watch the latest QuantDinger product tour on YouTube</a></strong>
</p>
## What QuantDinger is
QuantDinger is an **open-source AI Trading OS** for independent traders, Python
strategy authors, and small teams. Its local-first, self-hosted design keeps
market data, strategy code, broker credentials, and deployment under the
operator's control.
The project combines:
- multi-provider AI market research and analysis;
- Python indicators and Strategy API V2 development;
- server-side backtesting and experiment workflows;
- paper and live execution across crypto exchanges and traditional brokers;
- web, mobile H5, human API, Agent Gateway, and MCP access;
- PostgreSQL-backed state, durable workers, audit logs, and optional monitoring.
It is not a black-box signal service. Strategy code, risk settings, credentials,
and deployment remain under the operator's control.
### Strategy evolution and signal-only virtual accounts
- **Factor Lab** loads one point-in-time universe panel once and benchmarks up
to 40 registered technical, fundamental, TA-Lib, or Qlib factors. It uses a
time-ordered holdout, out-of-sample IC retention, Benjamini-Hochberg
false-discovery control, cost-aware scoring, factor-life-cycle labels, and
cross-factor IC correlation. The same workflow is available from the web UI,
Human API, Agent Gateway, and MCP.
- **Strategy evolution** searches declared tunable parameters with random,
grid, or TPE optimization, using bar-count walk-forward validation and a final
blind holdout. Jobs run asynchronously with per-strategy history, automatic
pruning, composite scoring, PBO, Deflated Sharpe, block-bootstrap Monte Carlo,
and transaction-cost stress tests. Results compare parameter robustness; they
do not forecast future returns.
- **Signal-only virtual accounts** turn notification-mode signals into internal
virtual orders, fills, positions, trade records, PnL, and an equity curve. They
never connect to a broker or submit live orders. Each fill uses a fixed 0.05%
commission on executed notional and 0.05% adverse slippage; leverage is not
charged a second time in the commission calculation.
## What changed in v5
The v5 backend is organized around explicit runtime and operational boundaries:
- the HTTP API no longer owns long-running trading or scheduler loops;
- trading, scheduling, Celery jobs, and migrations run as separate processes;
- Celery handles finite, retryable work while long-lived strategy runtimes stay
in the trading worker;
- cache Redis and durable job Redis use separate instances and eviction policies;
- high-risk API contracts are represented in OpenAPI and protected by tests;
- JSON logs, request IDs, Prometheus metrics, dashboards, and alert rules are
available through an optional observability overlay;
- the production overlay runs backend processes as a non-root user with a
read-only root filesystem, dropped capabilities, and resource limits;
- CI checks syntax, lint, tests, release gates, Compose files, dependencies,
source security, secrets, API compatibility, version drift, and text encoding.
The source version is declared in [`VERSION`](VERSION). Git release tags use the
same semantic version with a leading `v`, for example `v5.0.1`.
## Architecture
<p align="center">
<img src="docs/screenshots/architecture-v5.png" alt="QuantDinger v5 architecture covering clients, Agent Gateway, core platform, distributed runtime workers, Kafka, infrastructure, observability, and the closed-loop trading workflow" width="100%">
</p>
<p align="center"><sub>The editable source is <a href="docs/screenshots/architecture-v5.svg">architecture-v5.svg</a>; the Mermaid topology below is the detailed runtime source of truth.</sub></p>
The static diagram above is the product-level view. The runtime topology below
is the current source of truth for container ownership and event/data flow.
```mermaid
flowchart TB
C["Web / Mobile / API / MCP clients"]
FE["Nginx frontend services"]
API["Flask + Gunicorn API"]
PG[("PostgreSQL")]
CACHE[("Redis cache")]
JOBS[("Redis jobs")]
KAFKA[("Kafka event backbone")]
TW["Trading workers\ncontrol, realtime, execution, grid actors"]
DISPATCH["Strategy dispatcher workers"]
EVAL["Strategy evaluator workers\nhot bar runtimes"]
AUDIT["Kafka audit worker"]
SW["Scheduler worker"]
CW["Celery worker"]
BEAT["Celery beat"]
PROM["Prometheus"]
GRAF["Grafana"]
ALERT["Alertmanager"]
C --> FE --> API
API --> PG
API --> CACHE
API -->|"durable commands"| PG
TW -->|"leases, order intents, fills, grid actor state"| PG
TW -->|"closed bars and lifecycle events"| KAFKA
KAFKA --> DISPATCH --> KAFKA
KAFKA --> EVAL
EVAL -->|"inbox, leases, checkpoints, order intents"| PG
KAFKA --> AUDIT --> PG
PG -->|"owned pending orders"| TW
SW -->|"schedules, monitoring, heartbeats"| PG
API -->|"finite async jobs"| JOBS
BEAT --> JOBS --> CW
CW --> PG
API -. metrics .-> PROM
PG -. exporter .-> PROM
CACHE -. exporter .-> PROM
JOBS -. exporter .-> PROM
PROM --> GRAF
PROM --> ALERT
```
One backend image is reused by several containers with different commands:
| Process | Responsibility |
| --- | --- |
| `migration` | Applies the database schema and exits before application services start. |
| `kafka-init` | Creates the versioned runtime topics and exits before event consumers start. |
| `backend` | Handles HTTP, authentication, validation, and durable command submission. |
| `trading-worker` | Owns control/realtime runtimes, exchange sessions, the fenced order gateway, reconciliation, and durable grid actors. |
| `strategy-dispatcher-worker` | Converts closed-bar events into stable strategy-shard evaluation batches. |
| `strategy-evaluator-worker` | Owns hot distributed bar runtimes and evaluates fenced strategy inbox events. |
| `kafka-audit-worker` | Validates and records the versioned event stream independently of execution. |
| `scheduler-worker` | Runs portfolio, deployment, payment, and signal schedules. |
| `celery-worker` | Executes finite AI, backtest, experiment, report, and maintenance jobs. |
| `celery-beat` | Dispatches periodic Celery tasks. |
See [Backend process roles](docs/architecture/PROCESS_ROLES_AND_TASKS.md),
[architecture](docs/architecture/ARCHITECTURE.md), and
[concurrency model](docs/architecture/CONCURRENCY_MODEL.md) for the ownership rules.
Use the [distributed runtime deployment and scaling guide](docs/deployment/DISTRIBUTED_RUNTIME_SCALING.md)
before changing replica counts or moving the stack to multiple hosts.
## Quick start
If you are unsure whether to choose Windows, Linux/macOS, a cloud server, SaaS,
or a mobile client, start with the
[installation and deployment overview](docs/getting-started/INSTALLATION.md).
Each path covers installation, verification, upgrades, post-install setup, and troubleshooting.
### Fastest cloud deployment: AWS Marketplace
<p align="center">
<a href="https://aws.amazon.com/marketplace/pp/prodview-ywy4zb5wnsari"><img src="https://img.shields.io/badge/AWS%20Marketplace-Deploy%20QuantDinger-FF9900?style=for-the-badge&logo=amazonaws&logoColor=white" alt="Deploy QuantDinger from AWS Marketplace"></a>
</p>
Launch the free QuantDinger software from its public
[AWS Marketplace product page](https://aws.amazon.com/marketplace/pp/prodview-ywy4zb5wnsari).
The Marketplace delivery option provisions the single-node container stack and
its required AWS infrastructure through CloudFormation. QuantDinger has no
software fee; normal AWS infrastructure charges still apply. See the
[deployment and upgrade guide](docs/deployment/AWS_MARKETPLACE_DEPLOYMENT.md)
for first login, backups, upgrades, rollback, and cost notes.
### Option A: prebuilt images
Prerequisites: Docker with Compose v2. Node.js and a local Python environment are
not required.
Linux or macOS:
```bash
curl -fsSL https://raw.githubusercontent.com/OpenByteInc/QuantDinger/main/install.sh | bash
```
Windows PowerShell:
```powershell
irm https://raw.githubusercontent.com/OpenByteInc/QuantDinger/main/install.ps1 | iex
```
The installer asks for the initial administrator credentials, generates the
required secrets, downloads the GHCR Compose stack, and starts it.
Open:
- Web: <http://127.0.0.1:8888>
- Mobile H5: <http://127.0.0.1:8889>
- API health: <http://127.0.0.1:5000/api/health>
### Docker administrator and settings notes
Detailed guides: [English](docs/deployment/ADMIN_AND_SETTINGS_TROUBLESHOOTING_EN.md) |
[中文](docs/deployment/ADMIN_AND_SETTINGS_TROUBLESHOOTING_CN.md)
On a fresh database, the backend creates the initial administrator from
`ADMIN_USER`, `ADMIN_PASSWORD`, and optional `ADMIN_EMAIL`. Passwords are stored
as hashes, never as plaintext. An existing PostgreSQL volume is not overwritten:
the backend only replaces the untouched legacy `quantdinger` / `123456`
administrator when a non-default administrator is explicitly configured. It
never overwrites an account whose password was already changed, and it refuses
to promote an existing account that already uses the requested username.
Manual Docker deployments retain `quantdinger` / `123456` only for backward
compatibility when the administrator variables are left at their defaults. This
credential is not suitable for an internet-facing deployment; change it before
first start or immediately after the first login. The one-command installer does
not accept `123456` as the chosen password.
The Settings UI writes runtime configuration to `/app/.env`, which is the
project-root `.env` on the host for both GHCR and source deployments. Current backend images automatically give runtime UID
`10001` ownership and keep mode `600`. Do not use `chmod 755` or recursive `777`:
these files contain passwords and API keys, and `755` still does not grant write
access to UID `10001` when root owns the file.
Verify write access with:
```bash
docker compose exec -u 10001:10001 -T backend \
sh -c 'test -w /app/.env && echo writable=yes || echo writable=no'
```
The hardened production override intentionally mounts `/app/.env` read-only.
When using `docker-compose.production.yml`, manage configuration on the host and
recreate the services instead of saving it from the Settings UI. See the
[English guide](docs/deployment/ADMIN_AND_SETTINGS_TROUBLESHOOTING_EN.md) or
[中文指南](docs/deployment/ADMIN_AND_SETTINGS_TROUBLESHOOTING_CN.md) for
legacy-image recovery and rootless/NFS notes.
### Option B: source checkout
```bash
git clone https://github.com/OpenByteInc/QuantDinger.git
cd QuantDinger
python scripts/bootstrap_env.py
```
Before the first start, review the unified environment file. The bootstrap command
already generates the PostgreSQL, session-signing, and credential-encryption
secrets; set the administrator credentials and review any production-only
integrations:
| File | Required production values |
| --- | --- |
| `.env` | Administrator credentials; optional Redis and Grafana credentials; deployment-specific URLs and integrations |
After pulling an update, initialize the unified environment before running any
Compose command. This one-time step is required when upgrading from releases
that relied on the former built-in PostgreSQL password:
```bash
git pull --ff-only
python3 scripts/bootstrap_env.py
docker compose up -d --build
```
The bootstrap command preserves existing credentials and can recover the former
PostgreSQL password from a legacy `DATABASE_URL` or the existing database
container. If it detects an existing data volume but cannot recover the password,
it stops instead of disconnecting the database. Do not invent a replacement
password and do not delete the volume.
After bootstrap, Compose runs the one-shot `env-sync` service before database and
Kafka initialization. It appends newly introduced settings, imports missing
values from legacy backend environment files, preserves existing values and
comments, and creates a timestamped backup only when the unified file changes.
The command below remains available for a manual preview or maintenance run:
```bash
python scripts/sync_env.py --env-file .env --template .env.example --backup
```
For a manual one-time migration from older releases, add
`--legacy backend_api_python/.env` (source deployment) or `--legacy backend.env`
(old GHCR deployment). The old file is not deleted.
The bootstrap command creates `.env`, preserves existing values during upgrades,
and generates independent PostgreSQL, session, and credential-encryption secrets.
To generate another independent secret manually:
```bash
python -c "import secrets; print(secrets.token_hex(32))"
```
Start the core stack from local backend source:
```bash
docker compose up -d --build
docker compose ps
```
The base stack does not start Prometheus, Grafana, or Alertmanager. This keeps
the default open-source installation smaller.
For complete platform instructions, see [Windows](docs/deployment/WINDOWS_INSTALLATION.md),
[Linux and macOS](docs/deployment/LINUX_MACOS_INSTALLATION.md),
[cloud](docs/deployment/CLOUD_DEPLOYMENT_EN.md),
[SaaS](docs/deployment/SAAS_DEPLOYMENT.md), and
[mobile client deployment](docs/deployment/MOBILE_CLIENT_DEPLOYMENT.md). Continue with
[post-installation setup](docs/getting-started/POST_INSTALL_SETUP.md); use the
[installation FAQ](docs/deployment/INSTALLATION_FAQ.md) and
[installation troubleshooting](docs/deployment/INSTALL_TROUBLESHOOTING.md) when needed.
After the first login, follow the
[30-minute quickstart](docs/getting-started/QUICKSTART_30_MINUTES.md) to configure
the core system and produce a first research result and backtest. Production
administrators should also read the
[configuration reference](docs/deployment/CONFIGURATION_REFERENCE.md),
[backup, restore, and migration guide](docs/deployment/BACKUP_RESTORE_MIGRATION.md),
and [upgrade and rollback guide](docs/deployment/UPGRADE_ROLLBACK.md).
For the free AWS Marketplace single-node delivery option, including first
launch, upgrades, backup, rollback, and cost notes, see the
[AWS Marketplace deployment guide](docs/deployment/AWS_MARKETPLACE_DEPLOYMENT.md).
## Production deployment
Validate secrets before starting a production stack:
```bash
python backend_api_python/scripts/check_production_config.py \
--env-file .env
```
Start the hardened runtime with optional observability:
```bash
docker compose \
-f docker-compose.yml \
-f docker-compose.production.yml \
-f docker-compose.observability.yml \
up -d --build
```
Omit `docker-compose.observability.yml` when the host is resource-constrained or
monitoring is provided externally.
Production rules:
- expose only a TLS reverse proxy on ports 80/443;
- keep PostgreSQL, both Redis instances, Prometheus, Grafana, and Alertmanager
off the public internet;
- do not deploy with example passwords or empty encryption keys;
- back up PostgreSQL and the durable `redis-jobs` volume;
- keep cache Redis disposable and never use it as the Celery broker;
- review worker health and application readiness after every deployment.
The full checklist is in [Production hardening](docs/deployment/PRODUCTION_HARDENING.md).
## Local endpoints
All published ports bind to loopback by default.
| Service | Default URL | Purpose |
| --- | --- | --- |
| Web | <http://127.0.0.1:8888> | Desktop web client and same-origin API proxy. |
| Mobile H5 | <http://127.0.0.1:8889> | Mobile web client and same-origin API proxy. |
| Backend | <http://127.0.0.1:5000> | Direct API access and health endpoints. |
| Grafana | <http://127.0.0.1:3000> | Dashboards; available only with the observability overlay. |
| Prometheus | <http://127.0.0.1:9090> | Metrics storage and queries; optional. |
| Alertmanager | <http://127.0.0.1:9093> | Alert grouping, silencing, and delivery; optional. |
Container-only ports such as the job Redis and exporters are not published to
the host.
## Observability
The monitoring stack is optional by design:
- **Prometheus** collects API, worker, PostgreSQL, and Redis metrics.
- **Grafana** turns those metrics into operator dashboards.
- **Alertmanager** groups alerts, manages silences, and sends notifications once
a receiver is configured.
Start it for local diagnostics without the production overlay:
```bash
docker compose \
-f docker-compose.yml \
-f docker-compose.observability.yml \
up -d
```
Monitoring services stay on `127.0.0.1`. Use a VPN, SSH tunnel, or authenticated
reverse proxy for remote administration. See
[Observability](docs/deployment/OBSERVABILITY.md) for dashboards, alerts, retention, and
receiver configuration.
## Security model
- Broker credentials and MFA secrets are encrypted with a stable
`CREDENTIAL_ENCRYPTION_KEY`.
- Agent tokens are hashed, scoped, rate-limited, and audit-logged.
- Agent trading is paper-only by default; live access requires both token and
server-side authorization.
- Long-running strategy ownership uses leases, heartbeats, and fencing tokens.
- Production containers run without root privileges or Linux capabilities.
- Host port defaults are loopback-only; public access should terminate at a TLS
reverse proxy.
Report vulnerabilities privately according to [SECURITY.md](SECURITY.md). Do
not include credentials, account data, or exploitable details in public issues.
## Strategy and integration surfaces
| Area | Current surface |
| --- | --- |
| Indicators | Python chart overlays, markers, bands, and signals. |
| Strategies | Strategy API V2 intents, sizing, risk, backtests, and live runtime. |
| Crypto | Binance, OKX, Bitget, Bybit, Gate, HTX, and adapter extensions. |
| Traditional brokers | IBKR and Alpaca workflows. |
| AI providers | OpenRouter, OpenAI-compatible APIs, Google, DeepSeek, Grok, MiniMax, and custom endpoints. |
| Automation | Human API, Agent Gateway, MCP server, Celery jobs, schedules, and notifications. |
Start with the [Indicator guide](docs/trading/INDICATOR_DEV_GUIDE.md),
[Strategy guide](docs/trading/STRATEGY_DEV_GUIDE.md), and
[Extension guide](docs/architecture/EXTENSION_GUIDE.md).
## JEV-powered pre-trade decisions
QuantDinger can place a structured AI decision gate directly in front of live
entry orders. Enable **AI Decision Filter** when creating a regular live
strategy. Before a strategy entry reaches the exchange,
QuantDinger sends the order, strategy context, exposure, positions, and budget
state to [TypeSafe Jev](https://docs.typesafe.ai/introduction). Jev returns typed
Choice results, probabilities, and confidence instead of prose that must be
parsed. The app shows the provider, checks, result, confidence, latency, and
reason in an auditable decision timeline.
| Previous LLM-only gate | JEV decision gate |
| --- | --- |
| Generate prose or JSON and recover a decision through parsing | Receive a typed Choice with the selected outcome, full probabilities, and confidence |
| One opaque answer is difficult to inspect after execution | Independent entry and risk checks are stored with the order context and latency |
| Provider failure can accidentally block position management | Provider failure is audited and fails open, while every exit bypasses AI |
The execution policy stays in QuantDinger code: rejected entries never reach
the exchange; exits, stop-loss, take-profit, and emergency actions bypass the
filter. Grid, DCA, and martingale runtimes are excluded from this first version.
When Jev is not configured, QuantDinger tries the configured LLM. If no AI
provider is available, the order is allowed and the fail-open result is logged,
so an AI outage cannot trap an existing position.
### Decision flow
```mermaid
flowchart TD
A["Strategy entry signal"] --> B["Deterministic risk and order budget checks"]
B -->|"Basic checks fail"| R["Reject order"]
B -->|"Basic checks pass"| C["Build Decision Context V2"]
C --> C1["Strategy parameters and signal rationale"]
C --> C2["Multi-timeframe market data and indicators"]
C --> C3["Positions, exposure, equity, and drawdown"]
C --> C4["Recent PnL and consecutive losses"]
C --> C5["Take-profit, stop-loss, and execution conditions"]
C1 --> D
C2 --> D
C3 --> D
C4 --> D
C5 --> D
D{"JEV configured?"}
D -->|"Yes"| E["JEV System One"]
E --> E1["Evidence quality"]
E --> E2["Signal consistency"]
E --> E3["Market regime"]
E --> E4["Account risk"]
E --> E5["Execution quality"]
E --> E6["Entry decision: pass/reject"]
E1 --> F["Validate schema, probabilities, and confidence"]
E2 --> F
E3 --> F
E4 --> F
E5 --> F
E6 --> F
F -->|"Valid result and confidence threshold met"| G["Deterministic decision converger"]
F -->|"Timeout, error, invalid format, or low confidence"| H
D -->|"No"| H{"LLM configured?"}
H -->|"Yes"| I["LLM reads the same context"]
I --> J["Require strict JSON output"]
J --> K{"decision"}
H -->|"No"| O["Fail open and log the reason"]
G -->|"PASS"| P["Enter pending order queue"]
G -->|"REJECT"| R
K -->|"pass"| P
K -->|"reject"| R
K -->|"Invalid output or provider failure"| O
P --> Q["Submit to exchange asynchronously"]
R --> S["Record ai_rejected and the decision trace"]
O --> T["Place order normally and record provider unavailable"]
```
Configure `JEV_API_KEY`, `JEV_BASE_URL`, `JEV_MODEL`, and
`JEV_TIMEOUT_SECONDS` in **System Settings → AI / LLM**. TypeSafe documents the
HTTP contract at [`POST /v1/systemone`](https://docs.typesafe.ai/introduction/quickstart).
## AI agents and MCP
The Agent Gateway is exposed under `/api/agent/v1`. The included MCP server lets
clients such as Cursor, Claude Code, and Codex call approved tools without
receiving broker credentials or administrator JWTs.
Live trading through an agent requires all of the following:
1. a token with trading scope;
2. `paper_only=false` on that token;
3. `AGENT_LIVE_TRADING_ENABLED=true` on the server;
4. operator-configured limits and allowlists.
See [MCP setup](docs/agent/MCP_SETUP.md),
[Agent quick start](docs/agent/AGENT_QUICKSTART.md), and the
[Agent OpenAPI document](docs/agent/agent-openapi.json).
## Development
Backend development uses Python 3.12:
```bash
cd backend_api_python
python -m venv .venv
python -m pip install -r requirements-dev.txt
python -m pytest -m "not integration and not stress" --ignore=tests/release_gate -q
ruff check app scripts tests
```
Useful repository checks:
```bash
python scripts/check_version.py
python scripts/check_mojibake.py
docker compose -f docker-compose.yml config -q
docker compose -f docker-compose.yml -f docker-compose.production.yml -f docker-compose.observability.yml config -q
```
API changes should follow [API conventions](docs/architecture/API_CONVENTIONS.md), update the
OpenAPI artifact when required, and pass the compatibility workflow.
## Repository layout
This repository contains the backend, worker processes, deployment definitions,
operations configuration, documentation, and MCP server. The desktop and mobile
client source code live in separate repositories; this repository consumes their
published images in the Compose stacks.
```text
QuantDinger/
|-- .github/workflows/ CI, security, compatibility, and release checks
|-- backend_api_python/ Backend application and all backend processes
| |-- app/
| | |-- __init__.py Flask application factory and core wiring
| | |-- startup.py Process-aware startup hooks and service singletons
| | |-- celery_app.py Celery application and task registration
| | |-- commands/ Migration, scheduler, trading, and health entrypoints
| | |-- config/ Environment-backed database, Redis, and provider config
| | |-- routes/ Human HTTP API route facades
| | | `-- agent_v1/ Scoped Agent Gateway API under /api/agent/v1
| | |-- openapi/ OpenAPI schemas, tags, registration, and export support
| | |-- services/ Domain workflows and third-party integrations
| | | |-- backtest_engine/ Backtest execution components
| | | |-- factors/ Point-in-time factor research and diagnostics
| | | |-- strategy_evolution/ Parameter search, walk-forward validation, and robustness tests
| | | |-- pending_orders/ Queued order submission, recovery, and reconciliation
| | | |-- live_trading/ Normalized crypto exchange adapters
| | | |-- alpaca_trading/ Alpaca broker integration
| | | |-- ibkr_trading/ Interactive Brokers integration
| | | |-- strategy_runtime/ Strategy signals, intents, execution, and state
| | | |-- strategy_v2/ Versioned strategy contracts and runtime services
| | | `-- virtual_trading.py Isolated signal-mode account, positions, and fills
| | |-- data_sources/ Raw market-data source adapters
| | |-- data_providers/ Aggregated market, macro, news, and sentiment providers
| | |-- markets/ Market and symbol normalization
| | |-- tasks/ Finite, retryable Celery jobs
| | |-- workers/ Long-lived worker process shells
| | |-- runtime/ Process-role and ownership helpers
| | |-- observability/ Request context, metrics, and HTTP instrumentation
| | `-- utils/ Shared low-level database, cache, auth, and logging helpers
| |-- migrations/ PostgreSQL schema and seed migrations
| |-- scripts/ Backend maintenance and validation commands
| |-- tests/ Unit, contract, integration, and release-gate tests
| |-- run.py Local Flask and Gunicorn application entrypoint
| |-- Dockerfile Shared image for API and worker containers
| `-- docker-entrypoint.sh Container command dispatcher
|-- docs/
| |-- architecture/ Boundaries, concurrency, API, and extension design
| |-- deployment/ Installation, production, and observability operations
| |-- trading/ Strategy and indicator development guides
| |-- strategies/ Strategy authoring and validation references
| |-- api/ Human API documentation
| |-- agent/ Agent Gateway and MCP documentation
| |-- getting-started/ Onboarding and first-run guides
| |-- product/ Product workflows and feature documentation
| `-- security/ Security model and operational guidance
|-- mcp_server/ Standalone QuantDinger MCP server package
| |-- src/quantdinger_mcp/ MCP server and security implementation
| `-- tests/ MCP contract and security tests
|-- ops/ Runtime operations configuration
| |-- prometheus/ Scrape configuration and alert rules
| |-- grafana/ Provisioned data sources and dashboards
| `-- alertmanager/ Alert routing configuration
|-- scripts/ Repository-level version, encoding, and setup checks
|-- docker-compose.yml Core local/source stack
|-- docker-compose.ghcr.yml Prebuilt-image installation stack
|-- docker-compose.production.yml Production hardening overlay
|-- docker-compose.observability.yml Optional monitoring overlay
|-- install.sh / install.ps1 Linux/macOS and Windows installers
`-- VERSION Canonical source version
```
### Main execution paths
| Flow | Path through the repository |
| --- | --- |
| Synchronous API request | `app/routes` -> `app/services` -> database, cache, market-data, or trading adapter |
| Durable strategy command | API route -> PostgreSQL command record -> `trading-worker` -> strategy runtime and broker adapter |
| Finite background job | API or Celery beat -> job Redis -> `app/tasks` in `celery-worker` -> PostgreSQL result |
| Scheduled domain work | `app/commands/scheduler.py` -> scheduling services -> durable state and notifications |
| Monitoring | API and workers -> `app/observability` metrics -> Prometheus -> Grafana and Alertmanager |
| Agent or MCP call | MCP client -> `mcp_server` -> `/api/agent/v1` -> the same service layer used by human APIs |
Long-lived trading loops belong to the trading worker. Finite, retryable work
belongs to Celery. HTTP routes validate and delegate; they must not own trading
loops, exchange-specific behavior, or large database workflows.
### Where changes belong
| Change | Primary location | Usually update as well |
| --- | --- | --- |
| Add or modify an HTTP endpoint | `backend_api_python/app/routes/` | `app/openapi/`, route/contract tests, API docs |
| Add a business workflow | `backend_api_python/app/services/` | focused service tests |
| Add an exchange or broker integration | `app/services/live_trading/` or the broker package | credential policy, adapter tests, docs |
| Add a market-data source | `app/data_sources/` | provider aggregation, cache keys, tests |
| Add dashboard, news, or macro aggregation | `app/data_providers/` | route facade and cache policy |
| Add a finite asynchronous task | `app/tasks/` | `celery_app.py`, queue routing, task tests |
| Add long-lived process behavior | `app/workers/`, `app/commands/`, or `app/runtime/` | Compose command, health checks, ownership tests |
| Change the database schema | `backend_api_python/migrations/` | migration/release-gate tests and docs |
| Add metrics or alerts | `app/observability/` and `ops/` | dashboard, alert rule, observability docs |
| Add an MCP tool | `mcp_server/src/quantdinger_mcp/` | Agent Gateway scope, security tests, agent docs |
The web and mobile repositories publish their own GHCR images. Node.js is only
needed when building those clients from source. For deeper ownership rules, read
[Architecture](docs/architecture/ARCHITECTURE.md),
[Module boundaries](docs/architecture/MODULE_BOUNDARIES.md), and
[Process roles](docs/architecture/PROCESS_ROLES_AND_TASKS.md).
## Documentation
Project engineering and assurance documents:
- [Development environment](DEVELOPMENT.md)
- [Testing policy](docs/getting-started/TESTING.md)
- [Architecture](docs/architecture/ARCHITECTURE.md)
- [Governance](GOVERNANCE.md) and [maintainers](MAINTAINERS.md)
- [Security policy](SECURITY.md)
- [Security assessment](docs/security/SECURITY_ASSESSMENT.md)
- [Secure development practices](docs/security/SECURE_DEVELOPMENT.md)
- [Dependency management policy](docs/security/DEPENDENCY_POLICY.md)
- [Open source compliance and security assurance program](docs/compliance/README.md)
- [Release history](CHANGELOG.md)
The maintained documentation index is available at [`docs/README.md`](docs/README.md).
| Topic | Document |
| --- | --- |
| Installation and platform choice | [Installation overview](docs/getting-started/INSTALLATION.md) |
| 30-minute quickstart | [First complete workflow](docs/getting-started/QUICKSTART_30_MINUTES.md) |
| System configuration | [Configuration reference](docs/deployment/CONFIGURATION_REFERENCE.md) |
| External services | [Broker, data, and AI integrations](docs/deployment/INTEGRATION_GUIDE.md) |
| Backup and migration | [Backup, restore, and migration](docs/deployment/BACKUP_RESTORE_MIGRATION.md) |
| Upgrade and rollback | [Upgrade and rollback](docs/deployment/UPGRADE_ROLLBACK.md) |
| Incident diagnosis | [Error knowledge base](docs/deployment/ERROR_KNOWLEDGE_BASE.md) |
| Contributor architecture | [Architecture](docs/architecture/ARCHITECTURE.md) |
| Module ownership | [Module boundaries](docs/architecture/MODULE_BOUNDARIES.md) |
| Process and task ownership | [Process roles](docs/architecture/PROCESS_ROLES_AND_TASKS.md) |
| Production runtime | [Production hardening](docs/deployment/PRODUCTION_HARDENING.md) |
| Metrics and alerts | [Observability](docs/deployment/OBSERVABILITY.md) |
| Human API contracts | [API conventions](docs/architecture/API_CONVENTIONS.md) |
| OpenAPI artifacts | [API documentation](docs/api/README.md) |
| Strategy development | [Strategy guide](docs/trading/STRATEGY_DEV_GUIDE.md) |
| Indicator development | [Indicator guide](docs/trading/INDICATOR_DEV_GUIDE.md) |
| MCP and agents | [Agent documentation](docs/agent/README.md) |
| Cloud deployment | [Cloud deployment](docs/deployment/CLOUD_DEPLOYMENT_EN.md) |
| AWS Marketplace | [One-click deployment and upgrade](docs/deployment/AWS_MARKETPLACE_DEPLOYMENT.md) |
| Installation problems | [Troubleshooting](docs/deployment/INSTALL_TROUBLESHOOTING.md) |
| Documentation maintenance | [Documentation standard](docs/architecture/DOCUMENTATION_MAINTENANCE.md) |
## Contributing
Read [CONTRIBUTING.md](CONTRIBUTING.md) and [DEVELOPMENT.md](DEVELOPMENT.md)
before opening a pull request. Keep routes thin, preserve API compatibility,
place long-running behavior in the correct process, and include focused tests
for high-risk changes.
The [public roadmap](ROADMAP.md) lists active product themes, planning stages,
and the process for claiming scoped contributor work.
## License and commercial terms
- Backend source code is licensed under [Apache License 2.0](LICENSE).
- This repository passes automated REUSE checks. Open Byte Inc. has completed
[OpenChain ISO/IEC 5230 and ISO/IEC 18974 online self-certification and maintains conformance evidence](docs/compliance/README.md).
Conformance applies to the defined management-program scope; it is not an
independent third-party certification of the QuantDinger software.
- QuantDinger is a product of **Open Byte Inc**. The name, logo, product
identity, and commercial licensing are managed separately from the code license.
- Web frontend source is published in
[QuantDinger Frontend](https://github.com/OpenByteInc/QuantDinger-Vue) under
its own source-available license.
- Mobile H5 and native client source is published in
[QuantDinger Mobile](https://github.com/OpenByteInc/QuantDinger-Mobile) under
its own source-available license.
- Trademark, branding, attribution, and watermark use is governed by
[TRADEMARKS.md](TRADEMARKS.md). Apache 2.0 does not grant trademark rights.
For commercial licensing, frontend source access, branding authorization, or
deployment support:
- Website: [quantdinger.com](https://www.quantdinger.com)
- Telegram: [t.me/worldinbroker](https://t.me/worldinbroker)
- Email: [support@quantdinger.com](mailto:support@quantdinger.com)
## Legal notice and compliance
QuantDinger is intended for **lawful research, education, and compliant trading
only**. It must not be used for fraud, market manipulation, sanctions evasion,
money laundering, or other illegal activity. Operators are responsible for
following the laws, licensing requirements, tax rules, broker or exchange terms,
and data regulations that apply in every jurisdiction where they deploy or use
the software.
**This project does not provide legal, tax, investment, financial, or regulatory
advice.** Trading, including automated and leveraged trading, can result in the
loss of some or all capital. Historical data, backtests, simulated results, AI
output, indicators, and strategy examples do not guarantee future performance.
Users must independently review strategies, permissions, order limits, and risk
controls before enabling live execution.
The software is provided under the terms of the applicable license and is used
at the operator's own risk. To the extent permitted by law, project maintainers
and contributors disclaim liability for trading losses, data loss, service
interruption, third-party failures, security incidents, or regulatory consequences
arising from use or misuse of the software.
## Community and support
<p>
<a href="https://t.me/quantdinger"><img src="docs/badges/telegram-group.svg" alt="Telegram"></a>
<a href="https://discord.com/invite/tyx5B6TChr"><img src="https://img.shields.io/badge/Discord-Server-5865F2?style=for-the-badge&logo=discord" alt="Discord"></a>
<a href="https://youtube.com/@quantdinger"><img src="https://img.shields.io/badge/YouTube-Channel-FF0000?style=for-the-badge&logo=youtube" alt="YouTube"></a>
<a href="https://x.com/QuantDinger_EN"><img src="https://img.shields.io/badge/X-Follow-000000?style=for-the-badge&logo=x" alt="X"></a>
</p>
- [Website](https://www.quantdinger.com)
- [Contributing guide](CONTRIBUTING.md)
- [Public roadmap](ROADMAP.md)
- [Contributors](CONTRIBUTORS.md)
- [Report bugs or request features](https://github.com/OpenByteInc/QuantDinger/issues)
- Email: [support@quantdinger.com](mailto:support@quantdinger.com)
## Sponsors
QuantDinger's continued development and open-source community are supported by:
<table>
<tr>
<td align="center" width="33.33%">
<a href="https://www.atlascloud.ai/?utm_source=github&utm_medium=link&utm_campaign=quantdinger">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://www.atlascloud.ai/logo-white.svg">
<img src="https://www.atlascloud.ai/logo.svg" alt="Atlas Cloud" width="176" align="middle">
</picture>
</a>
<br><br>
<strong>Atlas Cloud</strong>
<br>
<sub>AI inference sponsor</sub>
</td>
<td align="center" width="33.33%">
<a href="https://aws.amazon.com/marketplace/pp/prodview-ywy4zb5wnsari">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://a0.awsstatic.com/libra-css/images/logos/aws_smile-header-desktop-en-white_59x35.png">
<img src="https://upload.wikimedia.org/wikipedia/commons/9/93/Amazon_Web_Services_Logo.svg" alt="Amazon Web Services" width="72" align="middle">
</picture>
</a>
<br><br>
<strong>Amazon Web Services</strong>
<br>
<sub>Cloud infrastructure sponsor</sub>
</td>
<td align="center" width="33.33%">
<a href="https://openai.com/">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="docs/badges/openai-wordmark-white.svg">
<img src="docs/badges/openai-wordmark-black.svg" alt="OpenAI" width="220" align="middle">
</picture>
</a>
<br><br>
<strong>OpenAI</strong>
<br>
<sub>Open-source development tooling sponsor</sub>
</td>
</tr>
</table>
We are grateful to [Atlas Cloud](https://www.atlascloud.ai/?utm_source=github&utm_medium=link&utm_campaign=quantdinger) for supporting AI
model inference, to [Amazon Web Services](https://aws.amazon.com/) for cloud
infrastructure support, and to [OpenAI](https://openai.com/) for open-source
development tooling support that helps QuantDinger serve its community.
<sub>OpenAI and the OpenAI logo are trademarks of OpenAI. Their inclusion acknowledges program and tooling support and does not imply product certification or endorsement.</sub>
## Acknowledgements
QuantDinger stands on top of a strong open-source ecosystem. Special thanks to
the maintainers and contributors of projects including:
- [Flask](https://flask.palletsprojects.com/)
- [Gunicorn](https://gunicorn.org/)
- [Celery](https://docs.celeryq.dev/)
- [PostgreSQL](https://www.postgresql.org/)
- [Redis](https://redis.io/)
- [Pandas](https://pandas.pydata.org/)
- [NumPy](https://numpy.org/)
- [yfinance](https://github.com/ranaroussi/yfinance)
- [AkShare](https://github.com/akfamily/akshare)
- [Vue.js](https://vuejs.org/)
- [Ant Design Vue](https://antdv.com/)
- [KLineCharts](https://github.com/klinecharts/KLineChart)
- [ECharts](https://echarts.apache.org/)
- [Capacitor](https://capacitorjs.com/)
- [bip-utils](https://github.com/ebellocchia/bip_utils)
- [Prometheus](https://prometheus.io/)
- [Grafana](https://grafana.com/)
## P.S. — A note on the name
**QuantDinger** is a small tribute to
**[Erwin Schrödinger](https://en.wikipedia.org/wiki/Erwin_Schr%C3%B6dinger)** —
the “-dinger” in our name is the tail of “Schrödinger”. The cat in the box was a
thought experiment; every un-fired strategy is its own little version of it —
simultaneously winning and losing until the order actually fills. Backtests open
the box. Live trading collapses the wavefunction. Trade carefully.
<p align="center"><sub>If QuantDinger is useful to you, a GitHub star helps the project a lot.</sub></p>