get_copy_trade_my_leaders: Get my lead traders

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

Get my lead traders

Description

Retrieve the list of lead traders you are currently copying.

Usage

get_copy_trade_my_leaders(
  inst_type = NULL,
  config,
  tz = .okx_default_tz,
  instType = inst_type
)

Arguments

inst_type	Character or 'NULL'. Filter by instrument type (e.g., '"SWAP"', '"MARGIN"', '"SPOT"'). If 'NULL', returns all.
config	List. API credentials/config, typically containing 'api_key', 'secret_key', and 'passphrase'.
tz	Character. Time zone for parsing timestamps. Default '"Asia/Hong_Kong"'.
instType	Deprecated alias for 'inst_type'.

Details

Wraps '/api/v5/copytrading/current-lead-traders'. Returns one row per lead trader followed by your account.

Value

A 'data.frame' with fields such as 'nickName' and 'uniqueCode'.

Note

Since okxr 0.1.2

See Also

[get_copy_trade_settings()], [get_copy_trade_current_subpos()]

Examples

## Not run: 
cfg <- list(api_key = "xxx", secret_key = "xxx", passphrase = "xxx")
get_copy_trade_my_leaders(inst_type = "SWAP", config = cfg)

## End(Not run)

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