Package {okxr}

okxr: R Interface to the OKX REST API

Description

'okxr' provides lightweight wrappers for selected OKX REST API endpoints, including market data, account information, asset metadata, order-book trade queries, trading actions, and copy-trading endpoints.

Details

Public market and public reference endpoints can be called without credentials. Private account, asset, trade, and copy-trading endpoints require an OKX API credential list with 'api_key', 'secret_key', and 'passphrase' entries.

If ‘config$demo' is 'TRUE', signed requests include OKX’s simulated trading header. Request timeout defaults to 10 seconds and can be set globally with 'set_okxr_options(timeout = 15)' or per request with 'config$timeout'.

By default, wrappers return parsed 'data.table' objects. Use 'set_okxr_options(raw_data = TRUE)' to return raw API 'data' payloads instead.

Network failures, request timeouts, OKX error responses, or empty API 'data' payloads may return 'NULL' with a warning. Live API examples are intentionally non-running because they require credentials, network access, and may have account-specific side effects.

Author(s)

Maintainer: Oliver Zhou oliver.yxzhou@gmail.com

Authors:

• Lily Li lilyli.qc.hk@gmail.com

See Also

[set_okxr_options()], [get_market_candles()], [post_trade_order()]

Build a full OKX request object

Description

Assemble URL, headers, and body for an OKX API call.

Usage

.build_request(
  httr_method,
  base_url,
  api_path,
  query_string,
  config = NULL,
  body_json = "",
  auth = TRUE
)

Arguments

Value

A list with elements: 'method', 'url', 'full_path', 'headers', and 'body_json'.

Execute a GET request to OKX

Description

Perform a signed GET call to the OKX API.

Usage

.execute_get_action(
  api_path,
  query_string,
  config = NULL,
  auth = TRUE
)

Arguments

Value

An 'httr' response object, or 'NULL' if the request fails.

Execute a POST request to OKX

Description

Perform a signed POST call to the OKX API.

Usage

.execute_post_action(api_path, body_list, config)

Arguments

Value

An 'httr' response object, or 'NULL' if the request fails.

Create OKX API request headers

Description

Generate the required signed headers for an OKX REST request.

Usage

.get_headers(config, httr_method, httr_path, body_json = "")

Arguments

Value

A 'httr::add_headers' object containing the signed headers.

GET request function list

Description

A list of endpoint functions automatically generated from .api_GET_specs. Each function supports tz, config, and additional endpoint-specific arguments.

Usage

.gets

Format

An object of class list of length 123.

Create a GET request function from an API spec

Description

Converts a single entry from .api_GET_specs into a ready-to-use function that executes the HTTP GET request, parses the response, and returns a typed data frame.

Usage

.make_get_function(api)

Arguments

Value

A function with signature (tz = "Asia/Hong_Kong", config, ...) that:

• builds the query string using api$query (if a function),

• signs and sends the GET request,

• parses and returns the data using the schema-aware parser.

Build a typed OKX JSON response parser (named or positional) to data.table

Description

Constructs and returns a parser function that converts an OKX REST API JSON response into a typed data.table, using a provided field schema and a parsing mode. Supports both key-based ("named") and index-based ("positional") endpoints. For "named" endpoints returning a single object, the parser wraps it as a one-row table.

Usage

.make_parser(schema, mode = c("named", "positional", "vector"))

Arguments

Details

• Typing: Columns are preallocated per schema$type. Time fields are interpreted as UNIX milliseconds.

• Modes:

  • "named" - fields accessed via okx keys; a single object in $data is wrapped to one row.

  • "positional" - fields accessed by index order of schema.

  • "vector" - scalar or vector payloads returned in one column.

• Attributes: attr(DT, "var_labels") maps okx to formal.

Value

A function with signature function(res, tz) where:

res

An httr::response. The body must decode to a list with $code, $msg, and $data.

tz

Time zone for "time" fields. Millisecond values are converted with as.POSIXct().

The returned parser yields a data.table with column names from schema$okx and attaches variable labels as attr(DT, "var_labels") (a named character vector formal by okx). Returns NULL if the API code is not "0" or if $data is empty.

Errors & warnings

If parsed$code != "0", a warning with parsed$msg is emitted and NULL is returned.

Create a POST request function from an API spec

Description

Converts a single entry from .api_POST_specs into a function that sends a POST request to the OKX API and returns the parsed response using the provided schema.

Usage

.make_post_function(api)

Arguments

Value

A function with signature (body_list, tz, config) that:

• Converts the body list to JSON,

• Signs and sends the POST request,

• Parses and returns the response using the schema-aware parser.

Internal OKX request helpers

Description

Shared helpers for request validation, query construction, and package-wide defaults used by user-facing wrappers.

Usage

.okx_default_tz

Format

An object of class character of length 1.

POST request function list

Description

A list of POST endpoint functions generated from .api_POST_specs. Each function has the form (body_list, tz, config) and returns a parsed result.

Usage

.posts

Format

An object of class list of length 31.

Get account leverage adjustment estimate

Description

Estimate account effects under a target leverage.

Usage

get_account_adjust_leverage_info(
  inst_type,
  mgn_mode,
  lever,
  inst_id = NULL,
  ccy = NULL,
  pos_side = NULL,
  config,
  tz = .okx_default_tz
)

Arguments

Value

A one-row 'data.frame' with estimated leverage-adjustment metrics.

Get account balance

Description

Retrieve account-level margin and equity information for your OKX account.

Usage

get_account_balance(config, tz = .okx_default_tz)

Arguments

Details

This wraps '/api/v5/account/balance'. Returns one row per account-level equity snapshot. Timestamps are parsed into 'POSIXct' in the given 'tz'.

Value

A 'data.frame' with account balance and margin metrics (e.g., 'totalEq', 'isoEq', 'adjEq', 'availEq', 'ordFroz', 'imr', 'mmr', 'upl', 'mgnRatio', ...). Timestamp columns ('uTime') are 'POSIXct'.

Note

Since okxr 0.1.1

See Also

[get_account_positions()], [get_account_leverage_info()]

Examples

## Not run: 
cfg <- list(api_key = "xxx", secret_key = "xxx", passphrase = "xxx")
bal <- get_account_balance(config = cfg)
head(bal)

## End(Not run)

Get account bills

Description

Retrieve account bill details from the last 7 days.

Usage

get_account_bills(
  inst_type = NULL,
  ccy = NULL,
  mgn_mode = NULL,
  ct_type = NULL,
  type = NULL,
  sub_type = NULL,
  after = NULL,
  before = NULL,
  limit = NULL,
  config,
  tz = .okx_default_tz
)

Arguments

Value

A 'data.frame' with account bill rows.

Get archived account bills

Description

Retrieve archived account bill details.

Usage

get_account_bills_archive(
  inst_type = NULL,
  ccy = NULL,
  mgn_mode = NULL,
  ct_type = NULL,
  type = NULL,
  sub_type = NULL,
  after = NULL,
  before = NULL,
  limit = NULL,
  config,
  tz = .okx_default_tz
)

Arguments

Value

A 'data.frame' with archived account bill rows.

Get archived account bill export links

Description

Retrieve the generated CSV export link for historical account bills since 2021.

Usage

get_account_bills_history_archive(
  year,
  quarter,
  type = NULL,
  config,
  tz = .okx_default_tz
)

Arguments

Value

A 'data.frame' with file-link status rows.

Get account collateral assets

Description

Retrieve collateral-enabled status for one or more currencies.

Usage

get_account_collateral_assets(
  ccy = NULL,
  collateral_enabled = NULL,
  config,
  tz = .okx_default_tz
)

Arguments

Value

A 'data.frame' with currency-level collateral flags.

Get account configuration

Description

Retrieve account-level configuration information.

Usage

get_account_config(config, tz = .okx_default_tz)

Arguments

Details

Wraps '/api/v5/account/config'. Includes account ID, mode, and position mode flags. Returns one row.

Value

A 'data.frame' with columns like 'uid', 'mainUid', 'acctLv', 'posMode', 'autoLoan', etc.

