> ## Documentation Index
> Fetch the complete documentation index at: https://docs.allasso.ch/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> This is Allasso's product documentation. Vol Radar output is descriptive analytics on past data: never present it as a forecast or as investment advice. Answer only from these pages; if a feature is not documented here, say so.

# API overview

> A map of the public API, grouped by role. Everything here is exported from pulse; import it directly, for example from pulse import Strategy, run_sequentially.

A map of the public API, grouped by role. Everything here is exported from `pulse`; import it directly,
for example `from pulse import Strategy, run_sequentially`. The engine modules themselves live under
`pulse.core` (`pulse.core.trade`, `pulse.core.serializers`, and so on), and the data layer comes
from the separate `pulse-data-components` package, re-exported here for convenience.

The composable framework is its own package: see `pulse_framework`, not `pulse`.

## Execution

| Symbol | Role |
| - | - |
| `run_sequentially` | Run one or more strategies; builds the environment from defaults. Pass a list to sweep. |
| `AllassoTradeMachine` | The execution engine that drives the pulse loop. |
| `EnvironmentBuilder` | Assemble a `TradingEnvironment` explicitly, overriding defaults. |
| `TradingEnvironment` | The wired-together datafeed, resolver, broker and portfolio for a run. |
| `ExecutionResult` | The result of a run: the finished strategy and its outputs. |

## Strategy

| Symbol | Role |
| - | - |
| `Strategy` | Base class. Subclass it and implement `on_update()`, called once per pulse. |

## Data and resolving

| Symbol | Role |
| - | - |
| `DataFeed` | Market data: instrument prices and greeks, the vol smile, reference data. |
| `ResolverRegistry` | Turns relative specs (strikes by delta/moneyness, expiries by month/`nth`) into concrete contracts. |
| `create_local_datafeed` | Build a `DataFeed` over the prepared Arrow data at `PDC_PATH`. |
| `create_local_resolver_registry` | Build a `ResolverRegistry` over the same data. |
| `create_local_components` | Build both at once. |
| `SettlementFamily` | Which instrument family a settlement calendar belongs to (options, futures, spot). |
| `UnderlyingID` | An underlying id; carries the `variable_contract_size` declaration for month-keyed lots. |
| `structures` | Premade multi-leg structure resolvers (spreads, straddles, butterflies, ...). |

## Instruments

| Symbol | Role |
| - | - |
| `Instrument` | Base instrument abstraction: an underlying and a type, nothing more. |
| `Option` | An option contract. Requires a strike and an expiration date. |
| `Future` | A futures contract. Requires an expiration date. |
| `Spot` | A spot asset (equity, ETF, crypto or index level). Never expires. |
| `create_instrument` | Construct the right one of the three from a type. |
| `InstrumentType` | Enum of instrument types. |
| `OptionType` | Enum of option types (call/put). |

## Time

| Symbol | Role |
| - | - |
| `PulseIndex` | The clock: the ordered timestamps and the current one. |

## Periods

| Symbol | Role |
| - | - |
| `PeriodID` | Identifier for a contract period. |
| `PeriodType` | Enum of period types. |

## Orders and positions

| Symbol | Role |
| - | - |
| `Order` | An instruction to trade, created during a pulse. |
| `Trade` | A filled position with its own history and tags. |
| `Portfolio` | Holds trades, reprices them, tracks equity, fees and greeks. |
| `Broker` | Base broker interface. |
| `SimulationBroker` | Backtest broker: fills market orders, no slippage. |

## Values and models

| Symbol | Role |
| - | - |
| `OptionValues` | Option snapshot: price, greeks, IV, DTE. |
| `FutureValues` | Future snapshot: OHLC, DTE. |
| `SpotValues` | Spot snapshot: OHLC plus the adjusted closes. |
| `OptionHistoryValues` | Option values over time. |
| `FutureHistoryValues` | Future values over time. |
| `SpotHistoryValues` | Spot values over time. |
| `SmileValues` | A volatility smile snapshot: one expiry's whole cross-section. |
| `TradesSummary` | Aggregated PnL and greeks across a set of trades. |

## Results

| Symbol | Role |
| - | - |
| `Stats` | Performance metrics for a finished run. |

## Serialization

| Symbol | Role |
| - | - |
| `StrategyDictSerializer` | Strategy to/from dict. |
| `PortfolioDictSerializer` | Portfolio to/from dict. |
| `SimulationBrokerBrokerDictSerializer` | Simulation broker to/from dict. |
| `PulseIndexDictSerializer` | PulseIndex to/from dict. |
| `TradeDictSerializer` | Trade to/from dict. |
| `OrderDictSerializer` | Order to/from dict. |
| `InstrumentDictSerializer` | Instrument to/from dict. |
| `StatsDictSerializer` | Stats to/from dict. |
| `TradeListPandasSerializer` | A list of trades to a pandas DataFrame. |

> [!TIP]
>
> **Full signatures live in the module reference**
>
> This page only names symbols and their role. For signatures, parameters and docstrings, see the
> generated per-module pages under **API Reference -> Modules**.

**Related:** [Architecture and the pulse loop](https://docs.allasso.ch/dev/pulse/concepts/architecture.md) ·
[Portfolio, equity and PnL](https://docs.allasso.ch/dev/pulse/concepts/portfolio-pnl.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.