POST
/theo-calculator-trades
OPTIONS
Calculate theoretical option prices and market using siblings methods for trades. Trades are specified by exchange sequence number or by trade details.

Example URI

Live

https://api.livevol.com/v1/live/theo-calculator-trades

Delayed

https://api.livevol.com/v1/delayed/theo-calculator-trades

Request Information

Body Parameters

Collection of InputOptionTradeWithMode

Name Description Type Additional information
calculation_method

Calculation method

string

Allowed values are [ AUTO, BUTTERFLY_1, BUTTERFLY_2, EXTRAPOLATION, INTRADAY_LOOK_BACK, PREV_DAY_VOLATILITY, SIBLING_MARKET ]

Default value is: AUTO

market_width_scale

The user override for the default 1x-Wide limit to allow for Xx-Wide quote width limits when identifying “Valid” markets for use in calculating a theoretical price.

unsigned integer

Default value is: 1

Range: inclusive between 1 and 100

trade_price

Trade price, may be omitted if seq_number specified

decimal number

Default value is: 0

Range: inclusive between 0 and 1.79769313486232E+308

trade_size

Trade size, may be omitted if seq_number specified

integer

Default value is: 0

Range: inclusive between 0 and 2147483647

seq_number

Exchange sequence number of trade. Can be used instead of trade_price/trade_size.

integer

Default value is: 0

Range: inclusive between 0 and 2147483647

expiry

Expiration date

string

Required

Date in yyyy-MM-dd format. (i.e. 2019-01-18)

time_stamp

Timestamp (Eastern Standard Time)

string

Required

DateTime in yyyy-MM-dd HH:mm:ss.fff format. (i.e. 2021-06-11 20:13:36.555)

root

Option root

string

Required

strike

Option strike

decimal number

Required

Range: inclusive between 0.01 and 1.79769313486232E+308

option_type

Option type

string

Required

Allowed values are [ C, P ]

Request Formats

application/json, text/json

Sample:
[
  {
    "calculation_method": "AUTO",
    "market_width_scale": 1,
    "trade_price": 8.9,
    "trade_size": 18,
    "seq_number": 282836659,
    "expiry": "2019-01-18",
    "time_stamp": "2019-01-18 11:45:23.467",
    "root": "AMZN",
    "strike": 1702.5,
    "option_type": "C"
  },
  {
    "calculation_method": "BUTTERFLY_1",
    "market_width_scale": 2,
    "trade_price": 23.35,
    "trade_size": 2,
    "seq_number": 292133,
    "expiry": "2019-03-15",
    "time_stamp": "2019-01-18 09:30:00.670",
    "root": "AAPL",
    "strike": 180.0,
    "option_type": "P"
  }
]

application/xml, text/xml

Sample:
<ArrayOfinput_option_trade_with_calc_method xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <input_option_trade_with_calc_method>
    <option_type>C</option_type>
    <root>AMZN</root>
    <strike>1702.5</strike>
    <time_stamp>2019-01-18 11:45:23.467</time_stamp>
    <seq_number>282836659</seq_number>
    <trade_price>8.9</trade_price>
    <trade_size>18</trade_size>
    <calculation_method>AUTO</calculation_method>
    <market_width_scale>1</market_width_scale>
  </input_option_trade_with_calc_method>
  <input_option_trade_with_calc_method>
    <option_type>P</option_type>
    <root>AAPL</root>
    <strike>180</strike>
    <time_stamp>2019-01-18 09:30:00.670</time_stamp>
    <seq_number>292133</seq_number>
    <trade_price>23.35</trade_price>
    <trade_size>2</trade_size>
    <calculation_method>BUTTERFLY_1</calculation_method>
    <market_width_scale>2</market_width_scale>
  </input_option_trade_with_calc_method>
</ArrayOfinput_option_trade_with_calc_method>

Response Information

Resource Description

Collection of TheoCalculatorResultOfTheoCalculatorTradeInputsAndTheoCalcResults

Name Description Type Additional information SIP Provider

Inputs used for calculations

TheoCalculatorTradeInputs

None

None

TheoCalculatorTradeInputs

Name Description Type Additional information SIP Provider
trade_price

Trade price, may be omitted if seq_number specified

decimal number

None

None

trade_size

Trade size, may be omitted if seq_number specified

integer

None

None

seq_number

Exchange sequence number of trade. Can be used instead of trade_price/trade_size.

integer

Default value is: 0

Range: inclusive between 0 and 2147483647

None

calculation_method

Calculation method

string

None

None

market_width_scale

The user override for the default 1x-Wide limit to allow for Xx-Wide quote width limits when identifying “Valid” markets for use in calculating a theoretical price.

unsigned integer

Default value is: 1

Range: inclusive between 1 and 100

None

symbol

Option symbol

string

Required

None

expiry

Expiration date and time (Eastern Standard Time)

string

Required

DateTime in yyyy-MM-dd HH:mm:ss format. (i.e. 2021-06-11 20:13:36)

