Skip to main content

Model-free implied distribution and volatility analytics for NSE options

Project description

QFinIndia

QFinIndia is a Python library for extracting market-implied information from option chains.

It provides volatility smile, risk-neutral density (RND), implied distribution, tail risk (VaR/CVaR), and directional bias from options data.

Designed for quant research, derivatives analytics, and market microstructure studies.


🚀 Installation

pip install qfinindia
from qfinindia import SyntheticChain, generate_report

chain = SyntheticChain(
    spot=24000,
    expiry="2026-06-25"
).build()

print(generate_report(chain))
QFinIndia IMPLIED MARKET REPORT
--------------------------------
Spot: 24000
Forward: 24503 (2.10%)

Expected Move: ±182
ATM Vol: 0.13
Skew: 0.55

VaR 5%: 24342
VaR 1%: 23940

Bias: Bullish
📊 Core Concepts

QFinIndia converts an option chain into:

Volatility smile

Risk-neutral density

Implied price distribution

Tail risk metrics

Directional market bias

The workflow:

OptionChain  Smile  RND  Distribution  Tail Risk  Report
🧱 Build Option Chains
Synthetic Chain (built-in)
from qfinindia import SyntheticChain

chain = SyntheticChain(
    spot=24000,
    expiry="2026-06-25",
    strike_range=(20000, 28000, 250),
    base_iv=0.13,
    smile=0.35,
    time_value=160,
    r=0.06,
    T=120/365
).build()

From DataFrame

Required columns:

type, strike, expiry, price, iv, oi

from qfinindia import OptionChain

chain = OptionChain.from_dataframe(df, underlying=24000)

📈 Unified Analytics Interface
from qfinindia import Analytics

a = Analytics(chain)

print(a.forward)
print(a.expected_move)
print(a.skew)
print(a.atm_vol)
print(a.var(0.05))
print(a.cvar(0.05))
print(a.bias)

📑 Implied Market Report
Text
from qfinindia import generate_report
print(generate_report(chain))

Dictionary
generate_report(chain, output="dict")

DataFrame
generate_report(chain, output="df")

📉 Plotting Helpers
from qfinindia import plot_smile, plot_rnd, plot_distribution

plot_smile(chain)
plot_rnd(chain)
plot_distribution(chain)

📊 Available Metrics

QFinIndia extracts:

Forward price

Expected move

ATM volatility

Skew

Variance

Risk-neutral density

Implied distribution

VaR

CVaR

Directional bias
🧪 Example: Full Analytics
from qfinindia import SyntheticChain, Analytics

chain = SyntheticChain(24000, "2026-06-25").build()
a = Analytics(chain)

print("Forward:", a.forward)
print("Move:", a.expected_move)
print("Skew:", a.skew)
print("VaR 5%:", a.var(0.05))
print("Bias:", a.bias)

🏗 Architecture
OptionChain
   ├─ VolSmile
   ├─ RND
   ├─ Distribution
   └─ TailRisk
               Analytics
              Report / Plots

     🎯 Use Cases

Options market sentiment

Implied distribution research

Risk-neutral density estimation

Volatility surface studies

Tail risk estimation

Quant trading signals

🛣 Roadmap

Multi-expiry surfaces

SABR calibration

Live NSE data loader

Surface arbitrage checks

Greeks extraction

🤝 Contributing

Pull requests and issues welcome.

📜 License

MIT License

👨‍💻 Author

Dhruv Maheshwari
Quant & Derivatives Analytics

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

qfinindia-0.3.1.tar.gz (10.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

qfinindia-0.3.1-py3-none-any.whl (13.8 kB view details)

Uploaded Python 3

File details

Details for the file qfinindia-0.3.1.tar.gz.

File metadata

  • Download URL: qfinindia-0.3.1.tar.gz
  • Upload date:
  • Size: 10.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.9

File hashes

Hashes for qfinindia-0.3.1.tar.gz
Algorithm Hash digest
SHA256 5c671fbb803ba2b5dafd3f97350818ef044b1748fa1ded52cc0b7ae818c61da4
MD5 da01e4d13abd82ce9394ab020f111890
BLAKE2b-256 9fc2deeeceabd07ac688281960af3feb531bdc0f0ba14355f20b1c199f758753

See more details on using hashes here.

File details

Details for the file qfinindia-0.3.1-py3-none-any.whl.

File metadata

  • Download URL: qfinindia-0.3.1-py3-none-any.whl
  • Upload date:
  • Size: 13.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.9

File hashes

Hashes for qfinindia-0.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 c797ea52368bf8093a1a9c36b0041ea863cb33ed8c4ae086adc53fcded0ba829
MD5 9181abdf55b0442fc4d190daaf2b4464
BLAKE2b-256 fbd28b36e09baed07e19a8a2ca84f0edf67de488f36cc1ee56fa1f361cd021dc

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page