< API Reference
GET
/smart-market?root={root}&expiry={expiry}&strike={strike}&option_type={option_type}&interest_rate={interest_rate}
OPTIONS
Calculate smart market

Example URI

Live

https://api.livevol.com/v1/live/smart-market?root=AMZN&expiry=2019-02-22&strike=1415&option_type=C&interest_rate=0.0117

Delayed

https://api.livevol.com/v1/delayed/smart-market?root=AMZN&expiry=2019-02-22&strike=1415&option_type=C&interest_rate=0.0117

Request Information

URI Parameters

NameDescriptionTypeAdditional information
root

Option root

string

Required

expiry

Option expiry

string

Required

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

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 ]

interest_rate

Interest rate

decimal number

An optional request parameter, allows the user to input the interest rate for evaluation. If no input is provided, default to risk-free rate

Response Information

Resource Description

SmartMarketResponse

NameDescriptionTypeAdditional information
option

OCC Code for the option contract

string

None.

displayed_bid

Displayed market bid

decimal number

This field is only available for SIP data subscribers. If no bid available, null.

displayed_ask

Displayed market ask

decimal number

This field is only available for SIP data subscribers. If no ask available, null

displayed_bid_size

Size of displayed bid

integer

This field is only available for SIP data subscribers. If no bid available, null

displayed_ask_size

Size of displayed ask

integer

This field is only available for SIP data subscribers. If no ask available, null

smart_bid

Highest bid as a result of evaluating SmartMarkets' pricing comparisons

decimal number

If no Smart Bid found, null

smart_ask

Lowest offer as a result of evaluating SmartMarkets' pricing comparisons

decimal number

If no Smart Ask found, null

smart_bid_size

Size of Smart Bid

integer

If no Smart Bid found, null

smart_ask_size

Size of Smart Ask

integer

If no Smart Ask found, null

intrinsic_value

Intrinsic value of option

decimal number

This field is only available for SIP data subscribers. For Non-SIP subscribers, this field will be displayed only if the Intrinsic Value check returns the highest bid.

smart_bid_message

Message describing source of improved bid (if improved bid is found as a result of evaluating SmartMarkets' pricing comparisons). For SIP data subscribers, the specific option for the improved bid will be available.

string

None.

smart_ask_message

Message describing source of improved ask (if improved ask is found as a result of evaluating SmartMarkets' pricing comparisons). For SIP data subscribers, the specific option for the improved ask will be available.

string

None.

snapshot_time

Market snapshot time represented as "hh:mm:ss.000"

string

None.

smart_bid_found

Smart Bid Found

boolean

True if Smart Bid Found, otherwise False

smart_ask_found

Smart Ask Found

boolean

True if Smart Ask Found, otherwise False

Response Formats

application/json, text/json

Sample:
{
  "option": "AMZN190222C01415000",
  "displayed_bid": 285.0,
  "displayed_ask": 295.0,
  "displayed_bid_size": 2,
  "displayed_ask_size": 2,
  "smart_bid": 287.01,
  "smart_ask": 292.76,
  "smart_bid_size": 1,
  "smart_ask_size": 1,
  "intrinsic_value": 278.3,
  "smart_bid_message": "Smart Markets found based on the synthetic relationship between call and put options, the implied bid may be higher than the displayed bid.",
  "smart_ask_message": "Smart Markets found based on the synthetic relationship between call and put options, the executable ask may be lower than the displayed market.",
  "snapshot_time": "15:36:47.775",
  "smart_bid_found": true,
  "smart_ask_found": true
}

application/xml, text/xml

Sample:
<smart_market_response xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <displayed_ask>295</displayed_ask>
  <displayed_ask_size>2</displayed_ask_size>
  <displayed_bid>285</displayed_bid>
  <displayed_bid_size>2</displayed_bid_size>
  <intrinsic_value>278.3</intrinsic_value>
  <option>AMZN190222C01415000</option>
  <smart_ask>292.76</smart_ask>
  <smart_ask_found>true</smart_ask_found>
  <smart_ask_message>Smart Markets found based on the synthetic relationship between call and put options, the executable ask may be lower than the displayed market.</smart_ask_message>
  <smart_ask_size>1</smart_ask_size>
  <smart_bid>287.01</smart_bid>
  <smart_bid_found>true</smart_bid_found>
  <smart_bid_message>Smart Markets found based on the synthetic relationship between call and put options, the implied bid may be higher than the displayed bid.</smart_bid_message>
  <smart_bid_size>1</smart_bid_size>
  <snapshot_time>15:36:47.775</snapshot_time>
</smart_market_response>