API overview
Learn the main entrypoints and useful subpaths.
API overview
Root package
The root package is intentionally narrow and focused on the runtime front door.
These are the entrypoints you should reach for first. If you can stay at the root package, you probably should.
Important subpaths
@thecommandcat/fbtf/data— normalization, CSV loading, historical provider helpers@thecommandcat/fbtf/markets— built-in futures markets and market definitions@thecommandcat/fbtf/results— run result types@thecommandcat/fbtf/risk— sizing and futures risk helpers@thecommandcat/fbtf/experiment— experiment definitions and execution helpers@thecommandcat/fbtf/strategy— strategy-specific types
Other subpaths also exist, but these are the ones most users are likely to need early.
Use subpaths when you need more than the minimal runtime entrypoints.
A practical way to think about the surface
- use the root package to assemble and run the runtime
- use
@thecommandcat/fbtf/datato prepare inputs - use
@thecommandcat/fbtf/marketsto define or reuse market contracts - use
@thecommandcat/fbtf/resultsto inspect what happened - use
@thecommandcat/fbtf/experimentwhen you want config-driven repeatable runs
That split keeps the front door readable without hiding the more specific tools.
fbtf docs
Deterministic backtesting and live paper trading docs for TypeScript.
Getting started
Install fbtf and run your first minimal backtest.
Core concepts
Understand the runtime model behind fbtf.
Runtime flow
How feeds, strategies, brokers, and the runner interact during execution.
Data and markets
Prepare inputs, define markets, and use adapter-based data loading.
Results and diagnostics
Inspect what happened after a run and understand how the runtime explains itself.
Experiments and CLI
Run experiment modules through the config-first fbtf CLI.
Roadmap
What FBTF is trying to finish next and what is intentionally out of scope.