API Reference¶
This section provides documentation for PyQuantLib classes and functions.
See also
Quick Start for a tutorial, Installation for setup.
Module Overview¶
PyQuantLib organizes QuantLib classes into logical groups:
Time: Date arithmetic, calendars, day counters, schedules
Core: Settings, constants, rounding, interest rates
Math: Arrays, matrices, optimization
Quotes: Market observables (spot, rates, vol)
Currencies: Currency definitions and exchange rates
Cash Flows: Coupon and cash flow implementations
Indexes: Interest rate and other indexes
Term Structures: Yield curves, volatility surfaces
Processes: Stochastic processes (Black-Scholes, Heston)
Models: Pricing models (Heston, etc.)
Methods: Monte Carlo paths, Brownian bridges, generators
Instruments: Financial instruments (options, etc.)
Pricing Engines: Analytic, Monte Carlo, finite difference
Experimental: Experimental QuantLib features (SVI, etc.)
Import Conventions¶
Most classes are available directly from the top-level namespace:
import pyquantlib as ql
# Use classes directly
date = ql.Date(15, 6, 2025)
calendar = ql.TARGET()
quote = ql.SimpleQuote(100.0)
Abstract Base Classes¶
For subclassing, import from pyquantlib.base:
from pyquantlib.base import (
Observer,
Observable,
LazyObject,
CashFlow,
Coupon,
PricingEngine,
StochasticProcess,
# ... etc
)
API Documentation¶
- Time Module
- Core Module
- Math Module
- Quotes Module
- Currencies Module
- Cash Flows Module
- Indexes Module
- Term Structures Module
- Yield Term Structures
- Rate Helpers
- Interpolated Yield Curves
- Piecewise Yield Curves
- Global Bootstrap Piecewise Curves
- MultiCurve
- Fitted Bond Discount Curves
- Volatility Term Structures
- Swaption Volatility Spread
- SABR Volatility
- No-Arbitrage SABR
- Kahale Arbitrage-Free Smile
- Andreasen-Huge Volatility
- Local Volatility
- Swaption Volatility Term Structures
- Optionlet Volatility Term Structures
- YoY Inflation Optionlet Volatility
- Cap/Floor Term Volatility
- Optionlet Stripping
- Credit Term Structures
- Inflation Term Structures
- Processes Module
- Models Module
- Methods Module
- Paths
- Brownian Bridge
- Path Generators
- Brownian Generators
- FDM Enums
- FDM Grid Infrastructure
- FDM Boundary Conditions
- FDM Operators
- FDM Schemes
- FDM Inner Value Calculators
- FDM Step Conditions
- FDM Solvers
- Boundary Conditions
- Additional Meshers
- Additional Step Conditions
- Additional Operators
- Risk-Neutral Density Calculators
- Instruments Module
- Bonds
- Callable Bonds
- Convertible Bonds
- Swaps
- Caps, Floors, and Collars
- Forward Rate Agreement
- Swaptions
- Composite Instruments
- Credit Instruments
- Inflation Swaps
- YoY Inflation Caps, Floors, and Collars
- Options
- Barrier Options
- Asian Options
- Lookback Options
- Cliquet Options
- Compound Options
- Chooser Options
- Margrabe Options
- Forward-Start Options
- Quanto Options
- Payoffs
- Variance Swaps
- Exotic Swaps
- Bond Forwards
- Exercise Types
- Pricing Engines Module
- Vanilla Engines
- Basket Engines
- Swaption Engines
- Barrier Engines
- Asian Engines
- Lookback Engines
- Cliquet Engines
- Exotic Engines
- Forward-Start Engines
- Quanto Engines
- Cap/Floor Engines
- YoY Inflation Cap/Floor Engines
- Bond Engines
- Convertible Bond Engines
- Credit Engines
- Swap Engines
- Bond Functions
- Variance Swap Engines
- Calculators
- Functions
- Experimental Module
- Python Extensions
Note
API documentation is auto-generated from docstrings in the C++ bindings. Abstract base classes are available in pyquantlib.base.