% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/wrappers_get_copy_trade.R
\name{get_copy_trade_settings}
\alias{get_copy_trade_settings}
\title{Get copy trading settings}
\usage{
get_copy_trade_settings(
  unique_code,
  inst_type = NULL,
  config,
  tz = .okx_default_tz,
  uniqueCode = unique_code,
  instType = inst_type
)
}
\arguments{
\item{unique_code}{Character. Lead trader unique code.}

\item{inst_type}{Character or `NULL`. Instrument type filter.}

\item{config}{List. API credentials/config, typically containing
`api_key`, `secret_key`, and `passphrase`.}

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

\item{uniqueCode}{Deprecated alias for `unique_code`.}

\item{instType}{Deprecated alias for `inst_type`.}
}
\value{
A `data.frame` with fields like `copyMode` and `copyState`.
}
\description{
Retrieve your account's copy trading configuration.
}
\details{
Wraps `/api/v5/copytrading/copy-settings`. Returns one row with the
current copy mode and copy state for the given `unique_code`.
}
\note{
Since okxr 0.1.2
}
\examples{
\dontrun{
cfg <- list(api_key = "xxx", secret_key = "xxx", passphrase = "xxx")
get_copy_trade_settings(unique_code = "1129E65755274C36", config = cfg)
}

}
\seealso{
[get_copy_trade_my_leaders()], [get_copy_trade_current_subpos()]
}
