get_account_position_risk: Get account and position risk snapshot

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

Get account and position risk snapshot

Description

Retrieve account-level adjusted equity together with same-snapshot balance and position risk payloads.

Usage

get_account_position_risk(
  inst_type = NULL,
  config,
  tz = .okx_default_tz
)

Arguments

inst_type	Character or 'NULL'. Instrument type filter. One of '"MARGIN"', '"SWAP"', '"FUTURES"', or '"OPTION"'.
config	List. API credentials/config.
tz	Character. Time zone for parsing timestamps. Default '"Asia/Hong_Kong"'.

Value

A 'data.frame' with one row per OKX risk snapshot. Nested balance and position payloads are returned as JSON strings in 'balData' and 'posData'.

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