QuantLab

Getting Started

  • Installation
    • Requirements
    • Install with uv (Recommended)
    • Install with pip
    • Configuration
      • Get API Keys
    • Data Setup
      • Option 1: Download Pre-built Data
      • Option 2: Use Existing qlib Data
    • Verification
    • Troubleshooting
      • Database Connection Issues
      • API Rate Limits
      • Missing Data
    • Next Steps
  • Quick Start
    • Initialize QuantLab
    • Basic Commands
      • Price Data & Visualization
      • Options Analysis
      • Portfolio Management
      • Backtesting
    • Example Workflows
      • Workflow 1: Stock Research
      • Workflow 2: Options Strategy
      • Workflow 3: Portfolio Analysis
      • Workflow 4: Quantitative Strategy
    • Sample Charts
    • CLI Tips
      • Get Help
      • Output Options
      • Batch Processing
    • Next Steps
  • CLI Overview
    • Command Structure
    • Main Commands
      • Data Management
      • Analysis
      • Portfolio Management
      • Visualization
      • Lookup Tables
    • Common Options
      • Price Charts
      • Options Strategy
      • Analysis Options
    • Environment Variables
    • Configuration File
    • Output Formats
      • JSON Output
      • HTML Charts
    • Piping and Integration
      • Use with jq
      • Use with grep
      • Batch Processing
    • Error Handling
      • Return Codes
      • Logging
    • Advanced Usage
      • Custom Scripts
      • Backtesting Integration
    • Next Steps

User Guide

  • Visualization Guide
  • Backtesting Guide
  • Options Analysis Guide
  • Portfolio Management Guide
  • Data Management Guide

API Reference

  • Core API
    • Analyzer
      • Analyzer.__init__()
      • Analyzer.analyze_ticker()
      • Analyzer.analyze_portfolio()
  • Data API
    • DataManager
      • DataManager.__init__()
      • DataManager.get_stock_price()
      • DataManager.get_intraday_prices()
      • DataManager.get_options_chain()
      • DataManager.get_fundamentals()
      • DataManager.get_sentiment()
      • DataManager.get_vix()
      • DataManager.get_technical_indicators()
    • RateLimiter
      • RateLimiter.__init__()
      • RateLimiter.wait_if_needed()
    • PolygonClient
      • PolygonClient.__init__()
      • PolygonClient.get_stock_snapshot()
      • PolygonClient.get_options_chain()
      • PolygonClient.get_market_holidays()
      • PolygonClient.get_intraday_aggregates()
      • PolygonClient.get_technical_indicators()
    • AlphaVantageClient
      • AlphaVantageClient.BASE_URL
      • AlphaVantageClient.__init__()
      • AlphaVantageClient.get_treasury_rate()
      • AlphaVantageClient.get_news_sentiment()
    • YFinanceClient
      • YFinanceClient.__init__()
      • YFinanceClient.get_vix()
      • YFinanceClient.get_fundamentals()
      • YFinanceClient.get_institutional_holders()
  • Visualization API
    • create_candlestick_chart()
    • create_price_line_chart()
    • create_multi_ticker_comparison()
    • create_payoff_diagram()
    • create_greeks_heatmap()
    • create_greeks_timeline()
    • create_greeks_3d_surface()
    • create_strategy_comparison()
  • Analysis API
    • OptionType
      • OptionType.CALL
      • OptionType.PUT
    • PositionType
      • PositionType.LONG
      • PositionType.SHORT
    • StrategyType
      • StrategyType.COVERED_CALL
      • StrategyType.PROTECTIVE_PUT
      • StrategyType.CASH_SECURED_PUT
      • StrategyType.LONG_CALL
      • StrategyType.LONG_PUT
      • StrategyType.BULL_CALL_SPREAD
      • StrategyType.BULL_PUT_SPREAD
      • StrategyType.BEAR_CALL_SPREAD
      • StrategyType.BEAR_PUT_SPREAD
      • StrategyType.CALENDAR_SPREAD
      • StrategyType.IRON_CONDOR
      • StrategyType.BUTTERFLY
      • StrategyType.STRADDLE
      • StrategyType.STRANGLE
    • OptionLeg
      • OptionLeg.option_type
      • OptionLeg.position_type
      • OptionLeg.strike
      • OptionLeg.premium
      • OptionLeg.quantity
      • OptionLeg.expiration
      • OptionLeg.implied_volatility
      • OptionLeg.risk_free_rate
      • OptionLeg.pnl_at_price()
      • OptionLeg.calculate_advanced_greeks()
      • OptionLeg.__init__()
    • OptionsStrategy
      • OptionsStrategy.name
      • OptionsStrategy.strategy_type
      • OptionsStrategy.legs
      • OptionsStrategy.stock_position
      • OptionsStrategy.current_stock_price
      • OptionsStrategy.target_date
      • OptionsStrategy.name
      • OptionsStrategy.strategy_type
      • OptionsStrategy.legs
      • OptionsStrategy.current_stock_price
      • OptionsStrategy.stock_position
      • OptionsStrategy.target_date
      • OptionsStrategy.metadata
      • OptionsStrategy.net_premium()
      • OptionsStrategy.max_profit()
      • OptionsStrategy.max_loss()
      • OptionsStrategy.breakeven_points()
      • OptionsStrategy.pnl_at_price()
      • OptionsStrategy.payoff_diagram()
      • OptionsStrategy.risk_metrics()
      • OptionsStrategy.advanced_greeks()
      • OptionsStrategy.to_dict()
      • OptionsStrategy.__init__()
    • StrategyBuilder
      • StrategyBuilder.covered_call()
      • StrategyBuilder.protective_put()
      • StrategyBuilder.cash_secured_put()
      • StrategyBuilder.bull_call_spread()
      • StrategyBuilder.iron_condor()
      • StrategyBuilder.long_call()
      • StrategyBuilder.long_put()
      • StrategyBuilder.bull_put_spread()
      • StrategyBuilder.bear_call_spread()
      • StrategyBuilder.bear_put_spread()
      • StrategyBuilder.butterfly()
      • StrategyBuilder.straddle()
      • StrategyBuilder.strangle()
      • StrategyBuilder.calendar_spread()
  • CLI API

Advanced Topics

  • Custom Factors
  • Strategy Development
  • Performance Optimization
  • Extending QuantLab

Additional Resources

  • Examples
  • FAQ
  • Changelog
  • Contributing
QuantLab
  • Python Module Index

Python Module Index

q
 
q
- quantlab
    quantlab.analysis.options_strategies
    quantlab.cli.main
    quantlab.cli.visualize
    quantlab.core.analyzer
    quantlab.data.api_clients
    quantlab.data.data_manager
    quantlab.visualization.options_charts
    quantlab.visualization.price_charts

© Copyright 2025, nittygritty-zzy.

Built with Sphinx using a theme provided by Read the Docs.