get_market_tickers: Get market tickers

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

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

inst_type	Character. Instrument type, e.g. '"SPOT"', '"SWAP"', '"FUTURES"', or '"OPTION"'.
uly	Character or 'NULL'. Underlying. Optional filter for derivatives.
inst_family	Character or 'NULL'. Instrument family. Optional filter for derivatives and options.
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 'data.frame' with one row per ticker.

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