get_account_instruments: Get account-available instruments

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

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

inst_type	Character. Instrument type. One of '"SPOT"', '"MARGIN"', '"SWAP"', '"FUTURES"', '"OPTION"'.
uly	Character or 'NULL'. Underlying, where applicable.
inst_family	Character or 'NULL'. Instrument family filter.
inst_id	Character or 'NULL'. Specific instrument ID filter.
config	List. API credentials/config.
tz	Character. Time zone for parsing timestamps. Default '"Asia/Hong_Kong"'.

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.

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