post_trade_amend_algos: Amend an Algo Order

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

Amend an Algo Order

Description

Amend a supported unfilled algo order.

Usage

post_trade_amend_algos(
  inst_id,
  algo_id = NULL,
  algo_cl_ord_id = NULL,
  cxl_on_fail = NULL,
  req_id = NULL,
  new_sz = NULL,
  new_tp_trigger_px = NULL,
  new_tp_ord_px = NULL,
  new_sl_trigger_px = NULL,
  new_sl_ord_px = NULL,
  new_tp_trigger_px_type = NULL,
  new_sl_trigger_px_type = NULL,
  new_trigger_px = NULL,
  new_ord_px = NULL,
  new_trigger_px_type = NULL,
  attach_algo_ords = NULL,
  config,
  tz = .okx_default_tz
)

Arguments

inst_id	Instrument ID.
algo_id	Algo order ID. Optional if 'algo_cl_ord_id' is supplied.
algo_cl_ord_id	Client-supplied algo ID. Optional if 'algo_id' is supplied.
cxl_on_fail	Optional logical. Whether to cancel the order if the amendment fails.
req_id	Optional client amendment request ID.
new_sz	Optional new quantity after amendment.
new_tp_trigger_px	Optional new take-profit trigger price.
new_tp_ord_px	Optional new take-profit order price.
new_sl_trigger_px	Optional new stop-loss trigger price.
new_sl_ord_px	Optional new stop-loss order price.
new_tp_trigger_px_type	Optional new take-profit trigger price type.
new_sl_trigger_px_type	Optional new stop-loss trigger price type.
new_trigger_px	Optional new trigger price for trigger orders.
new_ord_px	Optional new order price for trigger orders.
new_trigger_px_type	Optional new trigger price type for trigger orders.
attach_algo_ords	Optional attached TP/SL amendment list.
config	A list with API credentials.
tz	Timezone for parsing response timestamps.

Value

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

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