get_public_open_interest: Get open interest

In okxr: R Interface to the 'OKX' REST API

Get open interest

Description

Retrieve current open interest for an instrument.

Usage

get_public_open_interest(
  inst_id,
  inst_type,
  config = NULL,
  tz = .okx_default_tz
)

Arguments

inst_id	Character. Instrument ID, e.g. '"BTC-USDT-SWAP"'.
inst_type	Character. Instrument type such as '"SWAP"' or '"FUTURES"'.
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' containing open interest fields returned by OKX.

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