getEquityOptionsOverviewHistory API
getEquityOptionsOverviewHistoryThe getEquityOptionsOverviewHistory API provides implied volatility (IV) options metrics for a single equity symbol at a time. It returns historical daily values such as weighted implied volatility, IV rank and percentile, total volume, open interest, and put/call ratios.
View All APIsContact Us to Get Access
Inputs
symbolrequired
A symbol or code that identifies a financial instrument.
Type
string (A sequence of characters. (example: GOOG))
Example
SPYfieldsrequired
Type
list (A comma or semi-colon delimited string.)
Example
weightedImpliedVolatility,weightedImpliedVolatilityChange,impliedVolatilityRank1y,totalVolumestartDateoptional
The start date of the historical options data query.
Type
date (A date in the format of YYYY-MM-DD.)
Example
2025-05-17endDateoptional
The end date of the historical options data query.
Type
date (A date in the format of YYYY-MM-DD.)
Example
2025-11-17maxRecordsoptional
Type
int (A numeric type defining a whole number. (example: 2))
Example
10Outputs
weightedImpliedVolatility
The at-the-money average implied volatility (IV) of the nearest monthly options contract that is 30 days out or more, calculated using the Binomial model.
double
A numeric type defining a number with fractional parts. (example: 2.14)
A numeric type defining a number with fractional parts. (example: 2.14)
weightedImpliedVolatilityChange
The day-over-day change in the weighted implied volatility value.
double
A numeric type defining a number with fractional parts. (example: 2.14)
A numeric type defining a number with fractional parts. (example: 2.14)
impliedVolatilityRank1y
Implied volatility (IV) rank compares the current level of IV to its historical range of values over the prior 1-year. Calculation method: IV Rank = (Current IV - IV Low) / (IV High - IV Low) x 100.
double
A numeric type defining a number with fractional parts. (example: 2.14)
A numeric type defining a number with fractional parts. (example: 2.14)
impliedVolatilityPercentile1y
Implied Volatility Percentile is the percentage of days with IV closing below the current IV value over the prior 1-year. Calculation method: IV Percentile = (number of day current IV was above historical values) / (total number of days within history) * 100.
double
A numeric type defining a number with fractional parts. (example: 2.14)
A numeric type defining a number with fractional parts. (example: 2.14)
totalVolume
Total volume for all option contracts (across all expiration dates) traded during the current session.
int
A numeric type defining a whole number. (example: 2)
A numeric type defining a whole number. (example: 2)
putCallVolumeRatio
Put/Call Open Interest Ratio is the total Put Open Interest divided by the total Call Open Interest (across all expiration dates).
double
A numeric type defining a number with fractional parts. (example: 2.14)
A numeric type defining a number with fractional parts. (example: 2.14)
totalOpenInterest
Options Open Interest is the total open interest for all option contracts (across all expiration dates).
int
A numeric type defining a whole number. (example: 2)
A numeric type defining a whole number. (example: 2)
putCallOpenInterestRatio
The total put volume divided by the total call volume (across all expiration dates) based on contracts traded during the current session.
double
A numeric type defining a number with fractional parts. (example: 2.14)
A numeric type defining a number with fractional parts. (example: 2.14)
date
always returned
always returned
The date of the data referenced.
date
A date in the format of YYYY-MM-DD.
A date in the format of YYYY-MM-DD.
Status Code Responses
200
OK
Success
400
Bad Request
The request was invalid, please see the message for more information.
500
Internal Server Error
Something is not working correctly, please contact support.
JSON
GET
GET https://ondemand.websol.barchart.com/getEquityOptionsOverviewHistory.json?apikey=YOUR_API_KEY&symbol=SPY&fields=weightedImpliedVolatility%2CweightedImpliedVolatilityChange%2CimpliedVolatilityRank1y%2CtotalVolume&startDate=2025-05-17&endDate=2025-11-17&maxRecords=10
Host: ondemand.websol.barchart.com
POST
POST https://ondemand.websol.barchart.com/getEquityOptionsOverviewHistory.json
Host: ondemand.websol.barchart.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length
apikey=YOUR_API_KEY&symbol=SPY&fields=weightedImpliedVolatility%2CweightedImpliedVolatilityChange%2CimpliedVolatilityRank1y%2CtotalVolume&startDate=2025-05-17&endDate=2025-11-17&maxRecords=10
Response
{
"status": {
"code": 200,
"message": "Success."
},
"totalResults": 126,
"results": [
{
"weightedImpliedVolatility": 0.17090085944547,
"weightedImpliedVolatilityChange": 0.0011168754607791,
"impliedVolatilityRank1y": 22.464449952117,
"totalVolume": 10808207,
"date": "2025-11-14"
},
{
"weightedImpliedVolatility": 0.16978398398469,
"weightedImpliedVolatilityChange": 0.022315482451449,
"impliedVolatilityRank1y": 22.126817599342,
"totalVolume": 11971298,
"date": "2025-11-13"
},
{
"weightedImpliedVolatility": 0.14746850153324,
"weightedImpliedVolatilityChange": 0.0023636770841657,
"impliedVolatilityRank1y": 15.380829252414,
"totalVolume": 9268429,
"date": "2025-11-12"
},
{
"weightedImpliedVolatility": 0.14510482444908,
"weightedImpliedVolatilityChange": -0.0020297019709277,
"impliedVolatilityRank1y": 14.666287763097,
"totalVolume": 8181631,
"date": "2025-11-11"
},
{
"weightedImpliedVolatility": 0.14713452642001,
"weightedImpliedVolatilityChange": -0.018032234380703,
"impliedVolatilityRank1y": 15.279868306265,
"totalVolume": 10440022,
"date": "2025-11-10"
},
{
"weightedImpliedVolatility": 0.16516676080071,
"weightedImpliedVolatilityChange": -0.0010919652528912,
"impliedVolatilityRank1y": 20.731027306119,
"totalVolume": 11622635,
"date": "2025-11-07"
},
{
"weightedImpliedVolatility": 0.1662587260536,
"weightedImpliedVolatilityChange": 0.015765278290873,
"impliedVolatilityRank1y": 21.061129282954,
"totalVolume": 11422745,
"date": "2025-11-06"
},
{
"weightedImpliedVolatility": 0.15049344776273,
"weightedImpliedVolatilityChange": -0.0094817537397894,
"impliedVolatilityRank1y": 16.295272937805,
"totalVolume": 8358565,
"date": "2025-11-05"
},
{
"weightedImpliedVolatility": 0.15997520150252,
"weightedImpliedVolatilityChange": 0.013473653539937,
"impliedVolatilityRank1y": 19.161614742255,
"totalVolume": 9214104,
"date": "2025-11-04"
},
{
"weightedImpliedVolatility": 0.14650154796258,
"weightedImpliedVolatilityChange": -0.0047319313746615,
"impliedVolatilityRank1y": 15.088518407962,
"totalVolume": 9007972,
"date": "2025-11-03"
}
]
}
XML
GET
GET https://ondemand.websol.barchart.com/getEquityOptionsOverviewHistory.xml?apikey=YOUR_API_KEY&symbol=SPY&fields=weightedImpliedVolatility%2CweightedImpliedVolatilityChange%2CimpliedVolatilityRank1y%2CtotalVolume&startDate=2025-05-17&endDate=2025-11-17&maxRecords=10
Host: ondemand.websol.barchart.com
POST
POST https://ondemand.websol.barchart.com/getEquityOptionsOverviewHistory.xml
Host: ondemand.websol.barchart.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length
apikey=YOUR_API_KEY&symbol=SPY&fields=weightedImpliedVolatility%2CweightedImpliedVolatilityChange%2CimpliedVolatilityRank1y%2CtotalVolume&startDate=2025-05-17&endDate=2025-11-17&maxRecords=10
Response
<?xml version="1.0" encoding="utf-8"?>
<getEquityOptionsOverviewHistory>
<status>
<code>200</code>
<message>Success.</message>
</status>
<totalResults>126</totalResults>
<item>
<weightedImpliedVolatility>0.17090085944547</weightedImpliedVolatility>
<weightedImpliedVolatilityChange>0.0011168754607791</weightedImpliedVolatilityChange>
<impliedVolatilityRank1y>22.464449952117</impliedVolatilityRank1y>
<totalVolume>10808207</totalVolume>
<date>2025-11-14</date>
</item>
<item>
<weightedImpliedVolatility>0.16978398398469</weightedImpliedVolatility>
<weightedImpliedVolatilityChange>0.022315482451449</weightedImpliedVolatilityChange>
<impliedVolatilityRank1y>22.126817599342</impliedVolatilityRank1y>
<totalVolume>11971298</totalVolume>
<date>2025-11-13</date>
</item>
<item>
<weightedImpliedVolatility>0.14746850153324</weightedImpliedVolatility>
<weightedImpliedVolatilityChange>0.0023636770841657</weightedImpliedVolatilityChange>
<impliedVolatilityRank1y>15.380829252414</impliedVolatilityRank1y>
<totalVolume>9268429</totalVolume>
<date>2025-11-12</date>
</item>
<item>
<weightedImpliedVolatility>0.14510482444908</weightedImpliedVolatility>
<weightedImpliedVolatilityChange>-0.0020297019709277</weightedImpliedVolatilityChange>
<impliedVolatilityRank1y>14.666287763097</impliedVolatilityRank1y>
<totalVolume>8181631</totalVolume>
<date>2025-11-11</date>
</item>
<item>
<weightedImpliedVolatility>0.14713452642001</weightedImpliedVolatility>
<weightedImpliedVolatilityChange>-0.018032234380703</weightedImpliedVolatilityChange>
<impliedVolatilityRank1y>15.279868306265</impliedVolatilityRank1y>
<totalVolume>10440022</totalVolume>
<date>2025-11-10</date>
</item>
<item>
<weightedImpliedVolatility>0.16516676080071</weightedImpliedVolatility>
<weightedImpliedVolatilityChange>-0.0010919652528912</weightedImpliedVolatilityChange>
<impliedVolatilityRank1y>20.731027306119</impliedVolatilityRank1y>
<totalVolume>11622635</totalVolume>
<date>2025-11-07</date>
</item>
<item>
<weightedImpliedVolatility>0.1662587260536</weightedImpliedVolatility>
<weightedImpliedVolatilityChange>0.015765278290873</weightedImpliedVolatilityChange>
<impliedVolatilityRank1y>21.061129282954</impliedVolatilityRank1y>
<totalVolume>11422745</totalVolume>
<date>2025-11-06</date>
</item>
<item>
<weightedImpliedVolatility>0.15049344776273</weightedImpliedVolatility>
<weightedImpliedVolatilityChange>-0.0094817537397894</weightedImpliedVolatilityChange>
<impliedVolatilityRank1y>16.295272937805</impliedVolatilityRank1y>
<totalVolume>8358565</totalVolume>
<date>2025-11-05</date>
</item>
<item>
<weightedImpliedVolatility>0.15997520150252</weightedImpliedVolatility>
<weightedImpliedVolatilityChange>0.013473653539937</weightedImpliedVolatilityChange>
<impliedVolatilityRank1y>19.161614742255</impliedVolatilityRank1y>
<totalVolume>9214104</totalVolume>
<date>2025-11-04</date>
</item>
<item>
<weightedImpliedVolatility>0.14650154796258</weightedImpliedVolatility>
<weightedImpliedVolatilityChange>-0.0047319313746615</weightedImpliedVolatilityChange>
<impliedVolatilityRank1y>15.088518407962</impliedVolatilityRank1y>
<totalVolume>9007972</totalVolume>
<date>2025-11-03</date>
</item>
</getEquityOptionsOverviewHistory>
CSV
GET
GET https://ondemand.websol.barchart.com/getEquityOptionsOverviewHistory.csv?apikey=YOUR_API_KEY&symbol=SPY&fields=weightedImpliedVolatility%2CweightedImpliedVolatilityChange%2CimpliedVolatilityRank1y%2CtotalVolume&startDate=2025-05-17&endDate=2025-11-17&maxRecords=10
Host: ondemand.websol.barchart.com
POST
POST https://ondemand.websol.barchart.com/getEquityOptionsOverviewHistory.csv
Host: ondemand.websol.barchart.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length
apikey=YOUR_API_KEY&symbol=SPY&fields=weightedImpliedVolatility%2CweightedImpliedVolatilityChange%2CimpliedVolatilityRank1y%2CtotalVolume&startDate=2025-05-17&endDate=2025-11-17&maxRecords=10
Response
weightedImpliedVolatility,weightedImpliedVolatilityChange,impliedVolatilityRank1y,totalVolume,date
"0.17090085944547","0.0011168754607791","22.464449952117","10808207","2025-11-14"
"0.16978398398469","0.022315482451449","22.126817599342","11971298","2025-11-13"
"0.14746850153324","0.0023636770841657","15.380829252414","9268429","2025-11-12"
"0.14510482444908","-0.0020297019709277","14.666287763097","8181631","2025-11-11"
"0.14713452642001","-0.018032234380703","15.279868306265","10440022","2025-11-10"
"0.16516676080071","-0.0010919652528912","20.731027306119","11622635","2025-11-07"
"0.1662587260536","0.015765278290873","21.061129282954","11422745","2025-11-06"
"0.15049344776273","-0.0094817537397894","16.295272937805","8358565","2025-11-05"
"0.15997520150252","0.013473653539937","19.161614742255","9214104","2025-11-04"
"0.14650154796258","-0.0047319313746615","15.088518407962","9007972","2025-11-03"
PHP
<?php
$ondemand = new SoapClient('https://ondemand.websol.barchart.com/service?wsdl');
$params = [
'apikey' => 'YOUR_API_KEY',
'symbol' => 'SPY',
'fields' => 'weightedImpliedVolatility,weightedImpliedVolatilityChange,impliedVolatilityRank1y,totalVolume',
'startDate' => '2025-05-17',
'endDate' => '2025-11-17',
'maxRecords' => '10',
];
$result = $ondemand->getEquityOptionsOverviewHistory($params);
var_dump($result);
Classic ASP
Dim ondemand
Dim result
Set ondemand = Server.CreateObject("MSSOAP.SoapClient30")
ondemand.ClientProperty("ServerHTTPRequest") = True
ondemand.MSSoapInit("https://ondemand.websol.barchart.com/service?wsdl")
Set result = ondemand.getEquityOptionsOverviewHistory("YOUR_API_KEY", "SPY", "weightedImpliedVolatility,weightedImpliedVolatilityChange,impliedVolatilityRank1y,totalVolume", "2025-05-17", "2025-11-17", "10")
Perl
use SOAP::Lite;
use SOAP::WSDL;
my $ondemand = SOAP::Lite
-> service('https://ondemand.websol.barchart.com/service?wsdl');
my $result = $ondemand->getEquityOptionsOverviewHistory('YOUR_API_KEY', 'SPY', 'weightedImpliedVolatility,weightedImpliedVolatilityChange,impliedVolatilityRank1y,totalVolume', '2025-05-17', '2025-11-17', '10');
print $result;
Python
from suds.client import Client
ondemand = Client('https://ondemand.websol.barchart.com/service?wsdl')
result = ondemand.service.getEquityOptionsOverviewHistory('YOUR_API_KEY', 'SPY', 'weightedImpliedVolatility,weightedImpliedVolatilityChange,impliedVolatilityRank1y,totalVolume', '2025-05-17', '2025-11-17', '10')
print(result)
Ruby
require 'savon'
ondemand = Savon.client(wsdl: 'https://ondemand.websol.barchart.com/service?wsdl')
response = ondemand.call(
:getEquityOptionsOverviewHistory,
message: {
apikey: 'YOUR_API_KEY',
symbol: 'SPY',
fields: 'weightedImpliedVolatility,weightedImpliedVolatilityChange,impliedVolatilityRank1y,totalVolume',
startDate: '2025-05-17',
endDate: '2025-11-17',
maxRecords: '10',
}
)
response.body