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.

import {
  defineStrategy,
  createRunner,
  createHistoricalFeed,
  createLiveFeed,
  createPaperBroker,
  defineMarket,
} from '@thecommandcat/fbtf';

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/data to prepare inputs
  • use @thecommandcat/fbtf/markets to define or reuse market contracts
  • use @thecommandcat/fbtf/results to inspect what happened
  • use @thecommandcat/fbtf/experiment when you want config-driven repeatable runs

That split keeps the front door readable without hiding the more specific tools.

On this page