get_market_index_components: Get index components

View source: R/wrappers_get_market.R

get_market_index_componentsR Documentation

Get index components

Description

Retrieve component-exchange information for an index.

Usage

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

Arguments

index

Character. Index identifier, e.g. '"BTC-USD"'.

config

Optional list. Public endpoint request options, such as 'timeout'; credentials are not required.

tz

Character. Time zone for parsing timestamps. Default '"Asia/Hong_Kong"'.

Value

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


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