Introduction
This API call is used to retrieve summary information for options contracts for the specified symbol from a database and returns the results as either JSON or CSV. The API call takes in the symbol, format (JSON or CSV), and the maxRows (optional) as parameters and returns a list of summary information for options contracts for the symbol. The summary information returned includes information such as the underlying asset, expiration date, option type, strike price, bid, ask, last price, volume, and open interest. The data can be returned in either JSON or CSV format.
Endpoint
/option-summary/:symbol/:format?/:maxRows?
Parameters
- symbol (string, required) – The symbol of the underlying asset for which to retrieve summary information.
- format (string, required) – The format to return the data in. Valid options: ‘json’ or ‘csv’.
- maxRows (integer, optional) – The maximum number of rows to return.
Examples
List of several example calls, URLs, and responses to show users how to interact with the API call. These examples should include a variety of input parameters to demonstrate the different scenarios that the API call can handle.
Related Calls
None
Error Handling
If no data comes back, please check for valid input parameters.
Example Response
{
"quotedate": "2023-04-21T00:00:00.000Z",
"symbol": "NVDA",
"volume_call": 371566,
"volume_put": 466649,
"volume_total": 838215,
"oi_call": 1502784,
"oi_put": 1811149,
"oi_total": 3313933,
"oi_putcallratio": 0,
"iv30_call": 0.4226,
"iv30_put": 0.4066,
"iv30_mean": 0.4146,
"iv60_call": 0.3996,
"iv60_put": 0.4324,
"iv60_mean": 0.416,
"iv90_call": 0.4422,
"iv90_put": 0.4281,
"iv90_mean": 0.4352
}