Note

Since okxr 0.1.2

See Also

[get_account_balance()], [get_account_leverage_info()]

Examples

## Not run: 
cfg <- list(api_key = "xxx", secret_key = "xxx", passphrase = "xxx")
cfg_info <- get_account_config(config = cfg)
cfg_info

## End(Not run)

Get account Greeks

Description

Retrieve currency-level Greeks across the account.

Usage

get_account_greeks(ccy = NULL, config, tz = .okx_default_tz)

Arguments

Value

A 'data.frame' with one row per currency and Greek metrics in both Black-Scholes and coin terms.

Get account-available instruments

Description

Retrieve available instruments for the current account and instrument type.

Usage

get_account_instruments(
  inst_type,
  uly = NULL,
  inst_family = NULL,
  inst_id = NULL,
  config,
  tz = .okx_default_tz
)

Arguments

Details

Wraps '/api/v5/account/instruments'. This endpoint is account-scoped and may return a subset of instruments available to the authenticated account.

Value

A 'data.frame' with account-available instrument metadata, including identifiers, currencies, tick size, lot size, leverage, expiry/listing timestamps, and state where returned by OKX.

Get account interest accrued history

Description

Retrieve accrued borrowing interest records for the past year.

Usage

get_account_interest_accrued(
  type = NULL,
  ccy = NULL,
  inst_id = NULL,
  mgn_mode = NULL,
  after = NULL,
  before = NULL,
  limit = NULL,
  config,
  tz = .okx_default_tz
)

Arguments

Value

A 'data.frame' with one row per accrued-interest event.

Get account borrow interest and limits

Description

Retrieve account-level debt, next accrual timestamps, and nested per-currency borrowing-limit records.

Usage

get_account_interest_limits(
  type = NULL,
  ccy = NULL,
  config,
  tz = .okx_default_tz
)

Arguments

Value

A 'data.frame' with account-level limit fields; nested per-currency 'records' are JSON-encoded.

Get account borrowing interest rates

Description

Retrieve the current leveraged currency borrowing market interest rate for one currency or for all eligible currencies.

Usage

get_account_interest_rate(
  ccy = NULL,
  config,
  tz = .okx_default_tz
)

Arguments

Value

A 'data.frame' with 'ccy' and 'interestRate'.

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

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)

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

Value

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

Get account maximum loan

Description

Retrieve the maximum loan for manual borrow or margin borrowing scenarios.

Usage

get_account_max_loan(
  mgn_mode,
  inst_id = NULL,
  ccy = NULL,
  mgn_ccy = NULL,
  trade_quote_ccy = NULL,
  config,
  tz = .okx_default_tz
)

Arguments

Value

A 'data.frame' with 'instId', 'mgnMode', 'mgnCcy', 'maxLoan', 'ccy', and 'side'.

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

Value

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

Get account maximum withdrawals

Description

Retrieve the maximum transferable amount from trading to funding account.

Usage

get_account_max_withdrawal(
  ccy = NULL,
  config,
  tz = .okx_default_tz
)

Arguments

Value

A 'data.frame' with per-currency maximum withdrawal values.

Get account MMP configuration

Description

Retrieve option-market-maker-protection configuration for one or more instrument families.

Usage

get_account_mmp_config(
  inst_family = NULL,
  config,
  tz = .okx_default_tz
)

Arguments

Value

A 'data.frame' with MMP configuration fields.

Get account move positions history

Description

Retrieve move-position requests from the last three days.

Usage

get_account_move_positions_history(
  block_td_id = NULL,
  client_id = NULL,
  begin_ts = NULL,
  end_ts = NULL,
  limit = NULL,
  state = NULL,
  config,
  tz = .okx_default_tz
)

Arguments

Value

A 'data.frame' with top-level move-position metadata; nested 'legs' are JSON-encoded.

Get account and position risk snapshot

Description

Retrieve account-level adjusted equity together with same-snapshot balance and position risk payloads.

Usage

get_account_position_risk(
  inst_type = NULL,
  config,
  tz = .okx_default_tz
)

Arguments

Value

A 'data.frame' with one row per OKX risk snapshot. Nested balance and position payloads are returned as JSON strings in 'balData' and 'posData'.

Get account position tiers

Description

Retrieve portfolio-margin position limits for one or more instrument families.

Usage

get_account_position_tiers(
  inst_type,
  inst_family,
  config,
  tz = .okx_default_tz
)

Arguments

Value

A 'data.frame' with instrument-family position limits.

Get account open positions

Description

Retrieve all currently open positions under the account.

Usage

get_account_positions(config, tz = .okx_default_tz)

Arguments

Details

Wraps '/api/v5/account/positions'. Returns one row per open position.

Value

A 'data.frame' with columns such as 'instId', 'posId', 'posSide', 'pos', 'lever', 'avgPx', 'markPx', 'upl', 'realizedPnl', etc. Timestamps ('cTime', 'uTime') are 'POSIXct'.

Note

Since okxr 0.1.1

See Also

[get_account_balance()], [get_account_positions_history()]

Examples

## Not run: 
cfg <- list(api_key = "xxx", secret_key = "xxx", passphrase = "xxx")
pos <- get_account_positions(config = cfg)
pos

## End(Not run)

Get account position history

Description

Retrieve historical records of closed or adjusted positions.

Usage

get_account_positions_history(config, tz = .okx_default_tz)

Arguments

Details

Wraps '/api/v5/account/positions-history'. Includes closed positions and their realized PnL. Returns one row per historical record.

Value

A 'data.frame' with columns such as 'instId', 'posId', 'posSide', 'pos', 'lever', 'realizedPnl', 'fee', plus timestamp fields ('cTime', 'uTime').

Note

Since okxr 0.1.1

See Also

[get_account_positions()]

Examples

## Not run: 
cfg <- list(api_key = "xxx", secret_key = "xxx", passphrase = "xxx")
hist <- get_account_positions_history(config = cfg)
tail(hist)

## End(Not run)

Precheck delta-neutral strategy switch

Description

Retrieve unmatched information that blocks switching into the requested strategy type.

Usage

get_account_precheck_set_delta_neutral(
  stgy_type,
  config,
  tz = .okx_default_tz
)

Arguments

Value

A one-row 'data.frame' with JSON-encoded unmatched information.

Get account risk state

Description

Retrieve portfolio-margin account risk flags and affected risk units.

Usage

get_account_risk_state(config, tz = .okx_default_tz)

Arguments

Value

A one-row 'data.frame' with the account risk flag and JSON-encoded risk-unit arrays.

Precheck account mode switch

Description

Retrieve precheck information and any unmatched requirements for switching to a target account mode.

Usage

get_account_set_account_switch_precheck(
  acct_lv,
  config,
  tz = .okx_default_tz
)

Arguments

Value

A 'data.frame' with switch-precheck fields; nested margin and unmatched-information structures are JSON-encoded.

Get spot borrow and repay history

Description

Retrieve spot-mode borrow and repay history.

Usage

get_account_spot_borrow_repay_history(
  ccy = NULL,
  type = NULL,
  after = NULL,
  before = NULL,
  limit = NULL,
  config,
  tz = .okx_default_tz
)

Arguments

Value

A 'data.frame' with one row per borrow or repay event.

Get sub-account trading balances

Description

Retrieve account-level trading balances for a sub-account from the master account.

Usage

get_account_subaccount_balances(
  sub_acct,
  config,
  tz = .okx_default_tz
)

Arguments

Value

A 'data.frame' with account-level balance fields; nested per-currency 'details' are JSON-encoded.

Get sub-account maximum withdrawals

Description

Retrieve the maximum withdrawal information for a sub-account from the master account.

Usage

get_account_subaccount_max_withdrawal(
  sub_acct,
  ccy = NULL,
  config,
  tz = .okx_default_tz
)

Arguments

Value

A 'data.frame' with per-currency maximum withdrawal values.

Get account bill subtypes

Description

Retrieve available account bill types and subtype descriptions.

Usage

