get_market_history_candles: Get historical market candles

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

Get historical market candles

Description

Retrieve candlestick data before a specific datetime.

Usage

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

Arguments

inst_id	Character. Instrument ID, e.g. '"BTC-USDT"'.
bar	Character. Candlestick granularity, e.g. '"1m"', '"5m"', '"1H"'.
before	Character or 'NULL'. Timestamp string like '"%Y-%m-%d %H:%M:%S"'. If 'NULL', fetch recent history.
limit	Integer. Number of bars to retrieve. 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 columns to 'timestamp', 'open', 'high', 'low', 'close', 'volume', 'volQuote'.

Details

Wraps '/api/v5/market/history-candles'. If 'before' is supplied, it is converted to milliseconds since epoch (in 'tz') and sent as 'after=...' (per OKX semantics: *return data before this time*).

Value

A 'data.frame' of candlestick bars. If 'standardize_names = TRUE', column names are normalized. Timestamps are 'POSIXct' in 'tz'.

Note

Since okxr 0.1.1

See Also

[get_market_candles()]

Examples

## Not run: 
cfg <- list(api_key = "xxx", secret_key = "xxx", passphrase = "xxx")
get_market_history_candles(
  "ETH-USDT-SWAP", bar = "1H",
  before = "2025-08-20 00:00:00", config = cfg
)

## End(Not run)

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