get_public_settlement_history: Get settlement history

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

Get settlement history

Description

Retrieve futures settlement history for an instrument family.

Usage

get_public_settlement_history(
  inst_family,
  after = NULL,
  before = NULL,
  limit = NULL,
  config = NULL,
  tz = .okx_default_tz
)

Arguments

inst_family	Character. Instrument family.
after	Character or 'NULL'. Pagination cursor for older rows.
before	Character or 'NULL'. Pagination cursor for newer rows.
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 'ts' and JSON-encoded 'details'.

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