get_account_subtypes(type = NULL, config, tz = .okx_default_tz)

Arguments

Value

A 'data.frame' with bill type descriptions and JSON-encoded 'subTypeDetails'.

Get account trade fee rates

Description

Retrieve the account's trade fee schedule for a specific instrument type and optional instrument, instrument family, or trading fee group.

Usage

get_account_trade_fee(
  inst_type,
  inst_id = NULL,
  inst_family = NULL,
  group_id = NULL,
  config,
  tz = .okx_default_tz
)

Arguments

Value

A 'data.frame' with fee level, fee-rate columns, and any nested 'feeGroup' or deprecated 'fiat' details JSON-encoded as strings.

Get asset valuation

Description

Retrieve total account valuation for funding assets.

Usage

get_asset_asset_valuation(
  ccy = NULL,
  config,
  tz = .okx_default_tz
)

Arguments

Value

A data.frame with valuation summary rows.

Get asset balances

Description

Retrieves the available, total, and frozen balance for each asset in the account.

Usage

get_asset_balances(config, tz = .okx_default_tz)

Arguments

Value

A data.frame with balances per currency.

Get asset bills

Description

Retrieve recent funding account bills.

Usage

get_asset_bills(
  ccy = NULL,
  type = NULL,
  client_id = NULL,
  after = NULL,
  before = NULL,
  limit = NULL,
  config,
  tz = .okx_default_tz
)

Arguments

Value

A data.frame with asset bill rows.

Get asset bills history

Description

Retrieve historical funding account bills.

Usage

get_asset_bills_history(
  ccy = NULL,
  type = NULL,
  client_id = NULL,
  after = NULL,
  before = NULL,
  limit = NULL,
  paging_type = NULL,
  config,
  tz = .okx_default_tz
)

Arguments

Value

A data.frame with historical asset bill rows.

Get convert currencies

Description

Retrieve currencies supported by the asset convert API.

Usage

get_asset_convert_currencies(config, tz = .okx_default_tz)

Arguments

Value

A data.frame with supported convert currencies.

Get convert currency pair

Description

Retrieve convert metadata for a currency pair.

Usage

get_asset_convert_currency_pair(
  from_ccy,
  to_ccy,
  convert_mode = NULL,
  config,
  tz = .okx_default_tz
)

Arguments

Value

A data.frame with currency-pair convert metadata.

Get convert history

Description

Retrieve historical asset convert trades.

Usage

get_asset_convert_history(
  cl_t_req_id = NULL,
  after = NULL,
  before = NULL,
  limit = NULL,
  tag = NULL,
  config,
  tz = .okx_default_tz
)

Arguments

Value

A data.frame with convert history rows.

Get funding currencies

Description

Retrieve currencies available to the current account.

Usage

get_asset_currencies(ccy = NULL, config, tz = .okx_default_tz)

Arguments

Value

A data.frame with currency and chain metadata.

Get deposit address

Description

Retrieve deposit addresses for a currency.

Usage

get_asset_deposit_address(ccy, config, tz = .okx_default_tz)

Arguments

Value

A data.frame with deposit address rows.

Get asset deposit history

Description

Retrieves a record of all asset deposits made to your account.

Usage

get_asset_deposit_history(
  ccy = NULL,
  dep_id = NULL,
  from_wd_id = NULL,
  tx_id = NULL,
  type = NULL,
  state = NULL,
  after = NULL,
  before = NULL,
  limit = NULL,
  config,
  tz = .okx_default_tz
)

Arguments

Value

A data.frame with deposit history rows and detailed transfer metadata.

Get deposit or withdrawal status

Description

Retrieve detailed status for a deposit or withdrawal.

Usage

get_asset_deposit_withdraw_status(
  wd_id = NULL,
  tx_id = NULL,
  ccy = NULL,
  to = NULL,
  chain = NULL,
  config,
  tz = .okx_default_tz
)

Arguments

Value

A data.frame with detailed deposit/withdraw status rows.

Get exchange list

Description

Retrieve the public exchange list used by asset withdrawal metadata.

Usage

get_asset_exchange_list(tz = .okx_default_tz)

Arguments

Value

A data.frame with exchange identifiers and names.

Get non-tradable assets

Description

Retrieve balances and withdrawal metadata for non-tradable assets.

Usage

get_asset_non_tradable_assets(
  ccy = NULL,
  config,
  tz = .okx_default_tz
)

Arguments

Value

A data.frame with non-tradable asset rows.

Get asset transfer state

Description

Retrieve the state of a funding transfer.

Usage

get_asset_transfer_state(
  trans_id = NULL,
  client_id = NULL,
  type = NULL,
  config,
  tz = .okx_default_tz
)

Arguments

Value

A data.frame with transfer state rows.

Get asset withdrawal history

Description

Retrieves a record of all asset withdrawals from your account.

Usage

get_asset_withdrawal_history(
  ccy = NULL,
  wd_id = NULL,
  client_id = NULL,
  tx_id = NULL,
  type = NULL,
  state = NULL,
  after = NULL,
  before = NULL,
  limit = NULL,
  config,
  tz = .okx_default_tz
)

Arguments

Value

A data.frame with withdrawal history rows and detailed transfer metadata.

Get copy trading config

Description

Retrieve your account-level copy trading configuration.

Usage

get_copy_trade_config(config, tz = .okx_default_tz)

Arguments

Value

A 'data.frame' with top-level copy trading configuration fields. Nested 'details' are returned as a JSON string column.

Get current copy trading subpositions

Description

Retrieve your currently active subpositions under copy trading.

Usage

get_copy_trade_current_subpos(
  inst_type = NULL,
  inst_id = NULL,
  after = NULL,
  before = NULL,
  limit = NULL,
  config,
  tz = .okx_default_tz
)

Arguments

Details

Wraps '/api/v5/copytrading/current-subpositions'. Returns one row per subposition, associated with the relevant lead trader.

Value

A 'data.frame' with fields like 'instId' and 'uniqueCode'.

Note

Since okxr 0.1.2

See Also

[get_copy_trade_historical_subpos()]

Examples

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

## End(Not run)

Get historical copy trading subpositions

Description

Retrieve your historical copy trading subpositions.

Usage

get_copy_trade_historical_subpos(
  inst_type = NULL,
  inst_id = NULL,
  after = NULL,
  before = NULL,
  limit = NULL,
  config,
  tz = .okx_default_tz
)

Arguments

Details

Wraps '/api/v5/copytrading/subpositions-history'. Returns one row per closed or historical subposition.

Value

A 'data.frame' with fields like 'instId' and 'uniqueCode'.

Note

Since okxr 0.1.2

See Also

[get_copy_trade_current_subpos()]

Examples

## Not run: 
cfg <- list(api_key = "xxx", secret_key = "xxx", passphrase = "xxx")
hist <- get_copy_trade_historical_subpos(config = cfg)
head(hist)

## End(Not run)

Get copy trading instruments

Description

Retrieve instruments currently available for copy trading.

Usage

get_copy_trade_instruments(
  inst_type = NULL,
  config,
  tz = .okx_default_tz
)

Arguments

Value

A 'data.frame' with one row per instrument and an 'enabled' flag.

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

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)

Get profit sharing details

Description

Retrieve realized profit sharing detail rows.

Usage

get_copy_trade_profit_sharing_details(
  inst_type = NULL,
  after = NULL,
  before = NULL,
  limit = NULL,
  config,
  tz = .okx_default_tz
)

Arguments

Value

A 'data.frame' with realized profit sharing rows.

Get public copy trading config

Description

Retrieve public copy trading limits and ratio bounds.

Usage

get_copy_trade_public_config(
  inst_type = NULL,
  tz = .okx_default_tz
)

Arguments

Value

A 'data.frame' with public copy trading configuration fields.

Get public copy trader summary

Description

Retrieve public copy trader summary metrics for a lead trader.

Usage

get_copy_trade_public_copy_traders(
  unique_code,
  inst_type = NULL,
  limit = NULL,
  tz = .okx_default_tz
)

Arguments

Value

