Files
quantconnect--lean/Algorithm.Python/OptionAssignmentRegressionAlgorithm.py
T
YadavKapil 4249165f99 Fix trade statistics for option assignment underlying fills (#9627)
* Fix option assignment trade statistics

Resolve the security from each order event when updating TradeBuilder so physically settled underlying fills use the underlying multiplier and conversion rate.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Copilot-Session: 716a0df4-0117-458b-b4ac-7d8aeeb9bf48

* Resolve order event security from the event symbol

Option exercises emit the underlying fill under the option's order id, so
resolving the security from the order symbol handed the option's contract
multiplier and quote currency conversion rate to the underlying fill,
inflating closed trade statistics.

Extend the option assignment regression algorithm, in both C# and Python,
to assert every closed trade's profit and loss against its own security's
contract multiplier.

---------

Co-authored-by: Kapil Yadav <kapyadav@microsoft.com>
Co-authored-by: Jhonathan Abreu <jdabreu25@gmail.com>
2026-07-20 14:37:51 -04:00

69 lines
3.1 KiB
Python

# QUANTCONNECT.COM - Democratizing Finance, Empowering Individuals.
# Lean Algorithmic Trading Engine v2.0. Copyright 2014 QuantConnect Corporation.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
from AlgorithmImports import *
### <summary>
### This regression algorithm verifies automatic option contract assignment behavior.
### </summary>
class OptionAssignmentRegressionAlgorithm(QCAlgorithm):
def initialize(self):
self.set_start_date(2015, 12, 23)
self.set_end_date(2015, 12, 28)
self.set_cash(100000)
self.stock = self.add_equity("GOOG", Resolution.MINUTE)
contracts = list(self.option_chain(self.stock.symbol))
self.put_option_symbol = sorted(
[c for c in contracts if c.id.option_right == OptionRight.PUT and c.id.strike_price == 800],
key=lambda c: c.id.date
)[0]
self.call_option_symbol = sorted(
[c for c in contracts if c.id.option_right == OptionRight.CALL and c.id.strike_price == 600],
key=lambda c: c.id.date
)[0]
self.put_option = self.add_option_contract(self.put_option_symbol)
self.call_option = self.add_option_contract(self.call_option_symbol)
def on_data(self, data):
if not self.portfolio.invested and self.stock.price != 0 and self.put_option.price != 0 and self.call_option.price != 0:
#this gets executed on start and after each auto-assignment, finally ending with expiration assignment
if self.time < self.put_option_symbol.id.date:
self.market_order(self.put_option_symbol, -1)
if self.time < self.call_option_symbol.id.date:
self.market_order(self.call_option_symbol, -1)
def get_security(self, symbol):
if symbol == self.stock.symbol:
return self.stock
if symbol == self.call_option_symbol:
return self.call_option
if symbol == self.put_option_symbol:
return self.put_option
raise RegressionTestException(f"Unexpected symbol: {symbol}")
def on_end_of_algorithm(self):
for trade in self.trade_builder.closed_trades:
symbol, = trade.symbols
direction = 1 if trade.direction == TradeDirection.LONG else -1
multiplier = self.get_security(symbol).symbol_properties.contract_multiplier
expected_profit_loss = round((trade.exit_price - trade.entry_price) * trade.quantity * direction * multiplier, 2)
if trade.profit_loss != expected_profit_loss:
raise RegressionTestException(f"Expected underlying trade profit/loss to be {expected_profit_loss}. Actual: {trade.profit_loss}")