get_market_mark_price_candles: Get mark price candles

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

Get mark price candles

Description

Retrieve recent candlestick data for the mark price of an instrument.

Usage

get_market_mark_price_candles(
  inst_id,
  bar = NULL,
  after = NULL,
  before = NULL,
  limit = 100L,
  config = NULL,
  tz = .okx_default_tz,
  standardize_names = TRUE
)

Arguments

inst_id	Character. Instrument ID.
bar	Character or 'NULL'. Bar size.
after	Character or 'NULL'. Pagination cursor for older rows.
before	Character or 'NULL'. Pagination cursor for newer rows.
limit	Integer. Number of rows to request. Default '100L'.
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"'.
standardize_names	Logical. If 'TRUE' (default), renames OHLC columns to 'timestamp', 'open', 'high', 'low', and 'close'.

Value

A 'data.frame' of mark-price candlesticks.

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