% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/wrappers_get_market.R
\name{get_market_candles}
\alias{get_market_candles}
\title{Get recent market candles}
\usage{
get_market_candles(
  inst_id,
  bar,
  limit = 100L,
  config = NULL,
  tz = .okx_default_tz,
  standardize_names = TRUE
)
}
\arguments{
\item{inst_id}{Character. Instrument ID, e.g. `"BTC-USDT"`, `"ETH-USDT-SWAP"`.}

\item{bar}{Character. Candlestick granularity, e.g. `"1m"`, `"5m"`, `"1H"`, `"1D"`.}

\item{limit}{Integer. Number of bars to retrieve. Default `100L`.}

\item{config}{Optional list. Public endpoint request options, such as
`timeout`; credentials are not required.}

\item{tz}{Character. Time zone for parsing timestamps. Default `"Asia/Hong_Kong"`.}

\item{standardize_names}{Logical. If `TRUE` (default), renames columns to
`timestamp`, `open`, `high`, `low`, `close`, `volume`, `volQuote`.}
}
\value{
A `data.frame` with columns including `timestamp`, `open`, `high`, `low`,
`close`, `volume`, and `volQuote`. Timestamps are `POSIXct` in `tz`.
}
\description{
Retrieve the latest candlestick data for a given instrument and bar size.
}
\details{
Wraps `/api/v5/market/candles`. Returns up to `limit` bars, sorted by
timestamp. Candlestick fields can be standardized to common OHLCV names via
`standardize_names = TRUE`.
}
\note{
Since okxr 0.1.1
}
\examples{
\dontrun{
cfg <- list(api_key = "xxx", secret_key = "xxx", passphrase = "xxx")
get_market_candles("BTC-USDT", bar = "5m", limit = 50, config = cfg)
}

}
\seealso{
[get_market_history_candles()], [get_public_mark_price()]
}
