CloseOrderByOpposite

Closes two opposing orders for the same symbol against each other.

Syntax

CloseOrderByOpposite(orderTicket1: number, orderTicket2: number): boolean

Parameters

• orderTicket1: The ticket number of the first order.

• orderTicket2: The ticket number of the second order, which must be of the opposite type to the first order.

Return Value

Returns a boolean value indicating whether the orders were successfully closed against each other.

• true: Orders were successfully closed.

• false: Failed to close the orders.

Description

The CloseOrderByOpposite method closes two opposing positions (one buy and one sell) for the same symbol against each other. This is useful for hedging strategies or when you want to close offsetting positions in a specific manner.

For this method to work correctly, the orders must:

1. Be on the same symbol (currency pair)

2. Have opposite types (one BUY and one SELL)

When executed successfully, both orders are closed, profit/loss is calculated and applied to the account balance, and the orders are moved to the order history.

Example

// Assuming we have identified two opposing orders
const buyOrderTicket = 12345;
const sellOrderTicket = 67890;

// Close the orders against each other
if (this.api.CloseOrderByOpposite(buyOrderTicket, sellOrderTicket)) {
  console.log(
    `Orders #${buyOrderTicket} and #${sellOrderTicket} were successfully closed against each other`
  );
} else {
  console.log(
    `Failed to close orders #${buyOrderTicket} and #${sellOrderTicket} against each other`
  );

  // Check if orders exist and are of opposite types
  if (
    this.api.SelectOrder(
      buyOrderTicket,
      EOrderSelectMode.SELECT_ORDER_BY_TICKET
    )
  ) {
    const buyOrderType = this.api.GetOrderType();
    const buyOrderSymbol = this.api.GetOrderSymbol();

    if (
      this.api.SelectOrder(
        sellOrderTicket,
        EOrderSelectMode.SELECT_ORDER_BY_TICKET
      )
    ) {
      const sellOrderType = this.api.GetOrderType();
      const sellOrderSymbol = this.api.GetOrderSymbol();

      if (buyOrderSymbol !== sellOrderSymbol) {
        console.log("Error: Orders must be for the same symbol");
      } else if (buyOrderType === sellOrderType) {
        console.log("Error: Orders must be of opposite types (BUY and SELL)");
      }
    } else {
      console.log(`Error: Order #${sellOrderTicket} not found`);
    }
  } else {
    console.log(`Error: Order #${buyOrderTicket} not found`);
  }
}

Notes

• Both orders must exist and be active.

• Orders must be on the same symbol (currency pair).

• One order must be a buy (long) position and the other must be a sell (short) position.

• This method is particularly useful for hedging strategies or for unwinding opposing positions in a controlled manner.