get_account_max_avail_size: Get maximum available tradable amount

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

Get maximum available tradable amount

Description

Retrieve the maximum available buy and sell amount for an instrument under the requested trade mode.

Usage

get_account_max_avail_size(
  inst_id,
  td_mode,
  ccy = NULL,
  reduce_only = NULL,
  px = NULL,
  trade_quote_ccy = NULL,
  config,
  tz = .okx_default_tz
)

Arguments

inst_id	Character. One instrument ID or a comma-separated list of up to five IDs.
td_mode	Character. Trade mode: '"cross"', '"isolated"', '"cash"', or '"spot_isolated"'.
ccy	Character or 'NULL'. Margin currency where applicable.
reduce_only	Logical, character, or 'NULL'. Whether to reduce position only. Only applicable to margin endpoints that support it.
px	Character, numeric, or 'NULL'. Optional closing price, when supported by OKX.
trade_quote_ccy	Character or 'NULL'. Quote currency used for trading for spot instruments.
config	List. API credentials/config.
tz	Character. Time zone for parsing timestamps. Default '"Asia/Hong_Kong"'.

Value

A 'data.frame' with 'instId', 'availBuy', and 'availSell'.

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