Broker API HubMenu

MQL5 PositionGetTicket()

functionPositionGetTicket()MQL5Positions

Returns the ticket of the open position at an index in the list of positions, and selects that position so its properties can be read.

Risk warning: CFDs and spread bets are complex instruments and come with a high risk of losing money rapidly due to leverage. You can lose money on these products, and each provider publishes its own loss figure under FCA rules. You should consider whether you understand how they work and whether you can afford to take the high risk of losing your money. Automated and API trading can amplify losses through bugs, connectivity failures and runaway orders.

Independent and unofficialmql5.comchecked

This is an MQL5 function, not an HTTP endpoint. It has no method, no path and no address to send a request to: it runs inside the MetaTrader 5 terminal, in a program written in MQL5.

The page reminds that a position is the result of deals and is not the same thing as a pending order, and that a netting account holds one position a symbol while a hedging account can hold several.

Signature

The form of the call on the vendor's page, with the vendor's comments taken out.

ulong PositionGetTicket(
  int index
)

Arguments

NameTypeDescription
indexrequiredintThe position's index in the list of open positions, counted from 0.

Return value

Type
ulong
What comes back
The position's ticket, or 0 when the function fails.

Sample

Written by this site from the signature and arguments recorded on this page. It has not been run against a terminal, a server or an account, and the values in it are placeholders. It holds no credential and needs none: the program runs inside a terminal that is already logged in to an account. Nothing is entered on this site.

void OnStart()
  {
   int total=PositionsTotal();
   for(int i=0; i<total; i++)
     {
      ulong ticket=PositionGetTicket(i);
      if(ticket>0)
         PrintFormat("#%I64u opened at %.5f",ticket,PositionGetDouble(POSITION_PRICE_OPEN));
     }
  }