None

cost_of_carry

Cost of carry

decimal number

Default value is: 0

Range: inclusive between -500 and 500

None

option_style

Calculation model

string

Allowed values are [ AMERICAN, EUROPEAN ]

Default value is: AMERICAN

None

delivery_type

Delivery type

string

Allowed values are [ STANDARD, NON-STANDARD ]

Default value is: STANDARD

None

Dividends

Collection of DividendInfo

None

None

DividendInfo

Name Description Type Additional information SIP Provider
date

Ex-dividend date represented as YYYY-MM-DD

string

Required

Date in yyyy-MM-dd format. (i.e. 2019-01-18)

None

amount

Estimated amount of earnings

decimal number

Required

Range: inclusive between 0 and 1.79769313486232E+308

None

source_id

Code of dividend source. Optional. 11,42,99 - Projected dividends.

integer

Range: inclusive between 0 and 2147483647

None

model

Calculation model

string

Allowed values are [ BJERK-STETS, BLACK-SCHOLES, COX-ROSS-RUB, MAX-BJERK-BLACK, ROLL-GESKE-WHALEY ]

Default value is: COX-ROSS-RUB

None

risk_rate

Interest rate

decimal number

Default value is: 0

Range: inclusive between -500 and 500

None

stock_price

Spot price of the underlying asset

decimal number

Default value is: 0

Range: inclusive between 0 and 1.79769313486232E+308

None

option_volatility

Option volatility

decimal number

Default value is: 0

Range: inclusive between 0 and 1.79769313486232E+308

None

num_steps

Emulation steps count for binomial model

integer

Default value is: 100

Range: inclusive between 1 and 150

None

penny_class

Penny Class for root

string

Allowed values are [ 3.0, ALL, NICKEL ]

Default value is: NICKEL

None

time_stamp

Timestamp (Eastern Standard Time)

string

Required

DateTime in yyyy-MM-dd HH:mm:ss.fff format. (i.e. 2021-06-11 20:13:36.523)

None

root

Option root

string

Required

None

strike

Option strike

decimal number

Required

Range: inclusive between 0.01 and 1.79769313486232E+308

None

option_type

Option type

string

Required

Allowed values are [ C, P ]

None

Calculation results

Collection of TheoCalcResult

None

None

TheoCalcResult

Name Description Type Additional information SIP Provider
time_stamp

Trade date in yyyy-MM-dd HH:mm:ss.fff format (Eastern Standard Time)

string

None

None

First sibling market info

SiblingInfo

None

None

SiblingInfo

Name Description Type Additional information SIP Provider
strike

Option strike

decimal number

None

None

option_type

Option type

string

None

None

mid_iv

Calculated option volatility

decimal number

None

None

bid

Option bid price

decimal number

None

None

ask

Option ask price

decimal number

None

None

theo

Option theo price

decimal number

None

None

time_stamp

Date time of this snapshot in yyyy-MM-dd HH:mm:ss.fff format (Eastern Standard Time)

string

None

None

stock

Stock price used for IV calculations

decimal number

None

None

Second sibling market information

SiblingInfo

None

None

SiblingInfo

Name Description Type Additional information SIP Provider
strike

Option strike

decimal number

None

None

option_type

Option type

string

None

None

mid_iv

Calculated option volatility

decimal number

None

None

bid

Option bid price

decimal number

None

None

ask

Option ask price

decimal number

None

None

theo

Option theo price

decimal number

None

None

time_stamp

Date time of this snapshot in yyyy-MM-dd HH:mm:ss.fff format (Eastern Standard Time)

string

None

None

stock

Stock price used for IV calculations

decimal number

None

None

Market information for the target trade

SiblingInfo

None

None

SiblingInfo

Name Description Type Additional information SIP Provider
strike

Option strike

decimal number

None

None

option_type

Option type

string

None

None

mid_iv

Calculated option volatility

decimal number

None

None

bid

Option bid price

decimal number

None

None

ask

Option ask price

decimal number

None

None

theo

Option theo price

decimal number

None

None

time_stamp

Date time of this snapshot in yyyy-MM-dd HH:mm:ss.fff format (Eastern Standard Time)

string

None

None

stock

Stock price used for IV calculations

decimal number

None

None

The Calculation Method to get a volatility: 0 - Butterfly1; 1 - Butterfly2; 2 - Extrapolation; 3 - Sibling market; 4 - Previous day volatility; 5 - User defined volatility; 6 - Intraday lookback.

CalculationMethod

Range: inclusive between 0 and 6

None

CalculationMethod

Possible enumeration values:

Value Description

0

1

2

3

4

5

6

method_name

The Calculation Method name: 0 - Butterfly1; 1 - Butterfly2; 2 - Extrapolation; 3 - Sibling market; 4 - Previous day volatility; 5 - User defined volatility; 6 - Intraday lookback.

string

None

None

error_message

Error message

string

None

None

details

Calculation details

Collection of string

None

None

Response Formats