get_public_premium_history: Get premium history

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

Get premium history

Description

Retrieve premium-index history for an instrument.

Usage

get_public_premium_history(
  inst_id,
  after = NULL,
  before = NULL,
  bar = NULL,
  limit = NULL,
  config = NULL,
  tz = .okx_default_tz
)

Arguments

inst_id	Character. Instrument ID.
after	Character or 'NULL'. Pagination cursor for older rows.
before	Character or 'NULL'. Pagination cursor for newer rows.
bar	Character or 'NULL'. Bar size such as '"1m"' or '"1H"'.
limit	Integer or 'NULL'. Number of rows to request.
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 'instId', 'premium', and 'ts'.

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