post_trade_cancel_order: Cancel a Trade Order

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

Cancel a Trade Order

Description

Submits a cancellation request for a previously placed trade order.

Usage

post_trade_cancel_order(
  inst_id,
  ord_id = NULL,
  cl_ord_id = NULL,
  config,
  tz = .okx_default_tz
)

Arguments

inst_id	Instrument ID (e.g., "BTC-USDT").
ord_id	Optional OKX order ID to cancel.
cl_ord_id	Optional client order ID to cancel. Provide this or 'ord_id'.
config	A list with API credentials: api_key, secret_key, passphrase.
tz	Timezone for parsing any timestamps (default: "Asia/Hong_Kong").

Value

A data.frame containing cancellation result and timestamp.

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