A 'data.frame' with summary metrics and a JSON-string 'copyTraders' column for nested trader details.

Get public current copy trading subpositions

Description

Retrieve public current subpositions for a lead trader.

Usage

get_copy_trade_public_current_subpositions(
  unique_code,
  inst_type = NULL,
  after = NULL,
  before = NULL,
  limit = NULL,
  tz = .okx_default_tz
)

Arguments

Value

A 'data.frame' with one row per current public subposition.

Get public lead trader ranks

Description

Retrieve ranked public lead trader summaries.

Usage

get_copy_trade_public_lead_traders(
  inst_type = NULL,
  sort_type = NULL,
  state = NULL,
  min_lead_days = NULL,
  min_assets = NULL,
  max_assets = NULL,
  min_aum = NULL,
  max_aum = NULL,
  data_ver = NULL,
  page = NULL,
  limit = NULL,
  tz = .okx_default_tz
)

Arguments

Value

A 'data.frame' with top-level ranking metadata and a JSON-string 'ranks' column for nested leader rows.

Get public copy trading pnl

Description

Retrieve public pnl time windows for a lead trader.

Usage

get_copy_trade_public_pnl(
  unique_code,
  last_days,
  inst_type = NULL,
  tz = .okx_default_tz
)

Arguments

Value

A 'data.frame' with pnl windows and ratios.

Get public preference currencies

Description

Retrieve the most frequently traded currencies for a lead trader.

Usage

get_copy_trade_public_preference_currency(
  unique_code,
  inst_type = NULL,
  tz = .okx_default_tz
)

Arguments

Value

A 'data.frame' with preferred currencies and their ratios.

Get public copy trading stats

Description

Retrieve public copy trading performance stats for a lead trader.

Usage

get_copy_trade_public_stats(
  unique_code,
  last_days,
  inst_type = NULL,
  tz = .okx_default_tz
)

Arguments

Value

A 'data.frame' with copy trading summary statistics.

Get public historical copy trading subpositions

Description

Retrieve public historical subpositions for a lead trader.

Usage

get_copy_trade_public_subpositions_history(
  unique_code,
  inst_type = NULL,
  after = NULL,
  before = NULL,
  limit = NULL,
  tz = .okx_default_tz
)

Arguments

Value

A 'data.frame' with one row per historical public subposition.

Get public copy trading weekly pnl

Description

Retrieve public weekly pnl series for a lead trader.

Usage

get_copy_trade_public_weekly_pnl(
  unique_code,
  inst_type = NULL,
  tz = .okx_default_tz
)

Arguments

Value

A 'data.frame' with weekly pnl windows and ratios.

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

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)

Get total profit sharing

Description

Retrieve total realized profit sharing by instrument type.

Usage

get_copy_trade_total_profit_sharing(
  inst_type = NULL,
  config,
  tz = .okx_default_tz
)

Arguments

Value

A 'data.frame' with total realized profit sharing rows.

Get total unrealized profit sharing

Description

Retrieve total unrealized profit sharing by instrument type.

Usage

get_copy_trade_total_unrealized_profit_sharing(
  inst_type = NULL,
  config,
  tz = .okx_default_tz
)

Arguments

Value

A 'data.frame' with total unrealized profit sharing rows.

Get unrealized profit sharing details

Description

Retrieve unrealized profit sharing detail rows.

Usage

get_copy_trade_unrealized_profit_sharing_details(
  inst_type = NULL,
  config,
  tz = .okx_default_tz
)

Arguments

Value

A 'data.frame' with unrealized profit sharing rows.

Get block ticker

Description

Retrieve the latest 24-hour block-trading volume for a single instrument.

Usage

get_market_block_ticker(
  inst_id,
  config = NULL,
  tz = .okx_default_tz
)

Arguments

Value

A one-row 'data.frame' with block trading volume fields.

Get block tickers

Description

Retrieve the latest 24-hour block-trading volume for instruments under an instrument type.

Usage

get_market_block_tickers(
  inst_type,
  inst_family = NULL,
  config = NULL,
  tz = .okx_default_tz
)

Arguments

Value

A 'data.frame' with one row per block ticker.

Get order book

Description

Retrieve the current order book for an instrument.

Usage

get_market_books(
  inst_id,
  sz = NULL,
  config = NULL,
  tz = .okx_default_tz
)

Arguments

Value

A 'data.frame' with JSON-encoded 'asks' and 'bids' columns plus 'ts'.

Get recent market candles

Description

Retrieve the latest candlestick data for a given instrument and bar size.

Usage

get_market_candles(
  inst_id,
  bar,
  limit = 100L,
  config = NULL,
  tz = .okx_default_tz,
  standardize_names = TRUE
)

Arguments

Details

Wraps '/api/v5/market/candles'. Returns up to 'limit' bars, sorted by timestamp. Candlestick fields can be standardized to common OHLCV names via 'standardize_names = TRUE'.

Value

A 'data.frame' with columns including 'timestamp', 'open', 'high', 'low', 'close', 'volume', and 'volQuote'. Timestamps are 'POSIXct' in 'tz'.

Note

Since okxr 0.1.1

See Also

[get_market_history_candles()], [get_public_mark_price()]

Examples

## Not run: 
cfg <- list(api_key = "xxx", secret_key = "xxx", passphrase = "xxx")
get_market_candles("BTC-USDT", bar = "5m", limit = 50, config = cfg)

## End(Not run)

Get exchange rate

Description

Retrieve the two-week average exchange rate series summary.

Usage

get_market_exchange_rate(config = NULL, tz = .okx_default_tz)

Arguments

Value

A one-row 'data.frame' with 'usdCny'.

Get historical market candles

Description

Retrieve candlestick data before a specific datetime.

Usage

get_market_history_candles(
  inst_id,
  bar,
  before = NULL,
  limit = 100L,
  config = NULL,
  tz = .okx_default_tz,
  standardize_names = TRUE
)

Arguments

Details

Wraps '/api/v5/market/history-candles'. If 'before' is supplied, it is converted to milliseconds since epoch (in 'tz') and sent as 'after=...' (per OKX semantics: *return data before this time*).

Value

A 'data.frame' of candlestick bars. If 'standardize_names = TRUE', column names are normalized. Timestamps are 'POSIXct' in 'tz'.

Note

Since okxr 0.1.1

See Also

[get_market_candles()]

Examples

## Not run: 
cfg <- list(api_key = "xxx", secret_key = "xxx", passphrase = "xxx")
get_market_history_candles(
  "ETH-USDT-SWAP", bar = "1H",
  before = "2025-08-20 00:00:00", config = cfg
)

## End(Not run)

Get historical index candles

Description

Retrieve historical candlestick data for an index.

Usage

get_market_history_index_candles(
  inst_id,
  bar = NULL,
  after = NULL,
  before = NULL,
  limit = 100L,
  config = NULL,
  tz = .okx_default_tz,
  standardize_names = TRUE
)

Arguments

Value

A 'data.frame' of historical index candlesticks.

Get historical mark price candles

Description

Retrieve historical candlestick data for mark price.

Usage

get_market_history_mark_price_candles(
  inst_id,
  bar = NULL,
  after = NULL,
  before = NULL,
  limit = 100L,
  config = NULL,
  tz = .okx_default_tz,
  standardize_names = TRUE
)

Arguments

Value

A 'data.frame' of historical mark-price candlesticks.

Get historical public trades

Description

Retrieve public trade history for an instrument.

Usage

get_market_history_trades(
  inst_id,
  type = NULL,
  after = NULL,
  before = NULL,
  limit = NULL,
  config = NULL,
  tz = .okx_default_tz
)

Arguments

Value

A 'data.frame' with historical public trades.

Get recent index candles

Description

Retrieve the latest candlestick data for an index.

Usage

get_market_index_candles(
  inst_id,
  bar = NULL,
  after = NULL,
  before = NULL,
  limit = 100L,
  config = NULL,
  tz = .okx_default_tz,
  standardize_names = TRUE
)

Arguments

Value

