get_copy_trade_settings: Get copy trading settings

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

Get copy trading settings

Description

Retrieve your account's copy trading configuration.

Usage

get_copy_trade_settings(
  unique_code,
  inst_type = NULL,
  config,
  tz = .okx_default_tz,
  uniqueCode = unique_code,
  instType = inst_type
)

Arguments

unique_code	Character. Lead trader unique code.
inst_type	Character or 'NULL'. Instrument type filter.
config	List. API credentials/config, typically containing 'api_key', 'secret_key', and 'passphrase'.
tz	Character. Time zone for parsing timestamps. Default '"Asia/Hong_Kong"'.
uniqueCode	Deprecated alias for 'unique_code'.
instType	Deprecated alias for 'inst_type'.

Details

Wraps '/api/v5/copytrading/copy-settings'. Returns one row with the current copy mode and copy state for the given 'unique_code'.

Value

A 'data.frame' with fields like 'copyMode' and 'copyState'.

Note

Since okxr 0.1.2

See Also

[get_copy_trade_my_leaders()], [get_copy_trade_current_subpos()]

Examples

## Not run: 
cfg <- list(api_key = "xxx", secret_key = "xxx", passphrase = "xxx")
get_copy_trade_settings(unique_code = "1129E65755274C36", config = cfg)

## End(Not run)

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