get_public_estimated_price: Get estimated delivery or exercise price

View source: R/wrappers_get_market.R

get_public_estimated_priceR Documentation

Get estimated delivery or exercise price

Description

Retrieve the estimated delivery, exercise, or settlement price for derivatives and events instruments.

Usage

get_public_estimated_price(
  inst_type,
  inst_family = NULL,
  inst_id = NULL,
  config = NULL,
  tz = .okx_default_tz
)

Arguments

inst_type

Character. Instrument type, such as '"FUTURES"', '"OPTION"', '"SWAP"', or '"EVENTS"'.

inst_family

Character or 'NULL'. Instrument family filter.

inst_id

Character or 'NULL'. Specific instrument ID filter.

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 'instType', 'instId', 'settlePx', and 'ts'.


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