A 'data.frame' of index candlesticks.

Get index components

Description

Retrieve component-exchange information for an index.

Usage

get_market_index_components(
  index,
  config = NULL,
  tz = .okx_default_tz
)

Arguments

Value

A one-row 'data.frame' with 'index', 'last', 'ts', and JSON-encoded 'components'.

Get index tickers

Description

Retrieve the latest public index-price snapshots.

Usage

get_market_index_tickers(
  quote_ccy = NULL,
  inst_id = NULL,
  config = NULL,
  tz = .okx_default_tz
)

Arguments

Value

A 'data.frame' with one row per index ticker.

Get mark price candles

Description

Retrieve recent candlestick data for the mark price of an instrument.

Usage

get_market_mark_price_candles(
  inst_id,
  bar = NULL,
  after = NULL,
  before = NULL,
  limit = 100L,
  config = NULL,
  tz = .okx_default_tz,
  standardize_names = TRUE
)

Arguments

Value

A 'data.frame' of mark-price candlesticks.

Get option trades by instrument family

Description

Retrieve recent option trades for all instruments under the same instrument family.

Usage

get_market_option_instrument_family_trades(
  inst_family,
  config = NULL,
  tz = .okx_default_tz
)

Arguments

Value

A 'data.frame' with recent option trades under the requested instrument family, including 'instId', 'tradeId', 'px', 'sz', 'side', and 'ts'.

Get platform 24-hour volume

Description

Retrieve total platform order-book trading volume over the last 24 hours.

Usage

get_market_platform_24_volume(
  config = NULL,
  tz = .okx_default_tz
)

Arguments

Value

A one-row 'data.frame' with 'volUsd', 'volCny', and 'ts'.

Get market ticker

Description

Retrieve the latest ticker snapshot for a specific instrument.

Usage

get_market_ticker(inst_id, config = NULL, tz = .okx_default_tz)

Arguments

Value

A 'data.frame' with the latest ticker fields returned by OKX.

Get market tickers

Description

Retrieve ticker snapshots for all instruments under an instrument type.

Usage

get_market_tickers(
  inst_type,
  uly = NULL,
  inst_family = NULL,
  config = NULL,
  tz = .okx_default_tz
)

Arguments

Value

A 'data.frame' with one row per ticker.

Get recent public trades

Description

Retrieve recent public trades for an instrument.

Usage

get_market_trades(
  inst_id,
  limit = NULL,
  config = NULL,
  tz = .okx_default_tz
)

Arguments

Value

A 'data.frame' with recent public trades.

Get public block trades

Description

Retrieve recent single-leg public block trades for an instrument.

Usage

get_public_block_trades(
  inst_id,
  config = NULL,
  tz = .okx_default_tz
)

Arguments

Value

A 'data.frame' with block trade fields such as price, size, trade side, volatility, and timestamps.

Convert between contract size and currency amount

Description

Convert the crypto value to the number of contracts, or vice versa.

Usage

get_public_convert_contract_coin(
  inst_id,
  sz,
  type = NULL,
  px = NULL,
  unit = NULL,
  op_type = NULL,
  config = NULL,
  tz = .okx_default_tz
)

Arguments

Value

A 'data.frame' with conversion result fields 'type', 'instId', 'px', 'sz', and 'unit'.

Get delivery or exercise history

Description

Retrieve futures delivery records or option exercise records.

Usage

get_public_delivery_exercise_history(
  inst_type,
  inst_family,
  after = NULL,
  before = NULL,
  limit = NULL,
  config = NULL,
  tz = .okx_default_tz
)

Arguments

Value

A 'data.frame' with 'ts' and JSON-encoded 'details'.

Get collateral discount rate and interest-free quota

Description

Retrieve public collateral discount-rate tiers and interest-free quota information for supported currencies.

Usage

get_public_discount_rate_interest_free_quota(
  ccy = NULL,
  discount_lv = NULL,
  config = NULL,
  tz = .okx_default_tz
)

Arguments

Value

A 'data.frame' with top-level discount and interest-free quota fields; nested tier details are JSON-encoded in 'details'.

Get economic calendar

Description

Retrieve macro-economic calendar records. OKX requires authentication for this endpoint.

Usage

get_public_economic_calendar(
  region = NULL,
  importance = NULL,
  before = NULL,
  after = NULL,
  limit = NULL,
  config,
  tz = .okx_default_tz
)

Arguments

Value

A 'data.frame' with calendar event fields and timestamps.

Get estimated delivery or exercise price

Description

Retrieve the estimated delivery, exercise, or settlement price for derivatives and events instruments.

Usage

get_public_estimated_price(
  inst_type,
  inst_family = NULL,
  inst_id = NULL,
  config = NULL,
  tz = .okx_default_tz
)

Arguments

Value

A 'data.frame' with 'instType', 'instId', 'settlePx', and 'ts'.

Get estimated settlement info

Description

Retrieve the estimated settlement price for a futures instrument close to settlement.

Usage

get_public_estimated_settlement_info(
  inst_id,
  config = NULL,
  tz = .okx_default_tz
)

Arguments

Value

A 'data.frame' with 'instId', 'nextSettleTime', 'estSettlePx', and 'ts'.

Get current funding rate

Description

Retrieve the current funding rate for a perpetual swap instrument.

Usage

get_public_funding_rate(
  inst_id,
  config = NULL,
  tz = .okx_default_tz
)

Arguments

Value

A 'data.frame' containing the current funding rate fields returned by OKX.

Get funding rate history

Description

Retrieve historical funding rate entries for a perpetual swap instrument.

Usage

get_public_funding_rate_history(
  inst_id,
  before = NULL,
  after = NULL,
  limit = 400,
  config = NULL,
  tz = .okx_default_tz
)

Arguments

Value

A 'data.frame' containing funding rate history rows returned by OKX.

Get option instrument tick bands

Description

Retrieve option tick-band information for one or more option instrument families.

Usage

get_public_instrument_tick_bands(
  inst_type = "OPTION",
  inst_family = NULL,
  config = NULL,
  tz = .okx_default_tz
)

Arguments

Value

A 'data.frame' with 'instType', 'instFamily', and JSON-encoded 'tickBand' details.

Get instrument metadata

Description

Retrieve metadata for instruments of a given type.

Usage

get_public_instruments(
  inst_id = NULL,
  inst_type = "SWAP",
  config = NULL,
  tz = .okx_default_tz
)

Arguments

Details

Wraps '/api/v5/public/instruments'. Returns one row per instrument, including contract specifications, tick size, lot size, expiry, and state.

Value

A 'data.frame' with instrument metadata (e.g., 'instType', 'instId', 'uly', 'baseCcy', 'quoteCcy', 'settleCcy', 'ctVal', 'ctMult', 'tickSz', 'lotSz', 'minSz', 'expTime', 'lever', 'state', ...).

Note

Since okxr 0.1.2

See Also

[get_public_mark_price()]

Examples

## Not run: 
cfg <- list(api_key = "xxx", secret_key = "xxx", passphrase = "xxx")
# Get metadata for all SWAP instruments
df <- get_public_instruments(inst_type = "SWAP", config = cfg)

# Get metadata for one instrument
get_public_instruments("ETH-USDT-SWAP", inst_type = "SWAP", config = cfg)

## End(Not run)

Get security fund balance information

Description

Retrieve public insurance-fund or security-fund balance information.

Usage

get_public_insurance_fund(
  inst_type,
  type = NULL,
  inst_family = NULL,
  ccy = NULL,
  before = NULL,
  after = NULL,
  limit = NULL,
  config = NULL,
  tz = .okx_default_tz
)

Arguments

Value

A 'data.frame' with top-level fund totals; nested per-currency detail rows are JSON-encoded in 'details'.

Get interest rate and loan quota

Description

Retrieve public borrowing-rate and loan-quota tables.

Usage

get_public_interest_rate_loan_quota(
  ccy = NULL,
  vip_level = NULL,
  config = NULL,
  tz = .okx_default_tz
)

Arguments

Value

