post_trade_amend_order: Amend a Trade Order

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

Amend a Trade Order

Description

Submit an amendment request for an incomplete order.

Usage

post_trade_amend_order(
  inst_id,
  ord_id = NULL,
  cl_ord_id = NULL,
  req_id = NULL,
  new_sz = NULL,
  new_px = NULL,
  cxl_on_fail = NULL,
  new_px_usd = NULL,
  new_px_vol = NULL,
  px_amend_type = NULL,
  attach_algo_ords = NULL,
  speed_bump = NULL,
  config,
  tz = .okx_default_tz
)

Arguments

inst_id	Instrument ID.
ord_id	Order ID. Optional if 'cl_ord_id' is supplied.
cl_ord_id	Client order ID. Optional if 'ord_id' is supplied.
req_id	Optional client amendment request ID.
new_sz	Optional new total order size.
new_px	Optional new price.
cxl_on_fail	Optional logical. Whether to cancel the order if the amendment fails.
new_px_usd	Optional new option order USD price.
new_px_vol	Optional new option order implied volatility price.
px_amend_type	Optional price amendment mode.
attach_algo_ords	Optional attached TP/SL amendment list.
speed_bump	Optional event-contract speed bump.
config	A list with API credentials.
tz	Timezone for parsing response timestamps.

Value

A 'data.frame' describing the amendment request result.

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