get_account_max_size: Get maximum order size

View source: R/wrappers_get_account.R

get_account_max_sizeR Documentation

Get maximum order size

Description

Retrieve the maximum order quantity allowed for one or more instruments under the requested trade mode.

Usage

get_account_max_size(
  inst_id,
  td_mode,
  ccy = NULL,
  px = NULL,
  leverage = NULL,
  trade_quote_ccy = NULL,
  outcome = NULL,
  config,
  tz = .okx_default_tz
)

Arguments

inst_id

Character. One instrument ID or a comma-separated list of up to five IDs in the same instrument type.

td_mode

Character. Trade mode: '"cross"', '"isolated"', '"cash"', or '"spot_isolated"'.

ccy

Character or 'NULL'. Margin currency where applicable.

px

Character, numeric, or 'NULL'. Optional price override.

leverage

Character, numeric, or 'NULL'. Optional leverage override.

trade_quote_ccy

Character or 'NULL'. Quote currency used for trading for spot instruments.

outcome

Character or 'NULL'. Events market outcome, '"yes"' or '"no"'.

config

List. API credentials/config.

tz

Character. Time zone for parsing timestamps. Default '"Asia/Hong_Kong"'.

Value

A 'data.frame' with 'instId', 'ccy', 'maxBuy', and 'maxSell'.


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