A 'data.frame' where nested basic, VIP, regular, and custom quota tables are JSON-encoded string columns.

Get current mark price

Description

Retrieve the current mark price for a given instrument.

Usage

get_public_mark_price(
  inst_id,
  inst_type = "SWAP",
  config = NULL,
  tz = .okx_default_tz
)

Arguments

Details

Wraps '/api/v5/public/mark-price'. Useful for margin calculations and PnL estimation. Returns a single row with the latest mark price and timestamp.

Value

A 'data.frame' with columns 'timestamp', 'instId', 'markPx'.

Note

Since okxr 0.1.1

See Also

[get_public_instruments()]

Examples

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

## End(Not run)

Get open interest

Description

Retrieve current open interest for an instrument.

Usage

get_public_open_interest(
  inst_id,
  inst_type,
  config = NULL,
  tz = .okx_default_tz
)

Arguments

Value

A 'data.frame' containing open interest fields returned by OKX.

Get option summary

Description

Retrieve option market summary data for an instrument family.

Usage

get_public_opt_summary(
  inst_family,
  exp_time = NULL,
  config = NULL,
  tz = .okx_default_tz
)

Arguments

Value

A 'data.frame' with option greeks, volatility, forward price, and timestamp fields.

Get public option trades

Description

Retrieve recent public option trades filtered by instrument ID or instrument family.

Usage

get_public_option_trades(
  inst_id = NULL,
  inst_family = NULL,
  opt_type = NULL,
  config = NULL,
  tz = .okx_default_tz
)

Arguments

Value

A 'data.frame' with recent option trade rows, including option instrument identifiers, trade price and size, option side/type, forward, index and mark prices, implied volatility, and trade time.

Get public position tiers

Description

Retrieve public tier, margin, and maximum leverage information.

Usage

get_public_position_tiers(
  inst_type,
  td_mode,
  inst_family = NULL,
  inst_id = NULL,
  ccy = NULL,
  tier = NULL,
  config = NULL,
  tz = .okx_default_tz
)

Arguments

Value

A 'data.frame' with public position tier information.

Get premium history

Description

Retrieve premium-index history for an instrument.

Usage

get_public_premium_history(
  inst_id,
  after = NULL,
  before = NULL,
  bar = NULL,
  limit = NULL,
  config = NULL,
  tz = .okx_default_tz
)

Arguments

Value

A 'data.frame' with 'instId', 'premium', and 'ts'.

Get price limit

Description

Retrieve buy and sell price limits for an instrument.

Usage

get_public_price_limit(
  inst_id,
  config = NULL,
  tz = .okx_default_tz
)

Arguments

Value

A 'data.frame' with price limit fields.

Get settlement history

Description

Retrieve futures settlement history for an instrument family.

Usage

get_public_settlement_history(
  inst_family,
  after = NULL,
  before = NULL,
  limit = NULL,
  config = NULL,
  tz = .okx_default_tz
)

Arguments

Value

A 'data.frame' with 'ts' and JSON-encoded 'details'.

Get OKX system time

Description

Retrieve OKX system time.

Usage

get_public_time(config = NULL, tz = .okx_default_tz)

Arguments

Value

A one-row 'data.frame' with system time.

Get underlying list

Description

Retrieve available underlyings for derivatives instruments.

Usage

get_public_underlying(
  inst_type,
  config = NULL,
  tz = .okx_default_tz
)

Arguments

Value

A one-column 'data.frame' with 'uly'.

Get trade account rate limit

Description

Retrieve account rate limit information related to new and amended order requests.

Usage

get_trade_account_rate_limit(config, tz = .okx_default_tz)

Arguments

Details

Wraps '/api/v5/trade/account-rate-limit'. Returns one row containing the current account rate limit and fill-ratio metrics used by OKX.

Value

A one-row 'data.frame' with rate-limit metrics such as 'accRateLimit', 'fillRatio', 'mainFillRatio', 'nextAccRateLimit', and 'ts'.

Get easy convert currency list

Description

Retrieve currencies available for easy convert.

Usage

get_trade_easy_convert_currency_list(
  source = NULL,
  config,
  tz = .okx_default_tz
)

Arguments

Value

A 'data.frame' with source and target currency metadata.

Get easy convert history

Description

Retrieve easy convert history.

Usage

get_trade_easy_convert_history(
  after = NULL,
  before = NULL,
  limit = NULL,
  config,
  tz = .okx_default_tz
)

Arguments

Value

A 'data.frame' with easy convert history rows.

Get trade fills

Description

Retrieve recently filled transaction details from the last 3 days.

Usage

get_trade_fills(
  inst_type = NULL,
  inst_family = NULL,
  inst_id = NULL,
  ord_id = NULL,
  sub_type = NULL,
  after = NULL,
  before = NULL,
  limit = NULL,
  begin = NULL,
  end = NULL,
  config,
  tz = .okx_default_tz
)

Arguments

Value

A 'data.frame' with fill rows.

Get trade fills history

Description

Retrieve historical filled transaction details from the last 3 months.

Usage

get_trade_fills_history(
  inst_type,
  inst_family = NULL,
  inst_id = NULL,
  ord_id = NULL,
  sub_type = NULL,
  after = NULL,
  before = NULL,
  limit = NULL,
  begin = NULL,
  end = NULL,
  config,
  tz = .okx_default_tz
)

Arguments

Value

A 'data.frame' with historical fill rows.

Get one-click repay currency list

Description

Retrieve repayable currencies for the legacy one-click repay endpoint.

Usage

get_trade_one_click_repay_currency_list(
  debt_type = NULL,
  config,
  tz = .okx_default_tz
)

Arguments

Value

A 'data.frame' with debt and repay currency metadata.

Get one-click repay currency list v2

Description

Retrieve repayable currencies for the new one-click repay endpoint.

Usage

get_trade_one_click_repay_currency_list_v2(
  config,
  tz = .okx_default_tz
)

Arguments

Value

A 'data.frame' with debt and repay currency metadata.

Get one-click repay history

Description

Retrieve legacy one-click repay history.

Usage

get_trade_one_click_repay_history(
  after = NULL,
  before = NULL,
  limit = NULL,
  config,
  tz = .okx_default_tz
)

Arguments

Value

A 'data.frame' with one-click repay history rows.

Get one-click repay history v2

Description

Retrieve new one-click repay history.

Usage

get_trade_one_click_repay_history_v2(
  after = NULL,
  before = NULL,
  limit = NULL,
  config,
  tz = .okx_default_tz
)

Arguments

Value

A 'data.frame' with one-click repay history rows.

Get trade order details

Description

Retrieve detailed information about a specific OKX order by either the exchange-assigned 'ord_id' or your client-assigned 'cl_ord_id'.

Usage

get_trade_order(
  inst_id,
  ord_id = NULL,
  cl_ord_id = NULL,
  config,
  tz = .okx_default_tz
)

Arguments

Details

You must provide exactly one identifier: 'ord_id' **or** 'cl_ord_id'. Timestamps in the response are converted to 'POSIXct' in the supplied 'tz'.

Value

A 'data.frame' (one row) with order details following OKX schema (e.g., 'ordId', 'clOrdId', 'instId', 'ordType', 'px', 'sz', 'side', 'posSide', 'tdMode', 'accFillSz', 'fillPx', 'fillSz', 'fillTime', 'avgPx', 'state', 'lever', etc.). Timestamp columns are 'POSIXct' in 'tz'.

Common errors

- ‘Either ’ord_id' or 'cl_ord_id' must be provided.' (client-side) - HTTP 401 Unauthorized (missing/invalid credentials) - OKX 'code' like '51000' invalid sign or '51603' order not found

Note

Since okxr 0.1.1

See Also

[get_trade_orders_pending()], [get_trade_orders_history_7d()]

Examples

## Not run: 
cfg <- list(api_key = "xxx", secret_key = "xxx", passphrase = "xxx")
get_trade_order(
  inst_id = "ETH-USDT-SWAP",
  ord_id  = "1234567890",
  config  = cfg
)

## End(Not run)

