get_market_history_trades: Get historical public trades

View source: R/wrappers_get_market.R

get_market_history_tradesR Documentation

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

inst_id

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

type

Character or 'NULL'. Pagination type, using OKX values.

after

Character or 'NULL'. Pagination cursor for earlier records.

before

Character or 'NULL'. Pagination cursor for newer records.

limit

Integer or 'NULL'. Number of rows to request.

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 historical public trades.


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