< API Reference
GET
/market/symbols/{symbol}/option-trades-volume?date={date}
OPTIONS
Get option trades volume for an underlying

Example URI

Live

https://api.livevol.com/v1/live/market/symbols/AAPL/option-trades-volume?date=2019-01-18

Delayed

https://api.livevol.com/v1/delayed/market/symbols/AAPL/option-trades-volume?date=2019-01-18

Request Information

URI Parameters

NameDescriptionTypeAdditional information
symbol

Stock symbol

string

Required

date

Trading date

string

Required

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

Response Information

Resource Description

Collection of OptionTradesVolume

NameDescriptionTypeAdditional information
root

Root

string

None.

expiry

Expiration date

string

None.

strike

Strike

decimal number

None.

call_volume

Call Volume

integer

None.

put_volume

Put Volume

integer

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "root": "CBOE",
    "expiry": "2016-06-01",
    "strike": 10.05,
    "call_volume": 253,
    "put_volume": 0
  },
  {
    "root": "AAPL",
    "expiry": "2016-06-02",
    "strike": 10.95,
    "call_volume": 1870,
    "put_volume": 165
  }
]

application/xml, text/xml

Sample:
<option_trade_volumes xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <option_trade_volume>
    <call_volume>253</call_volume>
    <expiry>2016-06-01</expiry>
    <put_volume>0</put_volume>
    <root>CBOE</root>
    <strike>10.05</strike>
  </option_trade_volume>
  <option_trade_volume>
    <call_volume>1870</call_volume>
    <expiry>2016-06-02</expiry>
    <put_volume>165</put_volume>
    <root>AAPL</root>
    <strike>10.95</strike>
  </option_trade_volume>
</option_trade_volumes>