% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/okxr-package.R
\docType{package}
\name{okxr-package}
\alias{okxr}
\alias{okxr-package}
\title{okxr: R Interface to the OKX REST API}
\description{
`okxr` provides lightweight wrappers for selected OKX REST API endpoints,
including market data, account information, asset metadata, order-book trade
queries, trading actions, and copy-trading endpoints.
}
\details{
Public market and public reference endpoints can be called without
credentials. Private account, asset, trade, and copy-trading endpoints require
an OKX API credential list with `api_key`, `secret_key`, and `passphrase`
entries.

If `config$demo` is `TRUE`, signed requests include OKX's simulated trading
header. Request timeout defaults to 10 seconds and can be set globally with
`set_okxr_options(timeout = 15)` or per request with `config$timeout`.

By default, wrappers return parsed `data.table` objects. Use
`set_okxr_options(raw_data = TRUE)` to return raw API `data` payloads instead.

Network failures, request timeouts, OKX error responses, or empty API `data`
payloads may return `NULL` with a warning. Live API examples are intentionally
non-running because they require credentials, network access, and may have
account-specific side effects.
}
\seealso{
[set_okxr_options()], [get_market_candles()], [post_trade_order()]
}
\author{
\strong{Maintainer}: Oliver Zhou \email{oliver.yxzhou@gmail.com}

Authors:
\itemize{
  \item Lily Li \email{lilyli.qc.hk@gmail.com}
}

}
\keyword{package}