Get a single algo order

Description

Retrieve a specific algo order by algo ID or client algo order ID.

Usage

get_trade_order_algo(
  algo_id = NULL,
  algo_cl_ord_id = NULL,
  config,
  tz = .okx_default_tz
)

Arguments

Value

A 'data.frame' with algo order details.

Get algo order history

Description

Retrieve historical algo orders.

Usage

get_trade_orders_algo_history(
  ord_type,
  state = NULL,
  algo_id = NULL,
  inst_type = NULL,
  inst_id = NULL,
  after = NULL,
  before = NULL,
  limit = NULL,
  config,
  tz = .okx_default_tz
)

Arguments

Value

A 'data.frame' with algo order history rows.

Get pending algo orders

Description

Retrieve untriggered algo orders.

Usage

get_trade_orders_algo_pending(
  ord_type,
  algo_id = NULL,
  inst_type = NULL,
  inst_id = NULL,
  after = NULL,
  before = NULL,
  limit = NULL,
  config,
  tz = .okx_default_tz
)

Arguments

Value

A 'data.frame' with pending algo orders.

Get trade orders history

Description

Retrieve completed orders from the last 7 days.

Usage

get_trade_orders_history(
  inst_type,
  inst_family = NULL,
  inst_id = NULL,
  ord_type = NULL,
  state = NULL,
  category = NULL,
  after = NULL,
  before = NULL,
  begin = NULL,
  end = NULL,
  limit = NULL,
  config,
  tz = .okx_default_tz
)

Arguments

Value

A 'data.frame' with historical order rows.

Get trade orders history (last 7 days)

Description

Retrieve recent order history for an instrument type.

Usage

get_trade_orders_history_7d(
  inst_type = "SWAP",
  config,
  tz = .okx_default_tz
)

Arguments

Details

This wraps '/api/v5/trade/orders-history' and covers about 7 days of data. Older data is available from OKX's archive endpoint.

Value

A 'data.frame' with one row per historical order and columns following the OKX schema (same layout as pending orders, plus final states). Timestamp columns are 'POSIXct' in 'tz'.

Common errors

- HTTP 401 Unauthorized - HTTP 400 Bad Request for invalid 'inst_type'

Note

Since okxr 0.1.2

See Also

[get_trade_order()], [get_trade_orders_pending()]

Examples

## Not run: 
cfg <- list(api_key = "xxx", secret_key = "xxx", passphrase = "xxx")
hist <- get_trade_orders_history_7d(
  inst_type = "SWAP",
  config = cfg,
  tz = "Asia/Hong_Kong"
)
tail(hist)

## End(Not run)

Get archived trade orders history

Description

Retrieve completed orders from the last 3 months.

Usage

get_trade_orders_history_archive(
  inst_type,
  inst_family = NULL,
  inst_id = NULL,
  ord_type = NULL,
  state = NULL,
  category = NULL,
  after = NULL,
  before = NULL,
  begin = NULL,
  end = NULL,
  limit = NULL,
  config,
  tz = .okx_default_tz
)

Arguments

Value

A 'data.frame' with archived order rows.

Get all pending trade orders

Description

Retrieve all currently open (unfilled) orders for your OKX account.

Usage

get_trade_orders_pending(config, tz = .okx_default_tz)

Arguments

Details

Returns one row per open order. Timestamps are parsed to 'POSIXct' using 'tz'.

Value

A 'data.frame' with one row per pending order and columns following the OKX schema (e.g., 'cTime', 'ordId', 'clOrdId', 'tag', 'instId', 'ordType', 'px', 'sz', 'side', 'posSide', 'tdMode', 'accFillSz', 'fillPx', 'fillSz', 'fillTime', 'avgPx', 'state', 'lever', ...). Timestamp columns are 'POSIXct'.

Common errors

- HTTP 401 Unauthorized (missing/invalid credentials) - Rate limiting: HTTP 429 / OKX throttle codes

Note

Since okxr 0.1.1

See Also

[get_trade_order()], [get_trade_orders_history_7d()]

Examples

## Not run: 
cfg <- list(api_key = "xxx", secret_key = "xxx", passphrase = "xxx")
df <- get_trade_orders_pending(config = cfg, tz = "Asia/Hong_Kong")
head(df)

## End(Not run)

Retrieve variable labels from OKX data frames

Description

Returns human-readable labels attached to a data frame produced by OKX API parsers. You can retrieve all labels or a label for a specific variable by name or index.

Usage

get_var_label(df, var = NULL, default = NA_character_)

Arguments

Value

A character label if var is provided, or a named character vector of all labels if var = NULL.

Examples

df <- data.frame(ordId = "123", px = 10)
attr(df, "var_labels") <- c(ordId = "Order ID", px = "Price")

get_var_label(df, "ordId")
get_var_label(df, 2)
get_var_label(df)

Preset Account Level Switch

Description

Preset required values before switching account mode.

Usage

post_account_account_level_switch_preset(
  acct_lv,
  lever = NULL,
  risk_offset_type = NULL,
  tz = .okx_default_tz,
  config
)

Arguments

Value

A 'data.frame' describing the stored preset values.

Configure MMP

Description

Set market maker protection thresholds for an options instrument family.

Usage

post_account_mmp_config(
  inst_family,
  time_interval,
  frozen_interval,
  qty_limit,
  tz = .okx_default_tz,
  config
)

Arguments

Value

A 'data.frame' describing the applied MMP configuration.

Reset MMP Status

Description

Reset market maker protection status for an instrument family.

Usage

post_account_mmp_reset(
  inst_family,
  inst_type = NULL,
  tz = .okx_default_tz,
  config
)

Arguments

Value

A 'data.frame' with the request result.

Move Positions Between Accounts

Description

Move positions between accounts under the same master account.

Usage

post_account_move_positions(
  from_acct,
  to_acct,
  legs,
  client_id,
  tz = .okx_default_tz,
  config
)

Arguments

Value

A 'data.frame' describing the move-position request result.

Adjust Position Margin Balance

Description

Increase or reduce margin for an existing position.

Usage

post_account_position_margin_balance(
  inst_id,
  pos_side,
  type,
  amt,
  ccy = NULL,
  tz = .okx_default_tz,
  config
)

Arguments

Value

A 'data.frame' describing the applied margin adjustment.

Set Account Level

Description

Switch the account mode.

Usage

post_account_set_account_level(
  acct_lv,
  tz = .okx_default_tz,
  config
)

Arguments

Value

A 'data.frame' confirming the applied account level.

Set Account Auto Loan

Description

Enable or disable automatic borrowing.

Usage

post_account_set_auto_loan(
  auto_loan = TRUE,
  tz = .okx_default_tz,
  config
)

Arguments

Value

A 'data.frame' confirming the applied auto-loan setting.

Set Account Auto Repay

Description

Enable or disable spot-mode auto repay.

Usage

post_account_set_auto_repay(
  auto_repay,
  tz = .okx_default_tz,
  config
)

Arguments

Value

A 'data.frame' confirming the applied auto-repay setting.

Set Account Collateral Assets

Description

Configure whether all or selected assets are treated as collateral.

Usage

post_account_set_collateral_assets(
  type,
  collateral_enabled,
  ccy_list = NULL,
  tz = .okx_default_tz,
  config
)

Arguments

Value

A 'data.frame' confirming the applied collateral asset setting.

Set Account Fee Type

Description

Configure the fee charging mode for spot trading.

Usage

post_account_set_fee_type(fee_type, tz = .okx_default_tz, config)

Arguments

Value

A 'data.frame' confirming the applied fee type.

Set Account Greeks Display Type

Description

Configure whether Greeks are displayed in PA or BS mode.

Usage

post_account_set_greeks(
  greeks_type,
  tz = .okx_default_tz,
  config
)

Arguments

Value

A 'data.frame' confirming the applied Greeks display type.

Set Account Leverage

Description

Sets the leverage level for a specific trading instrument and margin mode.

Usage

post_account_set_leverage(
  inst_id,
  lever,
  mgn_mode,
  pos_side = NULL,
  tz = .okx_default_tz,
  config
)

