get_account_adjust_leverage_info: Get account leverage adjustment estimate

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

Get account leverage adjustment estimate

Description

Estimate account effects under a target leverage.

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

inst_type	Character. Instrument type: '"MARGIN"', '"SWAP"', or '"FUTURES"'.
mgn_mode	Character. Margin mode: '"cross"' or '"isolated"'.
lever	Character or numeric. Target leverage.
inst_id	Character or 'NULL'. Instrument ID.
ccy	Character or 'NULL'. Margin currency.
pos_side	Character or 'NULL'. Position side.
config	List. API credentials/config.
tz	Character. Time zone for parsing timestamps. Default '"Asia/Hong_Kong"'.

Value

A one-row 'data.frame' with estimated leverage-adjustment metrics.

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