% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/wrappers_get_account.R
\name{get_account_adjust_leverage_info}
\alias{get_account_adjust_leverage_info}
\title{Get account leverage adjustment estimate}
\usage{
get_account_adjust_leverage_info(
  inst_type,
  mgn_mode,
  lever,
  inst_id = NULL,
  ccy = NULL,
  pos_side = NULL,
  config,
  tz = .okx_default_tz
)
}
\arguments{
\item{inst_type}{Character. Instrument type: `"MARGIN"`, `"SWAP"`, or `"FUTURES"`.}

\item{mgn_mode}{Character. Margin mode: `"cross"` or `"isolated"`.}

\item{lever}{Character or numeric. Target leverage.}

\item{inst_id}{Character or `NULL`. Instrument ID.}

\item{ccy}{Character or `NULL`. Margin currency.}

\item{pos_side}{Character or `NULL`. Position side.}

\item{config}{List. API credentials/config.}

\item{tz}{Character. Time zone for parsing timestamps. Default `"Asia/Hong_Kong"`.}
}
\value{
A one-row `data.frame` with estimated leverage-adjustment metrics.
}
\description{
Estimate account effects under a target leverage.
}
