post_trade_close_position: Close a Position

View source: R/wrappers_post_trade.R

post_trade_close_positionR Documentation

Close a Position

Description

Submits a request to close a position for a given instrument and position side.

Usage

post_trade_close_position(
  inst_id,
  mgn_mode,
  pos_side,
  tz = .okx_default_tz,
  config
)

Arguments

inst_id

Instrument ID (e.g., "BTC-USDT").

mgn_mode

Margin mode: "cross" or "isolated".

pos_side

Position side to close: "long" or "short".

tz

Timezone for parsing any timestamps (default: "Asia/Hong_Kong").

config

A list with API credentials: api_key, secret_key, passphrase.

Value

A data.frame with close position confirmation details.


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