API Reference Overview
Choose a module below for API documentation, parameters, and usage examples.
| Module | Purpose |
|---|---|
| finlab | Provides authentication and credential management. |
| finlab.data | Retrieves market data, manages caches, and calculates technical indicators. |
| FinlabDataFrame | Supports data alignment, stock selection conditions, and position signals. |
| finlab.backtest | Turns position signals into historical backtests and performance reports. |
| finlab.report | Displays backtest performance, trade records, and strategy reports. |
| finlab.ml | Builds machine learning features, labels, and prediction models. |
| finlab.portfolio | Combines strategies, allocates weights, and manages cloud synchronization. |
| finlab.online | Connects broker accounts to manage positions and place live orders. |
| finlab.plot | Plots market prices, financial data, and strategy performance. |
| finlab.analysis | Analyzes strategy liquidity, MAE/MFE, stability, and excess returns. |
| finlab.optimize | Searches strategy parameters and compares backtests across settings. |
| finlab.tools | Provides event study and factor analysis tools. |
| finlab.market | Defines market price data, benchmark indices, and trading rules. |