Total open interest and volume aggregated by ticker

Total open interest and volume aggregated by ticker Javascript API Documentation

Returns total open interest and volume by ticker

API Class:
OptionsApi
Instance Method:
getOptionAggregates()

Stock Price Code Example

Use my API Key
var intrinioSDK = require('intrinio-sdk');
intrinioSDK.ApiClient.instance.authentications['ApiKeyAuth'].apiKey = "YOUR_API_KEY";
intrinioSDK.ApiClient.instance.enableRetries = true;
var options = new intrinioSDK.OptionsApi();
var opts = {
'date': "2024-04-24",
'pageSize': 100,
'nextPage': null
};
options.getOptionAggregates(opts).then(function(data) {
data = JSON.stringify(data, null, 2)
console.log(data);
}, function(error) {
console.error(error);
});
הההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההה
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

Parameters

NameTypeDescriptionNotes
dateObjectReturn aggregated data for this date[optional]  
pageSizeNumberThe number of results to return[optional] [default to 100]  
nextPageStringGets the next page of data from a previous API call[optional]  


Return Type

object
ApiResponseOptionsAggregates

Properties

NameTypeDescription
aggregates[OptionsAggregate]A list of option expiration dates in descending order  
nextPageStringThe token required to request the next page of the data. If null, no further results are available.  
object
OptionsAggregate

Properties

NameTypeDescription
tickerStringThe ticker symbol of the Security for the Option.  
dateStringThe date of the data.  
totalOpenInterestNumberTotal open interest for the ticker  
totalVolumeNumberTotal volume for the ticker  
totalPutVolumeNumberTotal put volume for the ticker  
totalCallVolumeNumberTotal call volume for the ticker  
putCallVolumeRatioNumberTotal put volume to total call volume ratio for the ticker  
contractCountNumberTotal number of active contracts for the ticker