Awesome

optlib

A library to fetch financial option chains and price options using closed-form solutions written in Python. Original code written by Davis Edwards, packaged by Daniel Rojas. MIT License.

Changelog

• 1/1/2017 Davis Edwards, Created GBS and Asian option formulas
• 3/2/2017 Davis Edwards, added TeX formulas to describe calculations
• 4/9/2017 Davis Edwards, added spread option (Kirk's approximation)
• 5/10/2017 Davis Edwards, added graphics for sensitivity analysis
• 5/18/2017 Davis Edwards, added Bjerksund-Stensland (2002) approximation for American Options
• 5/19/2017 Davis Edwards, added implied volatility calculations
• 6/7/2017 Davis Edwards, expanded sensitivity tests for American option approximation.
• 6/21/2017 Davis Edwards, added documentation for Bjerksund-Stensland models
• 7/21/2017 Davis Edwards, refactored all of the functions to match the parameter order to Haug's "The Complete Guide to Option Pricing Formulas".
• 08/31/2020 Daniel Rojas, Added functionality to fetch option chains using the TDAmeritrade API.
• 09/05/2020 Daniel Rojas, Added functionality to fetch historical data using the TDAmeritrade API.
• 04/10/2021 Daniel Rojas, Write classes to represent API responses

TODO List

1. Since the Asian Option valuation uses an approximation, need to determine the range of acceptable stresses that can be applied to the volatility input
2. Sub-class the custom assertions in this module to work with "unittest"
3. Update the greek calculations for American Options - currently the Greeks are approximated by the greeks from GBS model.
4. Add a bibliography referencing the academic papers used as sources
5. Finish writing documentation formulas for Close-Form approximation for American Options
6. Refactor the order of parameters for the function calls to replicate the order of parameters in academic literature
7. Add figures to README.md

Installation

To install optlib clone the repository

git clone https://github.com/BartolomeD/optlib.git

Create a virtual environment

python3 -m venv env
source env/bin/activate

and in the optlib directory execute

python setup.py install

The optlib.api module requires a TDAmeritrade API key. Create a developer account on https://developer.tdameritrade.com/ to get one.

Purpose

The software in this model is intended to price particular types of financial products called "options". These are a common type of financial product and fall into the category of "financial derivative". This documentation assumes that the reader is already familiar with options terminology. The models are largely variations of the Black Scholes Merton option framework (collectively called "Black Scholes Genre" or "Generalized Black Scholes") that are used to price European options (options that can only be exercised at one point in time). This library also includes approximations to value American options (options that can be exercised prior to the expiration date) and implied volatility calculators.

Pricing Formulas

1. black_scholes() Stock Options (no dividend yield)
2. merton() Assets with continuous dividend yield (Index Options)
3. black_76() Commodity Options
4. garman_kohlhagen() FX Options
5. asian_76() Asian Options on Commodities
6. kirks_76() Spread Options (Kirk's Approximation)
7. american() American options
8. american_76() American Commodity Options

Implied Volatility Formulas

9. euro_implied_vol() Implied volatility calculator for European options
10. euro_implied_vol_76() Implied volatility calculator for European commodity options
11. amer_implied_vol() Implied volatility calculator for American options
12. amer_implied_vol_76() Implied volatility calculator for American commodity options

Note: In honor of the black_76 model, the _76 on the end of functions indicates a commodity option.

Scope

This model is built to price financial option contracts on a wide variety of financial commodities. These options are widely used and represent the benchmark to which other (more complicated) models are compared. While those more complicated models may outperform these models in specific areas, out-performance is relatively uncommon. By an large, these models have taken on all challengers and remain the de-facto industry standard.

TDAmeritrade Option Chain API

This library provides the ability to fetch up-to-date data using TDAmeritrade'sAPI. In order to use this functionality, the user is required to get his own API key. This can be done by creating a developer account on https://developer.tdameritrade.com/.

Historical Data

The historical data API accepts the following query parameters.

• apikey. Required. Application consumer key on TDAmeritrade platform.

• symbol. Required. Symbol to get option chain for.

• periodType. The type of period to show. Valid values are day, month, year, or ytd (year to date). Default is day.

• period. The number of periods to show.

  Example: For a 2 day / 1 min chart, the values would be:

  • period: 2
  • periodType: day
  • frequency: 1
  • frequencyType: minute

  Valid periods by periodType (defaults marked with an asterisk):

  • day: 1, 2, 3, 4, 5, 10*
  • month: 1*, 2, 3, 6
  • year: 1*, 2, 3, 5, 10, 15, 20
  • ytd: 1*

• frequencyType. The type of frequency with which a new candle is formed.

  Valid frequencyTypes by periodType (defaults marked with an asterisk):

  • day: minute*
  • month: daily, weekly*
  • year: daily, weekly, monthly*
  • ytd: daily, weekly*

• frequency. The type of frequency with which a new candle is formed. Valid frequencyTypes by periodType (defaults marked with an asterisk):

  • day: minute*
  • month: daily, weekly*
  • year: daily, weekly, monthly*
  • ytd: daily, weekly*

• startDate. End date as milliseconds since epoch. If startDate and endDate are provided, period should not be provided. Default is previous trading day.

• endDate. Start date as milliseconds since epoch. If startDate and endDate are provided, period should not be provided.

• needExtendedHoursData. true to return extended hours data, false for regular market hours only. Default is true

Option Chains

The option chain API accepts the following query parameters.

• apikey. Required. Application consumer key on TDAmeritrade platform.
• symbol. Required. Symbol to get option chain for.
• contractType. Type of contracts to return in the chain. Can be CALL, PUT, or ALL. Default is ALL.
• strikeCount. The number of strikes to return above and below the at-the-money price.
• includeQuotes. Include quotes for options in the option chain. Can be TRUE or FALSE. Default is FALSE.
• strategy. Passing a value returns a Strategy Chain. For more information about strategies refer to https://www.optionsplaybook.com/option-strategies/. Default is SINGLE. Possible values are:
  • SINGLE
  • ANALYTICAL: Allows use of the volatility, underlyingPrice, interestRate, and daysToExpiration params to calculate theoretical values.
  • COVERED
  • VERTICAL
  • CALENDAR
  • STRANGLE
  • STRADDLE
  • BUTTERFLY
  • CONDOR
  • DIAGONAL
  • COLLAR
  • ROLL
• interval. Strike interval for spread strategy chains (see strategy param).
• strike. Provide a strike price to return options only at that strike price.
• range. Returns options for the given range. Default is ALL. Possible values are:
  • ITM: In-the-money
  • NTM: Near-the-money
  • OTM: Out-of-the-money
  • SAK: Strikes Above Market
  • SBK: Strikes Below Market
  • SNK: Strikes Near Market
  • ALL: All Strikes
• fromDate. Only return expirations after this date. For strategies, expiration refers to the nearest term expiration in the strategy. Valid ISO-8601 formats are: yyyy-MM-dd and yyyy-MM-dd'T'HH:mm:ssz.
• toDate: Only return expirations before this date. For strategies, expiration refers to the nearest term expiration in the strategy. Valid ISO-8601 formats are: yyyy-MM-dd and yyyy-MM-dd'T'HH:mm:ssz.
• volatility. Volatility to use in calculations. Applies only to ANALYTICAL strategy chains (see strategy param).
• underlyingPrice. Underlying price to use in calculations. Applies only to ANALYTICAL strategy chains (see strategy param).
• interestRate. Interest rate to use in calculations. Applies only to ANALYTICAL strategy chains (see strategy param).
• daysToExpiration. Days to expiration to use in calculations. Applies only to ANALYTICAL strategy chains (see strategy param).
• expMonth. Return only options expiring in the specified month. Month is given in the three character format. Example: JAN. Default is ALL.
• optionType. Type of contracts to return. Default is ALL. Possible values are:
  • S: Standard contracts
  • NS: Non-standard contracts
  • ALL: All contracts

Theory

Generalized Black Scholes

Black Scholes genre option models widely used to value European options. The original “Black Scholes” model was published in 1973 for non-dividend paying stocks. This created a revolution in quantitative finance and opened up option trading to the general population. Since that time, a wide variety of extensions to the original Black Scholes model have been created. Collectively, these are referred to as "Black Scholes genre” option models. Modifications of the formula are used to price other financial instruments like dividend paying stocks, commodity futures, and FX forwards. Mathematically, these formulas are nearly identical. The primary difference between these models is whether the asset has a carrying cost (if the asset has a cost or benefit associated with holding it) and how the asset gets present valued. To illustrate this relationship, a “generalized” form of the Black Scholes equation is shown below.

The Black Scholes model is based on number of assumptions about how financial markets operate. Black Scholes style models assume:

1. Arbitrage Free Markets. Black Scholes formulas assume that traders try to maximize their personal profits and don’t allow arbitrage opportunities (riskless opportunities to make a profit) to persist.
2. Frictionless, Continuous Markets. This assumption of frictionless markets assumes that it is possible to buy and sell any amount of the underlying at any time without transaction costs.
3. Risk Free Rates. It is possible to borrow and lend money at a risk-free interest rate
4. Log-normally Distributed Price Movements. Prices are log-normally distributed and described by Geometric Brownian Motion
5. Constant Volatility. The Black Scholes genre options formulas assume that volatility is constant across the life of the option contract.

In practice, these assumptions are not particularly limiting. The primary limitation imposed by these models is that it is possible to (reasonably) describe the dispersion of prices at some point in the future in a mathematical equation.

In the traditional Black Scholes model intended to price stock options, the underlying assumption is that the stock is traded at its present value and that prices will follow a random walk diffusion style process over time. Prices are assumed to start at the spot price and, on the average, to drift upwards over time at the risk free rate. The Merton formula modifies the basic Black Scholes equation by introducing an additional term to incorporate dividends or holding costs. The Black 76 formula modifies the assumption so that the underlying starts at some forward price rather than a spot price. A fourth variation, the Garman Kohlhagen model, is used to value foreign exchange (FX) options. In the GK model, each currency in the currency pair is discounted based on its own interest rate.

1. Black Scholes (Stocks). In the traditional Black Scholes model, the option is based on common stock - an instrument that is traded at its present value. The stock price does not get present valued – it starts at its present value (a ‘spot price’) and drifts upwards over time at the risk free rate.
2. Merton (Stocks with continuous dividend yield). The Merton model is a variation of the Black Scholes model for assets that pay dividends to shareholders. Dividends reduce the value of the option because the option owner does not own the right to dividends until the option is exercised.
3. Black 76 (Commodity Futures). The Black 76 model is for an option where the underlying commodity is traded based on a future price rather than a spot price. Instead of dealing with a spot price that drifts upwards at the risk free rate, this model deals with a forward price that needs to be present valued.
4. Garman-Kohlhagen (FX Futures). The Garman Kohlhagen model is used to value foreign exchange (FX) options. In the GK model, each currency in the currency pair is discounted based on its own interest rate.

An important concept of Black Scholes models is that the actual way that the underlying asset drifts over time isn't important to the valuation. Since European options can only be exercised when the contract expires, it is only the distribution of possible prices on that date that matters - the path that the underlying took to that point doesn't affect the value of the option. This is why the primary limitation of the model is being able to describe the dispersion of prices at some point in the future, not that the dispersion process is simplistic.

The generalized Black Scholes formula can found below (see Figure 1). While these formulas may look complicated at first glance, most of the terms can be found as part of an options contract or are prices readily available in the market. The only term that is difficult to calculate is the implied volatility (σ). Implied volatility is typically calculated using prices of other options that have recently been traded.

Call Price

Put Price

with the following intermediate calculations

and the following inputs

Figure 1. Generalized Black Scholes Formula.

The correction term, b, varies by formula – it differentiates the various Black Scholes formula from one another (see Figure 2). The cost of carry refers to the cost of “carrying” or holding a position. For example, holding a bond may result in earnings from interest, holding a stock may result in stock dividends, or the like. Those payments are made to the owner of the underlying asset and not the owner of the option. As a result, they reduce the value of the option.

Figure 2. Generalized Black Scholes Cost of Carry Adjustment.

Asian Volatility Adjustment

An Asian option is an option whose payoff is calculated using the average price of the underlying over some period of time rather than the price on the expiration date. As a result, Asian options are also called average price options. The reason that traders use Asian options is that averaging a settlement price over a period of time reduces the affect of manipulation or unusual price movements on the expiration date on the value of the option. As a result, Asian options are often found on strategically important commodities, like crude oil or in markets with intermittent trading.

The average of a set of random numbers (prices in this case) will have a lower dispersion (a lower volatility) than the dispersion of prices observed on any single day. As a result, the implied volatility used to price Asian options will usually be slightly lower than the implied volatility on a comparable European option. From a mathematical perspective, valuing an Asian option is slightly complicated since the average of a set of log-normal distributions is not itself log-normally distributed. However, a reasonably good approximation of the correct answer is not too difficult to obtain.

In the case of Asian options on futures, it is possible to use a modified Black-76 formula that replaces the implied volatility term with an adjusted implied volatility of the average price. As long as the first day of the averaging period is in the future, the following formula can be used to value Asian options (see Figure 3).

Asian Adjusted Volatility

with the intermediate calculation

Figure 3. Asian Option Formula.

Spread Option (Kirk's Approximation) Calculation

Spread options are based on the spread between two commodity prices. They are commonly used to model physical investments as "real options" or to mark-to-market contracts that hedge physical assets. For example, a natural gas fueled electrical generation unit can be used to convert fuel (natural gas) into electricity. Whenever this conversion is profitable, it would be rational to operate the unit. This type of conversion is readily modeled by a spread option. When the spread of (electricity prices - fuel costs) is greater than the conversion cost, then the unit would operate. In this example, the conversion cost, which might be called the Variable Operations and Maintenance (VOM) for a generation unit, would represent the strike price.

Analytic formulas similar to the Black Scholes equation are commonly used to value commodity spread options. One such formula is called Kirk’s approximation. While an exact closed form solution does not exist to value spread options, approximate solutions can give reasonably accurate results. Kirk’s approximation uses a Black Scholes style framework to analyze the joint distribution that results from the ratio of two log-normal distributions.

In a Black Scholes equation, the distribution of price returns is assumed to be normally distributed on the expiration date. Kirk’s approximation builds on the Black Scholes framework by taking advantage of the fact that the ratio of two log-normal distributions is approximately normally distributed. By modeling a ratio of two prices rather than the spread between the prices, Kirk’s approximation can use the same formulas designed for options based on a single underlying. In other words, Kirk’s approximation uses an algebraic transformation to fit the spread option into the Black Scholes framework.

The payoff of a spread option is show in Figure 4.

Figure 4. Spread Option Payoff.

Where

Figure 4. Spread Option Payoff.

This can be algebraically manipulated as shown in Figure 5.

Figure 5. - Spread Option Payoff, Manipulated.

This allows Kirk’s approximation to model the distribution of the spread as the ratio of the price of asset 1 over the price of asset 2 plus the strike price. This ratio can then be converted into a formula very similar to the Generalized Black Scholes formulas. In fact, this is the Black Scholes formula shown above with the addition of a (F_2 + X) term (see Figure 6).

Ratio of prices

The ratio implies that the option is profitable to exercise (in the money) whenever the ratio of prices (F in the formula above) is greater than 1. This occurs the cost of the finished product (F_1) exceeds total cost of the raw materials (F_2) and the conversion cost (X). This requires a modification to the Call/Put Price formulas and to the D_1 formula. Because the option is in the money when F>1, the "strike" price used in inner square brackets of the Call/Put Price formulas and the D1 formula is set to 1.

Spread Option Call Price

Spread Option Put Price

Figure 6. Kirk's Approximation Ratio.

The key complexity is determining the appropriate volatility that needs to be used in the equation. The “approximation” which defines Kirk’s approximation is the assumption that the ratio of two log-normal distributions is normally distributed. That assumption makes it possible to estimate the volatility needed for the modified Black Scholes style equation (see Figure 7).

Figure 7. Kirk's Approximation (Volatility).

A second complexity is that the prices of two assets (F1 and F2) have to be in the same units. For example, in a heat rate option, the option represents the ability to convert fuel (natural gas) into electricity. The price of the first asset, electricity, might be quoted in US dollars per megawatt-hour or USD/MWH. However, the price of the second asset might be quoted in USD/MMBTU. To use the approximation, it is necessary to convert the price of the second asset into the units of the first asset (See Example 1 - a Heat Rate Option). This conversion rate will typically be specified as part of the contract.

Example: A 10 MMBTU/MWH heat rate call option

• F1 = price of electricity = USD 35/MWH
• F2* = price of natural gas = USD 3.40/MMBTU; This is not the price to plug into the model!
• V1 = volatility of electricity forward prices = 35%
• V2 = volatility of natural gas forward price = 35%
• Rho = correlation between electricity and natural gas forward prices = 90%
• VOM = variable operation and maintenance cost (the conversion cost) = USD 3/MWH

Before being placed into a spread option model, the price of natural gas would need to be converted into the correct units.

• F2 = Heat Rate * Fuel Cost = (10 MMBTU/MWH)(USD 3.40/MMBTU) = USD 34/MWH

The strike price would be set equal to the conversion cost

• X = VOM costs = USD 3/MWH

Example 1. A Heat Rate Call Option.

Another important consideration (not discussed in this write-up) is that volatility and correlation need to be matched to the tenor of the underlying assets. This means that it is necessary to measure the volatility of forward prices rather than spot prices. It may also be necessary to match the volatility and correlation to the correct month. For example, power prices in August may behave very differently than power prices in October or May in certain regions.

Like any model, spread options are subject to the "garbage in = garbage out" problem. However, the relative complexity of modeling commodity prices (the typical underlying for spread options) makes calibrating inputs a key part of the model.

American Options

American options differ from European options because they can be exercised at any time. If there is a possibility that it will be more profitable to exercise the option than sell it, an American option will have more value than a corresponding European option. Early exercise typically occurs only when an option is in the money. If an option is out of the money, there is usually no reason to exercise early - it would be better to sell the option (in the case of a put option, to sell the option and the underlying asset).

The decision of whether to exercise early is primarily a question of interest rates and carrying costs. Carrying costs, or cost of carry, is a term that means an intermediate cash flows that is the result of holding an asset. For example, dividends on stocks are a positive cost of carry (owning the asset gives the owner a cash flow). A commodity might have a negative cost of carry. For example, a commodity that requires its owner to pay for storage would cause the owner of the physical commodity to pay cash to hold the asset. (Note: Commodity options are typically written on forwards or futures which have zero cost of carry instead of the actual underlying commodity). Cost of carry is cash flow that affects the owner of the underlying commodity and not the owner of the option. For example, when a stock pays a dividend, the owner of a call option does not receive the dividend - just the owner of the stock. For the perspective for the owner of a call option on a stock, the cost of carry will be the interest received from holding cash (r) less any dividends paid to owners of the stock (q).

Since an option has some value (the extrinsic value) that would be given up by exercising the option, exercising an option prior to maturity is a trade off between the option's extrinsic value (the remaining optionality) and the relative benefit of holding cash (time value of money) versus the benefit of holding the asset (carrying costs).

The early exercise feature of American equity put options may have value when:

• The cost of carry on the asset is low - preferably zero or negative.
• Interest rates are high
• The option is in the money

The early exercise feature of American equity call options may have value when:

• The cost of carry on the asset is positive
• Interest rates are low or negative
• The option is in the money

With commodities, things are a slightly different. There is typically no cost of carry since the underlying is a forward or a futures contract. It does not cost any money to enter an at-the-money commodity forward, swap, or futures contract. Also, these contracts don't have any intermediate cash flows. As a result, the primary benefit of early exercise is to get cash immediately (exercising an in-the-money option) rather than cash in the future. In high interest rate environments, the money received immediately from immediate execution may exceed the extrinsic value of the contract. This is due to strike price not being present valued in immediate execution (it is specified in the contract and a fixed number) but the payoff of a European option is discounted (forward price - strike price).

The overall result is that early exercise is fairly uncommon for most commodity options. Typically, it only occurs when interest rates are high. Generally, interest rates have to be higher than 15%-20% for American commodity options to differ substantially in value from European options with the same terms.

The early exercise feature of American commodity options has value when:

• Interest rates are high
• Volatility is low (this makes selling the option less of a good option)
• The option is in the money

There is no exact closed-form solution for American options. However, there are many approximations that are reasonably close to prices produced by open-form solutions (like binomial tree models). Two models are shown below, both created by Bjerksund and Stensland. The first was produced in 1993 and the second in 2002. The second model is a refinement of the first model, adding more complexity, in exchange for better accuracy.

Put-Call Parity

Because of Put/Call parity, it is possible to use a call valuation formula to calculate the value of a put option.

or using the order of parameters used in this library:

Bjerksund Stensland 1993 (BS1993)

There is no closed form solution for American options, and there are multiple people who have developed closed-form approximations to value American options. This is one such approximation. However, this approximation is no longer in active use by the public interface. It is primarily included as a secondary test on the BS2002 calculation. This function uses a numerical approximation to estimate the value of an American option. It does this by estimating a early exercise boundary and analytically estimating the probability of hitting that boundary. This uses the same inputs as a Generalized Black Scholes model:

    FS = Forward or spot price (abbreviated FS in code, F in formulas below)
    X = Strike Price
    T = time to expiration
    r = risk free rate
    b = cost of carry
    V = volatility

Intermediate Calculations. To be consistent with the Bjerksund Stensland paper, this write-up uses similar notation. Please note that both a capital B (B_0 and B_Infinity), a lower case b, and the Greek symbol Beta are all being used. B_0 and B_infinity represent that optimal exercise boundaries in edge cases (for call options where T=0 and T=infinity respectively), lower case b is the cost of carry (passed in as an input), and Beta is an intermediate calculations.

Calculate the Early Exercise Boundary (i). The lower case i represents the early exercise boundary. Alpha is an intermediate calculation.

Check for immediate exercise.

If no immediate exercise, approximate the early exercise price.

Compare to European Value. Due to the approximation, it is sometime possible to get a value slightly smaller than the European value. If so, set the value equal to the European value estimated using Generalized Black Scholes.

Bjerksund Stensland 2002 (BS2002)

Source: https://www.researchgate.net/publication/228801918

    FS = Forward or spot price (abbreviated FS in code, F in formulas below)
    X = Strike Price
    T = time to expiration
    r = risk free rate
    b = cost of carry
    V = volatility

Psi

Psi is an intermediate calculation used by the Bjerksund Stensland 2002 approximation.

Intermediate calculations. The Psi function has a large number of intermediate calculations. For clarity, these are loosely organized into groups with each group used to simplify the next set of intermediate calculations.

More Intermediate calculations

Even More Intermediate calculations

The calculation of Psi. This is the actual calculation of the Psi function. In the function below, M() represents the cumulative bivariate normal distribution (described a couple of paragraphs below this section). The abbreviation M() is used instead of CBND() in this section to make the equation a bit more readable and to match the naming convention used in Haug's book "The Complete Guide to Option Pricing Formulas".

Phi

Phi is an intermediate calculation used by both the Bjerksun Stensland 1993 and 2002 approximations. Many of the parameters are the same as the GBS model.

    FS = Forward or spot price (abbreviated FS in code, F in formulas below).
    T = time to expiration.
    I =  trigger price (as calculated in either BS1993 or BS2002 formulas
    gamma = modifier to T, calculated in BS1993 or BS2002 formula
    r = risk free rate.
    b = cost of carry.
    V = volatility.

Internally, the Phi() function is implemented as follows:

Normal Cumulative Density Function (N)

This is the normal cumulative density function. It can be found described in a variety of statistical textbooks and/or Wikipedia. It is part of the standard scipy.stats distribution and imported using the from scipy.stats import norm command.

Example:

Cumulative bivariate normal distribution (CBND)

The bivariate normal density function (BNDF) is given below (see Figure 8):

Figure 8. Bivariate Normal Density Function (BNDF).

This can be integrated over x and y to calculate the joint probability that x < a and y < b. This is called the cumulative bivariate normal distribution (CBND; see Figure 9):

Figure 9. Cumulative Bivariate Normal Distribution (CBND).

Where

• x = the first variable
• y = the second variable
• a = upper bound for first variable
• b = upper bound for second variable
• p = correlation between first and second variables

There is no closed-form solution for this equation. However, several approximations have been developed and are included in the numpy library distributed with Anaconda. The Genz 2004 model was chosen for implementation. Alternative models include those developed by Drezner and Wesolowsky (1990) and Drezner (1978). The Genz model improves these other model by going to an accuracy of 14 decimal points (from approximately 8 decimal points and 6 decimal points respectively).

Limitations

These functions have been tested for accuracy within an allowable range of inputs (see "Model Input" section below). However, general modeling advice applies to the use of the model. These models depend on a number of assumptions. In plain English, these models assume that the distribution of future prices can be described by variables like implied volatility. To get good results from the model, the model should only be used with reliable inputs.

The following limitations are also in effect:

1. The Asian Option approximation shouldn't be used for Asian options that are into the Asian option calculation period.
2. The American and American76 approximations break down when r < -20%. The limits are set wider in this example for testing purposes, but production code should probably limit interest rates to values between -20% and 100%. In practice, negative interest rates should be extremely rare.
3. No Greeks are produced for spread options
4. These models assume a constant volatility term structure. This has no effect on European options. However, options that are likely to be exercise early (certain American options) and Asian options may be more affected.

Model Inputs

This section describes the function calls an inputs needed to call this model:

These functions encapsulate the most commonly encountered option pricing formulas. These function primarily figure out the cost-of-carry term (b) and then call the generic version of the function. All of these functions return an array containing the premium and the Greeks.

Public Functions in the Library

Pricing Formulas

1. black_scholes(option_type, fs, x, t, r, v)
2. merton(option_type, fs, x, t, r, q, v)
3. black_76(option_type, fs, x, t, r, v)
4. garman_kohlhagen(option_type, fs, x, t, b, r, rf, v)
5. asian_76(option_type, fs, x, t, t_a, r, v)
6. kirks_76(option_type, f1, f2, x, t, r, v1, v2, corr)
7. american(option_type, fs, x, t, r, q, v)
8. american_76(option_type, fs, x, t, r, v)

Implied Volatility Formulas

9. euro_implied_vol(option_type, fs, x, t, r, q, cp)
10. euro_implied_vol_76(option_type, fs, x, t, r, cp)
11. amer_implied_vol(option_type, fs, x, t, r, q, cp)
12. amer_implied_vol_76(option_type, fs, x, t, r, cp)

Inputs used by all models

Inputs used by some models

Outputs

All of the option pricing functions return an array. The first element of the array is the value of the option, the other elements are the Greeks which measure the sensitivity of the option to changes in inputs. The Greeks are used primarily for risk-management purposes.

The implied volatility functions return a single value (the implied volatility).

Acceptable Range for inputs

All of the inputs are bounded. While many of these functions will work with inputs outside of these bounds, they haven't been tested and are generally believed to be uncommon. The pricer will return an exception to the caller if an out-of-bounds input is used. If that was a valid input, the code below will need to be modified to allow wider inputs and the testing section updated to test that the models work under the widened inputs.