| Crates.io | optionstratlib |
| lib.rs | optionstratlib |
| version | 0.14.3 |
| created_at | 2024-08-21 11:28:15.542919+00 |
| updated_at | 2026-01-15 15:16:05.351358+00 |
| description | OptionStratLib is a comprehensive Rust library for options trading and strategy development across multiple asset classes. |
| homepage | https://github.com/joaquinbejar/OptionStratLib |
| repository | https://github.com/joaquinbejar/OptionStratLib |
| max_upload_size | |
| id | 1346383 |
| size | 6,440,250 |
OptionStratLib is a comprehensive Rust library for options trading and strategy development across multiple asset classes. This versatile toolkit enables traders, quants, and developers to model, analyze, and visualize options strategies with a robust, type-safe approach. The library focuses on precision with decimal-based calculations, extensive test coverage, and a modular architecture built on modern Rust 2024 edition.
plotly.rs)rust_decimalComplete pricing support for all exotic option types:
Asian: Arithmetic and geometric average price options
Barrier: Up/Down, In/Out barrier options with rebates
Binary: Cash-or-nothing and asset-or-nothing options
Lookback: Fixed and floating strike lookback options
Compound: Options on options
Chooser: Options to choose call or put at future date
Cliquet: Forward-starting options with local caps/floors
Rainbow: Multi-asset best-of/worst-of options
Spread: Kirk's approximation for price differentials
Quanto: Currency-protected options
Exchange: Margrabe's formula for asset exchange
Power: Non-linear payoff options
The library is organized into the following key modules:
model/)Core data structures and types for options trading:
option.rs: Complete option structures with pricing and Greeksposition.rs: Position management and P&L trackingexpiration.rs: Flexible expiration date handling (Days/DateTime)positive.rs: Type-safe positive number implementationtypes.rs: Common enums (OptionType, Side, OptionStyle)trade.rs: Trade execution and managementformat.rs: Data formatting utilitiesleg/: Multi-instrument leg support for strategies
traits.rs: Common leg traits (LegAble, Marginable, Fundable, Expirable)spot.rs: SpotPosition for underlying asset positionsperpetual.rs: PerpetualPosition for crypto perpetual swapsfuture.rs: FuturePosition for exchange-traded futuresleg_enum.rs: Leg enum unifying all position typespricing/)Advanced pricing engines for options valuation:
black_scholes_model.rs: European options pricing with Greeksbinomial_model.rs: American/European options with early exercisemonte_carlo.rs: Path-dependent and exotic options pricingtelegraph.rs: Jump-diffusion process modelingpayoff.rs: Payoff function implementationsamerican.rs: Barone-Adesi-Whaley approximationasian.rs: Asian option pricingbarrier.rs: Barrier option pricingbinary.rs: Binary/Digital option pricinglookback.rs: Lookback option pricingcompound.rs: Compound option pricingchooser.rs: Chooser option pricingcliquet.rs: Cliquet option pricingrainbow.rs: Rainbow option pricingspread.rs: Spread option pricingquanto.rs: Quanto option pricingexchange.rs: Exchange option pricingpower.rs: Power option pricingstrategies/)Comprehensive trading strategy implementations:
base.rs: Core traits (Strategable, BasicAble, Positionable, etc.)long_call.rs, short_call.rs, long_put.rs, short_put.rsbull_call_spread.rs, bear_call_spread.rs, bull_put_spread.rs, bear_put_spread.rslong_butterfly_spread.rs, short_butterfly_spread.rs, call_butterfly.rsiron_condor.rs, iron_butterfly.rslong_straddle.rs, short_straddle.rs, long_strangle.rs, short_strangle.rscovered_call.rs, poor_mans_covered_call.rsprotective_put.rs, collar.rscustom.rs: Flexible custom strategy frameworkprobabilities/: Probability analysis for strategy outcomesdelta_neutral/: Delta neutrality analysis and adjustmentvolatility/)Volatility modeling and analysis:
utils.rs: Implied volatility calculation (Newton-Raphson method)traits.rs: Volatility model interfacesgreeks/)Complete Greeks calculation suite:
chains/)Option chain management and analysis:
chain.rs: Option chain construction and manipulationutils.rs: Chain analysis and filtering toolsbacktesting/)Strategy performance analysis:
metrics.rs: Performance metrics calculationresults.rs: Backtesting results managementtypes.rs: Backtesting data structuressimulation/)Monte Carlo and stochastic simulations:
visualization/)Comprehensive plotting and charting:
plotly.rs: Interactive charts with Plotly integrationmetrics/)Performance, risk, and liquidity metrics analysis:
risk/)Risk analysis and management tools:
pnl/)Profit and loss calculation:
curves/, surfaces/)Mathematical tools for financial modeling:
error/)Robust error management:
classDiagram
class Options {
+option_type: OptionType
+side: Side
+underlying_symbol: String
+strike_price: Positive
+expiration_date: ExpirationDate
+implied_volatility: Positive
+quantity: Positive
+underlying_price: Positive
+risk_free_rate: Decimal
+option_style: OptionStyle
+dividend_yield: Positive
+exotic_params: Option~ExoticParams~
+calculate_price_black_scholes()
+calculate_price_binomial()
+time_to_expiration()
+is_long()
+is_short()
+validate()
+to_plot()
+calculate_implied_volatility()
+delta()
+gamma()
+theta()
+vega()
+rho()
+vanna()
+vomma()
+veta()
+charm()
+color()
}
class Position {
+option: Options
+position_cost: Positive
+entry_date: DateTime<Utc>
+open_fee: Positive
+close_fee: Positive
+net_cost()
+net_premium_received()
+unrealized_pnl()
+pnl_at_expiration()
+validate()
}
class Leg {
<<enumeration>>
Option(Position)
Spot(SpotPosition)
Future(FuturePosition)
Perpetual(PerpetualPosition)
+is_option()
+is_spot()
+is_linear()
+delta()
+pnl_at_price()
}
class SpotPosition {
+symbol: String
+quantity: Positive
+cost_basis: Positive
+side: Side
+date: DateTime<Utc>
+open_fee: Positive
+close_fee: Positive
+pnl_at_price()
+delta()
+market_value()
+break_even_price()
}
class ExpirationDate {
+Days(Positive)
+Date(NaiveDate)
+get_years()
+get_date()
+get_date_string()
+from_string()
}
class Positive {
+value: Decimal
+ZERO: Positive
+ONE: Positive
+format_fixed_places()
+round_to_nice_number()
+is_positive()
}
class OptionStyle {
<<enumeration>>
Call
Put
}
class OptionType {
<<enumeration>>
European
American
Bermuda
Asian
Barrier
Binary
Lookback
Compound
Chooser
Cliquet
Rainbow
Spread
Quanto
Exchange
Power
}
class Side {
<<enumeration>>
Long
Short
}
class Graph {
<<interface>>
+graph_data()
+graph_config()
+to_plot()
+write_html()
+write_png()
+write_svg()
+write_jpeg()
}
class Greeks {
<<interface>>
+delta()
+gamma()
+theta()
+vega()
+rho()
+calculate_all_greeks()
}
Options --|> Greeks : implements
Options --|> Graph : implements
Position o-- Options : contains
Leg o-- Position : Option variant
Leg o-- SpotPosition : Spot variant
SpotPosition *-- Side : has
SpotPosition *-- Positive : uses
Options *-- OptionStyle : has
Options *-- OptionType : has
Options *-- Side : has
Options *-- ExpirationDate : has
Options *-- Positive : uses
flowchart TB
subgraph Standard["Standard Options"]
EU[European]
AM[American]
BE[Bermuda]
end
subgraph PathDependent["Path-Dependent"]
AS[Asian]
LB[Lookback]
BA[Barrier]
CL[Cliquet]
end
subgraph MultiAsset["Multi-Asset"]
RB[Rainbow]
SP[Spread]
EX[Exchange]
end
subgraph Special["Special Payoffs"]
BI[Binary]
PW[Power]
QU[Quanto]
CO[Compound]
CH[Chooser]
end
BS[black_scholes] --> EU
BS --> PathDependent
BS --> MultiAsset
BS --> Special
BAW[barone_adesi_whaley] --> AM
BIN[binomial_model] --> AM
BIN --> BE
MC[monte_carlo] --> PathDependent
classDiagram
class Strategable {
<<trait>>
Master trait combining all capabilities
}
class BasicAble {
<<trait>>
+get_underlying_price()
+get_underlying_symbol()
+get_expiration()
+get_title()
}
class Positionable {
<<trait>>
+get_positions()
+add_position()
+modify_position()
}
class Strategies {
<<trait>>
+get_net_premium_received()
+get_max_profit()
+get_max_loss()
+get_total_cost()
}
class BreakEvenable {
<<trait>>
+get_break_even_points()
+calculate_break_even()
}
class Profit {
<<trait>>
+get_point_at_price()
+calculate_profit_at()
}
class Greeks {
<<trait>>
+delta()
+gamma()
+theta()
+vega()
}
class DeltaNeutrality {
<<trait>>
+get_delta()
+suggest_delta_adjustments()
}
class Graph {
<<trait>>
+to_plot()
+write_html()
+write_png()
}
Strategable --|> BasicAble
Strategable --|> Positionable
Strategable --|> Strategies
Strategable --|> BreakEvenable
Strategable --|> Profit
Strategable --|> Greeks
Strategable --|> DeltaNeutrality
Strategable --|> Graph
flowchart LR
subgraph OptionChain
OC[OptionChain]
end
subgraph Curves["Curve Metrics"]
IV_C[IV Curve]
RR_C[Risk Reversal]
DG_C[Dollar Gamma]
TH_C[Theta Curve]
VA_C[Vanna Curve]
SK_C[Skew Curve]
end
subgraph Surfaces["Surface Metrics"]
IV_S[IV Surface]
TH_S[Theta Surface]
CH_S[Charm Surface]
VS_S[Vol Sensitivity]
TD_S[Time Decay]
end
OC --> Curves
OC --> Surfaces
Curves --> |"2D Analysis"| Analysis[Risk Analysis]
Surfaces --> |"3D Analysis"| Analysis
OptionStratLib provides 25+ comprehensive trading strategies organized by complexity and market outlook:
Basic directional strategies for beginners:
Defined risk strategies with limited profit/loss:
Market neutral strategies profiting from low volatility:
Advanced strategies for experienced traders:
Strategies that profit from volatility changes:
Strategies focused on generating regular income:
Risk management and hedging strategies:
All strategies include comprehensive analysis capabilities:
All strategies implement a comprehensive trait system:
Add OptionStratLib to your Cargo.toml:
[dependencies]
optionstratlib = "0.14.3"
Or use cargo to add it to your project:
cargo add optionstratlib
The library includes optional features for enhanced functionality:
[dependencies]
optionstratlib = { version = "0.14.3", features = ["plotly"] }
plotly: Enables interactive visualization using plotly.rsasync: Enables asynchronous I/O operations for OptionChain and OHLCV dataClone the repository and build using Cargo:
git clone https://github.com/joaquinbejar/OptionStratLib.git
cd OptionStratLib
cargo build --release
Run comprehensive test suite:
cargo test --all-features
Generate documentation:
cargo doc --open --all-features
Run benchmarks:
cargo bench
use optionstratlib::{Options, OptionStyle, OptionType, Side, ExpirationDate};
use positive::{pos_or_panic,Positive};
use rust_decimal_macros::dec;
use optionstratlib::greeks::Greeks;
// Create a European call option
let option = Options::new(
OptionType::European,
Side::Long,
"AAPL".to_string(),
pos_or_panic!(150.0), // strike_price
ExpirationDate::Days(pos_or_panic!(30.0)),
pos_or_panic!(0.25), // implied_volatility
Positive::ONE, // quantity
pos_or_panic!(155.0), // underlying_price
dec!(0.05), // risk_free_rate
OptionStyle::Call,
pos_or_panic!(0.02), // dividend_yield
None, // exotic_params
);
// Calculate option price using Black-Scholes
let price = option.calculate_price_black_scholes().unwrap();
tracing::info!("Option price: ${:.2}", price);
// Calculate Greeks for risk management
let delta = option.delta().unwrap();
let gamma = option.gamma().unwrap();
let theta = option.theta().unwrap();
let vega = option.vega().unwrap();
let vanna = option.vanna().unwrap();
let vomma = option.vomma().unwrap();
let veta = option.veta().unwrap();
let charm = option.charm().unwrap();
let color = option.color().unwrap();
tracing::info!("Greeks - Delta: {:.4}, Gamma: {:.4}, Theta: {:.4},
Vega: {:.4}, Vanna: {:.4}, Vomma: {:.4}, Veta: {:.4}
Charm: {:.4}, Color: {:.4}",
delta, gamma, theta, vega, vanna, vomma, veta, charm, color);
use positive::{Positive, pos_or_panic};
use optionstratlib::ExpirationDate;
use optionstratlib::strategies::Strategies;
use optionstratlib::strategies::bull_call_spread::BullCallSpread;
use optionstratlib::strategies::base::{BreakEvenable, BasicAble};
use optionstratlib::visualization::Graph;
use rust_decimal_macros::dec;
use std::error::Error;
fn main() -> Result<(), Box<dyn Error>> {
use optionstratlib::pricing::Profit;
let underlying_price = Positive::HUNDRED;
// Create a Bull Call Spread strategy
let strategy = BullCallSpread::new(
"AAPL".to_string(),
underlying_price,
pos_or_panic!(95.0), // long_strike
pos_or_panic!(105.0), // short_strike
ExpirationDate::Days(pos_or_panic!(30.0)),
pos_or_panic!(0.25), // implied_volatility
dec!(0.05), // risk_free_rate
pos_or_panic!(2.50), // long_call_premium
pos_or_panic!(2.50), // long_call_open_fee
pos_or_panic!(1.20), // short_call_premium
pos_or_panic!(1.20), // short_call_close_fee
Default::default(), Default::default(),
Default::default(), Default::default()
);
// Analyze the strategy
tracing::info!("Strategy: {}", strategy.get_title());
tracing::info!("Break-even points: {:?}", strategy.get_break_even_points()?);
tracing::info!("Max profit: ${:.2}", strategy.get_max_profit().unwrap_or(Positive::ZERO));
tracing::info!("Max loss: ${:.2}", strategy.get_max_loss().unwrap_or(Positive::ZERO));
tracing::info!("Net premium: ${:.2}", strategy.get_net_premium_received()?);
// Calculate P&L at different price points
let prices = vec![pos_or_panic!(90.0), pos_or_panic!(95.0), Positive::HUNDRED, pos_or_panic!(105.0), pos_or_panic!(110.0)];
for price in prices {
let pnl = strategy.get_point_at_price(&price)?;
tracing::info!("P&L at ${}: ${:.2}", price, pnl.0);
}
// Generate visualization
#[cfg(feature = "plotly")]
{
strategy.write_html("Draws/Visualization/bull_call_spread.html".as_ref())?;
}
Ok(())
}
use optionstratlib::prelude::*;
fn main() -> Result<(), Box<dyn std::error::Error>> {
// Create an option for implied volatility calculation
let mut option = Options::new(
OptionType::European,
Side::Long,
"AAPL".to_string(),
pos_or_panic!(105.0), // strike
ExpirationDate::Days(pos_or_panic!(90.0)),
pos_or_panic!(0.20), // initial IV guess
Positive::ONE, // quantity
Positive::HUNDRED, // underlying price
dec!(0.05), // risk free rate
OptionStyle::Call,
pos_or_panic!(0.02), // dividend yield
None,
);
let market_price = pos_or_panic!(5.50);
let iv = implied_volatility(market_price, &mut option, 100)?;
tracing::info!("Implied volatility: {:.2}%", iv.to_f64() * 100.0);
Ok(())
}
use optionstratlib::prelude::*;
// Define common parameters
let underlying_symbol = "DAX".to_string();
let underlying_price = pos_or_panic!(24000.0);
let expiration = ExpirationDate::Days(pos_or_panic!(30.0));
let implied_volatility = pos_or_panic!(0.25);
let risk_free_rate = dec!(0.05);
let dividend_yield = pos_or_panic!(0.02);
let fee = Positive::TWO;
// Create a long put option
let long_put_option = Options::new(
OptionType::European,
Side::Long,
underlying_symbol.clone(),
pos_or_panic!(24070.0), // strike
expiration.clone(),
implied_volatility,
Positive::ONE, // quantity
underlying_price,
risk_free_rate,
OptionStyle::Put,
dividend_yield,
None,
);
let long_put = Position::new(
long_put_option,
pos_or_panic!(150.0), // premium
Utc::now(),
fee,
fee,
None,
None,
);
// Create a long call option
let long_call_option = Options::new(
OptionType::European,
Side::Long,
underlying_symbol.clone(),
pos_or_panic!(24030.0), // strike
expiration.clone(),
implied_volatility,
Positive::ONE, // quantity
underlying_price,
risk_free_rate,
OptionStyle::Call,
dividend_yield,
None,
);
let long_call = Position::new(
long_call_option,
pos_or_panic!(120.0), // premium
Utc::now(),
fee,
fee,
None,
None,
);
// Create CustomStrategy with the positions
let positions = vec![long_call, long_put];
let strategy = CustomStrategy::new(
"DAX Straddle Strategy".to_string(),
underlying_symbol,
"A DAX long straddle strategy".to_string(),
underlying_price,
positions,
Positive::ONE,
30,
implied_volatility,
);
tracing::info!("Strategy created: {}", strategy.get_title());
OptionStratLib includes a comprehensive test suite with over 3800 unit and integration tests:
Run all tests:
cargo test --all-features
Run tests for specific modules:
cargo test strategies::bull_call_spread
cargo test pricing::black_scholes
cargo test volatility::utils
Run tests with output:
cargo test -- --nocapture
proptestRun performance benchmarks:
cargo bench
Generate test coverage report:
cargo tarpaulin --all-features --out Html
The library includes extensive examples organized by functionality:
examples/examples_strategies/: Complete strategy examples (25+ strategies)examples/examples_chains/: Option chain analysis examplesexamples/examples_pricing/: Pricing model demonstrationsexamples/examples_visualization/: Interactive chart examplesexamples/examples_volatility/: Volatility analysis examplesexamples/examples_simulation/: Monte Carlo and simulation examplesexamples/examples_exotics/: Exotic option pricing examplesRun examples:
cargo run --example bull_call_spread --features plotly
cargo run --example black_scholes_pricing
cargo run --example volatility_surface
Contributions are welcome! Please follow these guidelines:
git checkout -b feature/amazing-featuregit commit -m 'Add amazing feature'git push origin feature/amazing-featuregit clone https://github.com/joaquinbejar/OptionStratLib.git
cd OptionStratLib
cargo build --all-features
cargo test --all-features
All code must pass cargo clippy without warnings
Format code with cargo fmt
Add tests for new functionality
Update documentation for API changes
Follow Rust 2024 edition best practices
OptionStratLib v0.14.3 - Built with ❤️ in Rust for the financial community
We welcome contributions to this project! If you would like to contribute, please follow these steps:
If you have any questions, issues, or would like to provide feedback, please feel free to contact the project maintainer:
We appreciate your interest and look forward to your contributions!
Licensed under MIT license