get_public_insurance_fund: Get security fund balance information

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

Get security fund balance information

Description

Retrieve public insurance-fund or security-fund balance information.

Usage

get_public_insurance_fund(
  inst_type,
  type = NULL,
  inst_family = NULL,
  ccy = NULL,
  before = NULL,
  after = NULL,
  limit = NULL,
  config = NULL,
  tz = .okx_default_tz
)

Arguments

inst_type	Character. Instrument type, such as '"MARGIN"', '"SWAP"', '"FUTURES"', or '"OPTION"'.
type	Character or 'NULL'. Fund update type filter.
inst_family	Character or 'NULL'. Instrument family filter for derivatives.
ccy	Character or 'NULL'. Currency filter for margin data.
before	Character or 'NULL'. Pagination cursor for newer rows.
after	Character or 'NULL'. Pagination cursor for older 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 top-level fund totals; nested per-currency detail rows are JSON-encoded in 'details'.

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