get_account_max_loan: Get account maximum loan

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

Get account maximum loan

Description

Retrieve the maximum loan for manual borrow or margin borrowing scenarios.

Usage

get_account_max_loan(
  mgn_mode,
  inst_id = NULL,
  ccy = NULL,
  mgn_ccy = NULL,
  trade_quote_ccy = NULL,
  config,
  tz = .okx_default_tz
)

Arguments

mgn_mode	Character. Margin mode: '"cross"' or '"isolated"'.
inst_id	Character or 'NULL'. Instrument ID(s).
ccy	Character or 'NULL'. Currency.
mgn_ccy	Character or 'NULL'. Margin currency.
trade_quote_ccy	Character or 'NULL'. Quote currency for trading.
config	List. API credentials/config.
tz	Character. Time zone for parsing timestamps. Default '"Asia/Hong_Kong"'.

Value

A 'data.frame' with 'instId', 'mgnMode', 'mgnCcy', 'maxLoan', 'ccy', and 'side'.

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