Skip to content
AlgoBeam
Getting Started2 / 5

Quickstart

Install AlgoBeamTS, load bars from a provider, and print an indicator value in three minutes.


Install the package. The compiler, the runtime and the command line tool all ship together, so a single dependency is enough to get from a script file to a rendered plot.

Next, construct a runtime. The constructor takes four things in order: a provider, a symbol, a timeframe and how many bars of history to load. Providers are pluggable — the built-in ones cover the major crypto venues and a delayed equities feed, and Providers explains how to write your own in about thirty lines.

Calling load resolves the request into an array of bars, oldest first. Each bar is a plain object with time in unix seconds plus open, high, low, close and volume. Nothing is memoised on the network layer by default, so if you are polling in a loop you should cache the result yourself or hand the runtime a cache adapter.

Running an indicator returns a result object rather than a bare number. It carries the full output series, the last value, a few convenience flags such as rising and falling, and any alert conditions the script declared. That shape is identical whether the indicator came from the built-in indicators namespace or from a compiled AlgoBeamScript file.

From here, Your First Indicator walks through writing the script instead of using a built-in, and Your First Backtest turns that script into a strategy with entries and exits.

Ready when you are

Docs are cheap. Evidence is not.

Install AlgoBeamTS, run the example on this page against your own data, and see whether the idea survives a decade of bars.

  • No card required
  • Cancel anytime
  • 14-day Ultimate trial