get_public_opt_summary: Get option summary

View source: R/wrappers_get_market.R

get_public_opt_summaryR Documentation

Get option summary

Description

Retrieve option market summary data for an instrument family.

Usage

get_public_opt_summary(
  inst_family,
  exp_time = NULL,
  config = NULL,
  tz = .okx_default_tz
)

Arguments

inst_family

Character. Option instrument family.

exp_time

Character or 'NULL'. Expiry date in 'YYMMDD'.

config

Optional list. Public endpoint request options, such as 'timeout'; credentials are not required.

tz

Character. Time zone for parsing timestamps. Default '"Asia/Hong_Kong"'.

Value

A 'data.frame' with option greeks, volatility, forward price, and timestamp fields.


okxr documentation built on May 8, 2026, 5:09 p.m.