Skip to main content

Calculate estimated margin requirements for equities options, based on CBOE margining.

Project description

margin-estimator

Calculate estimated margin requirements for equities options, based on CBOE margining.

[!NOTE] Box spreads and some complex multi-legged positions may be calculated too conservatively.

Installation

$ pip install margin_estimator

Usage

Simply pass an arbitrary list of legs to the calculate_margin function along with an Underlying object containing information on the underlying, and you'll get back margin requirement estimates for cash and margin accounts!

from datetime import date
from decimal import Decimal
from margin_estimator import (
    ETFType,
    Option,
    OptionType,
    Shares,
    Underlying,
    calculate_margin,
)

# a SPY iron condor
# make sure to pass `ETFType.BROAD` for broad-based indices
underlying = Underlying(price=Decimal("587.88"), etf_type=ETFType.BROAD)
expiration = date(2024, 12, 20)
long_put = Option(
    expiration=expiration,
    price=Decimal("4.78"),
    quantity=1,
    strike=Decimal(567),
    type=OptionType.PUT,
)
short_put = Option(
    expiration=expiration,
    price=Decimal("5.61"),
    quantity=-1,
    strike=Decimal(572),
    type=OptionType.PUT,
)
short_call = Option(
    expiration=expiration,
    price=Decimal("5.23"),
    quantity=-1,
    strike=Decimal(602),
    type=OptionType.CALL,
)
long_call = Option(
    expiration=expiration,
    price=Decimal("3.68"),
    quantity=1,
    strike=Decimal(607),
    type=OptionType.CALL,
)
margin = calculate_margin(
    [long_put, short_put, long_call, short_call], underlying
)
print(margin)
>>> cash_requirement=Decimal('262.00') margin_requirement=Decimal('262.00')

For normal equities you can omit the etf_type parameter:

# a short F put
underlying = Underlying(price=Decimal("11.03"))
expiration = date(2024, 12, 20)
put = Option(
    expiration=expiration,
    price=Decimal("0.45"),
    quantity=-1,
    strike=Decimal(11),
    type=OptionType.PUT,
)
margin = calculate_margin([put], underlying)
print(margin)
>>> cash_requirement=Decimal('1055.00') margin_requirement=Decimal('263.00')

And for leveraged products, you'll need to pass in the leverage_factor:

# a naked TQQQ call
underlying = Underlying(
    price=Decimal("77.35"),
    etf_type=ETFType.BROAD,
    leverage_factor=Decimal(3),
)
expiration = date(2024, 12, 20)
call = Option(
    expiration=expiration,
    price=Decimal("4.45"),
    quantity=-1,
    strike=Decimal(80),
    type=OptionType.CALL,
)
margin = calculate_margin([call], underlying)
print(margin)
>>> cash_requirement=Decimal('7555.00') margin_requirement=Decimal('3661.00')

You can even add shares of an underlying to calculate requirements for covered legs:

# a covered SPY call
underlying = Underlying(price=Decimal("740"))
expiration = date(2026, 5, 15)
call = Option(
    expiration=expiration,
    price=Decimal("4.45"),
    quantity=-1,
    strike=Decimal(780),
    type=OptionType.CALL,
)
shares = Shares(price=Decimal("700.41"), quantity=100)
margin = calculate_margin([call, shares], underlying)
print(margin)
>>> cash_requirement=Decimal('70041.00') margin_requirement=Decimal('35020.00')

Please note that all numbers are baseline minimums from CBOE guidelines and individual broker margins will likely vary significantly.

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

margin_estimator-0.4.1.tar.gz (17.2 kB view details)

Uploaded Source

Built Distribution

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

margin_estimator-0.4.1-py3-none-any.whl (7.9 kB view details)

Uploaded Python 3

File details

Details for the file margin_estimator-0.4.1.tar.gz.

File metadata

  • Download URL: margin_estimator-0.4.1.tar.gz
  • Upload date:
  • Size: 17.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for margin_estimator-0.4.1.tar.gz
Algorithm Hash digest
SHA256 b0e25a57e2bd56eb6d3ba41f7603e794eb8d3c0add0dac91e98d9f5bd9c7689f
MD5 4973f394b81def5221ed81a6e3775715
BLAKE2b-256 21f074a759483242973ddb2ed9689ed6407385d5e78a4d95ca8af8bda36b92f0

See more details on using hashes here.

Provenance

The following attestation bundles were made for margin_estimator-0.4.1.tar.gz:

Publisher: publish.yml on tastyware/margin-estimator

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file margin_estimator-0.4.1-py3-none-any.whl.

File metadata

File hashes

Hashes for margin_estimator-0.4.1-py3-none-any.whl
Algorithm Hash digest
SHA256 685821a23f4e42b9f8551c956f042a4dbd07513d67058f391c4923a5b1edf8dd
MD5 ba4ece5dd0b998667b8ab1bf6180b1f5
BLAKE2b-256 38306aa2c32029f2b41bc08359b0339fa8c21ae6ad2d29442edad35d17222d82

See more details on using hashes here.

Provenance

The following attestation bundles were made for margin_estimator-0.4.1-py3-none-any.whl:

Publisher: publish.yml on tastyware/margin-estimator

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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