API reference¶
The reference is organized by public module and supplements generated signatures with exact normalized schema tables.
| Page | Contents |
|---|---|
| Monte Carlo research | Experiments, execution, models, distributions, path metrics, and portfolio evaluation |
| Models | Identity, metadata, normalized result classes, catalogs, and enums |
| Data access and storage | Synthetic data, caching, DuckDB, transforms, and capability protocols |
| Alpha Vantage | Client construction, namespace methods, transport, and rate limiter |
| FRED and ALFRED | Series definitions, latest observations, revisions, vintage dates, and transport |
| Analysis | General, market, option, and economic calculations |
| Point-in-time research | Features, labels, factor regressions, factor forecasts and attribution, splits, and evaluation |
| Portfolio research | Objectives, constraints, solver boundary, rolling optimization, target construction, and backtesting |
| Projects | Strict manifests, fixed paths, transactional initialization, and read-only validation |
| Trading Engine integration | Current v1 schemas, scenario policies, serialization, and reconciliation |
| Visualization | General, market, option, economic, research, and portfolio Plotly helpers |
| Normalized schemas | Exact frame columns and pandas dtypes |
| Exceptions | The public exception hierarchy |
Public imports are available from the shortest documented namespace in normal use:
from persistra.analysis import simple_returns
from persistra.data import AlphaVantageClient, DuckDBStore, FredClient, synthetic, verify_store
from persistra.errors import ProviderError
from persistra.integrations.trading_engine import TradingEngineContractSchemas
from persistra.model import BarSet, InstrumentKind
from persistra.monte_carlo import MonteCarloExperiment, run_experiment
from persistra.portfolio import PortfolioProblem, backtest_portfolio, optimize_portfolio_path
from persistra.project import PersistraProject, create_project, validate_project
from persistra.research import build_factor_portfolio_forecast, fit_time_series_factor_model
from persistra.viz import plot_returns
Provider namespace classes appear in their provider references because their methods are the client attributes' callable surface. Most applications construct a client rather than an individual namespace or transport.
The reference is generated from the installed package during a strict MkDocs build. If a signature conflicts with prose elsewhere, treat the generated signature as authoritative and report the documentation mismatch.