Skip to content

API Reference

Welcome to the API Reference for optpricing. Click any category below to explore its modules, classes, functions, and more.


Atoms

Core data structures for options, stocks, rates, bonds, etc. Immutable types that underpin every model and technique.


Calibration

Tools to fit model parameters to market data (RMSE minimization, IV surfaces, jump fitting).


CLI

The command-line interface entrypoint (optpricing), with commands for pricing, data, calibration, backtests, demos, and dashboard.


Dashboard

Streamlit-based interactive UI for pricing, calibration, market analytics, and model workflows.


Data

Managers for live & historical market data: downloading, snapshots, dividends, etc.


Models

Black-Scholes, Heston, SABR, Merton-jump, and many stochastic and Levy models.


Parity

Put-call parity utilities and implied-rate models.


Techniques

Pricing engines: closed-form, FFT, PDE, lattices, Monte Carlo (with Greek calculation mixins).


Workflows

High-level orchestrators for daily calibration, backtesting, and other batch processes.