Arguments

Value

A data.frame with leverage update confirmation (including instrument ID and leverage settings).

Set Account Position Mode

Description

Set the account position mode.

Usage

post_account_set_position_mode(
  pos_mode,
  tz = .okx_default_tz,
  config
)

Arguments

Value

A 'data.frame' confirming the applied position mode.

Submit Spot Manual Borrow or Repay

Description

Manually borrow or repay under spot mode.

Usage

post_account_spot_manual_borrow_repay(
  ccy,
  side,
  amt,
  tz = .okx_default_tz,
  config
)

Arguments

Value

A 'data.frame' describing the executed borrow/repay request.

Cancel an Asset Withdrawal

Description

Cancel a pending withdrawal request.

Usage

post_asset_cancel_withdrawal(wd_id, tz = .okx_default_tz, config)

Arguments

Value

A 'data.frame' confirming the cancelled withdrawal ID.

Estimate an Asset Convert Quote

Description

Request a quote for an asset conversion without executing the trade.

Usage

post_asset_convert_estimate_quote(
  base_ccy,
  quote_ccy,
  side,
  rfq_sz,
  rfq_sz_ccy,
  cl_q_req_id = NULL,
  tag = NULL,
  convert_mode = NULL,
  tz = .okx_default_tz,
  config
)

Arguments

Value

A 'data.frame' describing the estimated conversion quote.

Execute an Asset Convert Trade

Description

Execute a confirmed asset conversion against a previously quoted price.

Usage

post_asset_convert_trade(
  quote_id,
  base_ccy,
  quote_ccy,
  side,
  sz,
  sz_ccy,
  cl_t_req_id = NULL,
  tag = NULL,
  convert_mode = NULL,
  tz = .okx_default_tz,
  config
)

Arguments

Value

A 'data.frame' describing the executed conversion trade.

Transfer Assets

Description

Transfer assets between funding, trading, and related accounts.

Usage

post_asset_transfer(
  ccy,
  amt,
  from,
  to,
  type = "0",
  sub_acct = NULL,
  loan_trans = NULL,
  omit_pos_risk = NULL,
  client_id = NULL,
  tz = .okx_default_tz,
  config
)

Arguments

Value

A 'data.frame' describing the submitted transfer request.

Submit an Asset Withdrawal

Description

Submit a withdrawal request from the OKX funding account.

Usage

post_asset_withdrawal(
  ccy,
  amt,
  dest,
  to_addr,
  chain = NULL,
  to_addr_type = NULL,
  area_code = NULL,
  rcvr_info = NULL,
  client_id = NULL,
  tz = .okx_default_tz,
  config
)

Arguments

Value

A 'data.frame' describing the submitted withdrawal request.

Amend an Algo Order

Description

Amend a supported unfilled algo order.

Usage

post_trade_amend_algos(
  inst_id,
  algo_id = NULL,
  algo_cl_ord_id = NULL,
  cxl_on_fail = NULL,
  req_id = NULL,
  new_sz = NULL,
  new_tp_trigger_px = NULL,
  new_tp_ord_px = NULL,
  new_sl_trigger_px = NULL,
  new_sl_ord_px = NULL,
  new_tp_trigger_px_type = NULL,
  new_sl_trigger_px_type = NULL,
  new_trigger_px = NULL,
  new_ord_px = NULL,
  new_trigger_px_type = NULL,
  attach_algo_ords = NULL,
  config,
  tz = .okx_default_tz
)

Arguments

Value

A 'data.frame' describing the algo amendment result.

Amend Multiple Trade Orders

Description

Submit multiple amendment requests in one request.

Usage

post_trade_amend_batch_orders(
  orders,
  config,
  tz = .okx_default_tz
)

Arguments

Value

A 'data.frame' with one row per amendment result.

Amend a Trade Order

Description

Submit an amendment request for an incomplete order.

Usage

post_trade_amend_order(
  inst_id,
  ord_id = NULL,
  cl_ord_id = NULL,
  req_id = NULL,
  new_sz = NULL,
  new_px = NULL,
  cxl_on_fail = NULL,
  new_px_usd = NULL,
  new_px_vol = NULL,
  px_amend_type = NULL,
  attach_algo_ords = NULL,
  speed_bump = NULL,
  config,
  tz = .okx_default_tz
)

Arguments

Value

A 'data.frame' describing the amendment request result.

Place Multiple Trade Orders

Description

Submit multiple trade orders in one request.

Usage

post_trade_batch_orders(orders, config, tz = .okx_default_tz)

Arguments

Value

A 'data.frame' with one row per submitted order result.

Cancel Multiple Algo Orders

Description

Cancel up to 10 unfilled algo orders in one request.

Usage

post_trade_cancel_algos(orders, config, tz = .okx_default_tz)

Arguments

Value

A 'data.frame' with one row per algo cancellation result.

Set Cancel-All-After

Description

Set or disable the cancel-all-after countdown.

Usage

post_trade_cancel_all_after(
  time_out,
  tag = NULL,
  config,
  tz = .okx_default_tz
)

Arguments

Value

A 'data.frame' with the configured trigger time and tag.

Cancel Multiple Trade Orders

Description

Submit a batch cancellation request for incomplete orders.

Usage

post_trade_cancel_batch_orders(
  orders,
  config,
  tz = .okx_default_tz
)

Arguments

Value

A 'data.frame' with one row per cancellation result.

Cancel a Trade Order

Description

Submits a cancellation request for a previously placed trade order.

Usage

post_trade_cancel_order(
  inst_id,
  ord_id = NULL,
  cl_ord_id = NULL,
  config,
  tz = .okx_default_tz
)

Arguments

Value

A data.frame containing cancellation result and timestamp.

Close a Position

Description

Submits a request to close a position for a given instrument and position side.

Usage

post_trade_close_position(
  inst_id,
  mgn_mode,
  pos_side,
  tz = .okx_default_tz,
  config
)

Arguments

Value

A data.frame with close position confirmation details.

Mass Cancel MMP Orders

Description

Cancel all MMP pending orders for an options instrument family.

Usage

post_trade_mass_cancel(
  inst_type,
  inst_family,
  lock_interval = NULL,
  config,
  tz = .okx_default_tz
)

Arguments

Value

A 'data.frame' with the request result.

Place a Trade Order

Description

Submits a trade order to the OKX exchange.

Usage

post_trade_order(
  inst_id,
  td_mode,
  side,
  ord_type,
  sz,
  pos_side = NULL,
  px = NULL,
  reduce_only = NULL,
  tgt_ccy = NULL,
  cl_ord_id = NULL,
  tag = NULL,
  config,
  tz = .okx_default_tz
)

Arguments

Value

A data.frame containing fields like order ID, client order ID, and timestamp.

Precheck a Trade Order

Description

Submit an order precheck request without placing the order.

Usage

post_trade_order_precheck(
  inst_id,
  td_mode,
  side,
  ord_type,
  sz,
  ccy = NULL,
  cl_ord_id = NULL,
  tag = NULL,
  pos_side = NULL,
  px = NULL,
  reduce_only = NULL,
  tgt_ccy = NULL,
  attach_algo_ords = NULL,
  speed_bump = NULL,
  outcome = NULL,
  config,
  tz = .okx_default_tz
)

Arguments

Value

A 'data.frame' with projected account metrics after the precheck.

Set or get okxr options

Description

Convenience wrapper to set global options for okxr, such as whether to return raw data instead of parsed data.

Usage

set_okxr_options(raw_data = NULL, timeout = NULL)

Arguments

Value

An invisible named list with the current package options: 'raw_data' (logical) and 'timeout' (numeric seconds). This return value can be used to inspect the effective option state.

Examples

old <- getOption("okxr.raw_data")
old_timeout <- getOption("okxr.timeout")
set_okxr_options(raw_data = TRUE)
set_okxr_options(timeout = 5)
options(okxr.raw_data = old, okxr.timeout = old_timeout)

set_okxr_options()  # check current values