post_trade_order_precheck: Precheck a Trade Order

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

Precheck a Trade Order

Description

Submit an order precheck request without placing the order.

Usage

post_trade_order_precheck(
  inst_id,
  td_mode,
  side,
  ord_type,
  sz,
  ccy = NULL,
  cl_ord_id = NULL,
  tag = NULL,
  pos_side = NULL,
  px = NULL,
  reduce_only = NULL,
  tgt_ccy = NULL,
  attach_algo_ords = NULL,
  speed_bump = NULL,
  outcome = NULL,
  config,
  tz = .okx_default_tz
)

Arguments

inst_id	Instrument ID.
td_mode	Trade mode.
side	Order side.
ord_type	Order type.
sz	Order size.
ccy	Optional margin currency.
cl_ord_id	Optional client order ID.
tag	Optional order tag.
pos_side	Optional position side.
px	Optional order price.
reduce_only	Optional logical reduce-only flag.
tgt_ccy	Optional target currency mode.
attach_algo_ords	Optional attached TP/SL list.
speed_bump	Optional event-contract speed bump.
outcome	Optional event-contract outcome.
config	A list with API credentials.
tz	Timezone for parsing response timestamps.

Value

A 'data.frame' with projected account metrics after the precheck.

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