get_account_leverage_info: Get account leverage settings

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

Get account leverage settings

Description

Retrieve leverage configuration for a given instrument and margin mode.

Usage

get_account_leverage_info(
  inst_id,
  mgn_mode,
  config,
  tz = .okx_default_tz
)

Arguments

inst_id	Character. Instrument ID, e.g. '"BTC-USDT"'.
mgn_mode	Character. Margin mode. One of '"cross"' or '"isolated"'.
config	List. API credentials/config, typically containing 'api_key', 'secret_key', and 'passphrase'.
tz	Character. Time zone for parsing timestamps. Default '"Asia/Hong_Kong"'.

Details

Wraps '/api/v5/account/leverage-info'. Requires both 'inst_id' and 'mgn_mode'. Returns current leverage values (numeric).

Value

A 'data.frame' with columns 'instId', 'mgnMode', 'posSide', and 'lever'.

Note

Since okxr 0.1.1

See Also

[get_account_balance()], [get_account_positions()]

Examples

## Not run: 
cfg <- list(api_key = "xxx", secret_key = "xxx", passphrase = "xxx")
get_account_leverage_info(
  inst_id = "BTC-USDT",
  mgn_mode = "cross",
  config = cfg
)

## End(Not run)

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