Welcome!

The quantmod package is inspired by the popular R package of the same name but reimagined for the modern Python data stack. It’s designed to support data scientists, analysts, and AI researchers with tools for fast, flexible data exploration and visualization. Whether you're working with time series, building machine learning pipelines, or prototyping data-driven ideas, quantmod offers a clean, intuitive interface that helps you move quickly from data to insight.

User installation

The easiest way to install quantmod is using pip:

pip install quantmod

Modules

• charts
• datasets
• derivatives
• indicators
• markets
• models
• risk
• timeseries

Quickstart

# Retrieves market data & ticker object 
from quantmod.markets import getData, getTicker

# Charting module
import quantmod.charts

# Option price
from quantmod.models import OptionInputs, BlackScholesOptionPricing, MonteCarloOptionPricing

# Calculates price return of different time period.
from quantmod.timeseries import *

# Technical indicators
from quantmod.indicators import ATR

# Derivatives functions
from quantmod.derivatives import maxpain

# Datasets functions
from quantmod.datasets import fetch_historical_data

Note: quantmod is currently under active development, and anticipate ongoing enhancements and additions. The aim is to continually improve the package and expand its capabilities to meet the evolving needs of the community.

Examples

Refer to the examples section for more details.

Changelog

The list of changes to quantmod between each release can be found here

Community

Join the quantmod server to share feature requests, report bugs, and discuss the package.

Legal

quatmod is distributed under the Apache Software License. See the LICENSE.txt file in the release for details.

The package is developed and maintained by Kannan Singaravelu.