get_market_ticker: Get market ticker

View source: R/wrappers_get_market.R

get_market_tickerR Documentation

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

inst_id

Character. Instrument ID, e.g. '"BTC-USDT"' or '"ETH-USDT-SWAP"'.

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 the latest ticker fields returned by OKX.


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