QuantDinger Documentation¶
QuantDinger is a self-hosted AI trading platform that connects market research, Strategy API V2 development, backtesting, paper/live execution, operations, and AI-agent access. This documentation describes the current v5 release.
中文文档 · Official website · Web app · GitHub
Live trading can submit real orders. Start in paper mode, grant exchange keys the minimum permissions required, and confirm the legal and operational requirements for your jurisdiction. QuantDinger does not provide investment advice.
Choose your goal¶
| Goal | Start here | Continue with |
|---|---|---|
| Install or deploy | Installation overview | Post-installation setup |
| First use | 30-minute quickstart | First-run guide |
| Configure integrations | Configuration reference | Broker, data, and AI integrations |
| Use AI research | AI Research guide | Strategy workflow |
| Run a backtest | Backtest Center guide | Strategy API V2 guide |
| Prepare live trading | Live-trading safety | Security and reporting |
| Reconcile Alpaca execution fees | English | 简体中文 |
| Prepare production | Production hardening | Observability |
| Upgrade or move an instance | Upgrade and rollback | Backup, restore, and migration |
| Diagnose a problem | Error knowledge base | Installation troubleshooting |
| Deploy from AWS Marketplace | English | 简体中文 |
| Release or scale runtime workers | Distributed runtime scaling | V6 capacity plan |
| Connect an AI agent | MCP setup | Agent Gateway quickstart |
| Integrate over HTTP | Human OpenAPI | API conventions |
| Extend the backend | Architecture overview | Extension guide |
Five-minute installation¶
For Windows, Linux/macOS, cloud, SaaS, and mobile-specific instructions, use the installation overview.
Prerequisites: Docker with Compose v2. The installer asks for an administrator account, generates the required secrets, writes the deployment environment, and starts the prebuilt GHCR stack.
Linux or macOS:
curl -fsSL https://raw.githubusercontent.com/OpenByteInc/QuantDinger/main/install.sh | bash
Windows PowerShell:
irm https://raw.githubusercontent.com/OpenByteInc/QuantDinger/main/install.ps1 | iex
After startup:
| Surface | Default local address |
|---|---|
| Desktop web app | http://127.0.0.1:8888 |
| Mobile web app | http://127.0.0.1:8889 |
| Backend health check | http://127.0.0.1:5000/api/health |
For source builds, reverse proxies, HTTPS, upgrades, and proxy settings, use the cloud deployment guide.
System map¶
The v5 runtime separates long-lived ownership from request handling:
| Process | Responsibility |
|---|---|
migration |
Applies database schema changes before dependent services start. |
kafka-init |
Creates the versioned runtime topics before event consumers start. |
backend |
HTTP authentication, validation, queries, and durable command submission. |
trading-worker |
Control/realtime runtimes, broker sessions, fenced order execution, reconciliation, and grid actors. |
strategy-dispatcher-worker |
Converts closed bars into stable strategy-shard evaluation batches. |
strategy-evaluator-worker |
Hosts hot distributed bar runtimes and produces fenced order intents. |
kafka-audit-worker |
Audits the versioned runtime event stream. |
scheduler-worker |
Portfolio, deployment, payment, and notification schedules. |
celery-worker |
Finite retryable work such as AI jobs, backtests, reports, and maintenance. |
celery-beat |
Periodically enqueues Celery work. |
PostgreSQL is the system of record. redis is an evictable cache;
redis-jobs is the durable Celery broker/result tier, and Kafka is the ordered
runtime event backbone. See the
architecture overview before changing process
ownership or shared state.
Documentation map¶
Getting started and product guides¶
- Installation and deployment overview
- 30-minute quickstart
- Post-installation setup
- First run with QuantDinger
- AI Research guide
- From strategy idea to operation
- Backtest Center guide
- Live-trading safety guide
- Security, versions, and vulnerability reporting
Open source assurance¶
- Compliance and security assurance program
- OpenChain ISO/IEC 5230 self-assessment
- OpenChain ISO/IEC 18974 self-assessment
- Release compliance checklist
Deployment and operations¶
- Windows installation
- Linux and macOS installation
- Cloud deployment
- SaaS deployment
- Mobile client deployment
- Configuration reference
- Broker, data, and AI integrations
- Compatibility matrix
- Backup, restore, and migration
- Upgrade and rollback
- Error knowledge base
- AWS Marketplace: English / 简体中文
- Distributed runtime deployment and scaling
- 分布式运行时部署与扩容
- Installation troubleshooting
- Installation FAQ
- Production hardening
- Observability
- Multi-user operation
- OAuth configuration
- Administrator and settings troubleshooting
- Notifications: Email, SMS, and Telegram
Architecture and scale planning¶
- Architecture overview
- Concurrency model
- Process and task ownership
- V6 hyperscale architecture plan
- Documentation maintenance standard
Trading and research¶
- Strategy API V2 development
- Chart indicator development
- Interactive Brokers
- Alpaca execution-fee reconciliation: English / 简体中文
- Live-trading safety
- Public universes and point-in-time fundamentals (Chinese)
- Fundamental-data preparation operations (Chinese)
- Runnable examples in
examples/
APIs and agents¶
- Human Web API and OpenAPI
- Agent documentation
- MCP setup
- Agent Gateway quickstart
- Machine-readable contracts:
api/openapi.yamlandagent/agent-openapi.json
Language and maintenance policy¶
Each human-readable page uses one primary language. English and Chinese pages are paired when both are maintained; the website language switch links directly to the paired page. Machine-readable schemas, identifiers, environment variable names, and code remain in their canonical English form.
The repository docs/ directory is the source of truth. Update the relevant
index and counterpart language page when a contract or workflow changes. Follow
the documentation maintenance standard
for page structure, screenshots, release review, and definition of done. Do not
publish planning notes, completed roadmaps, or temporary audits as product
documentation.
