Broker API HubMenu

MQL5 PositionGetSymbol()

functionPositionGetSymbol()MQL5Positions

Returns the symbol of the open position at a place 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.

Signature

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

string PositionGetSymbol(
  int index
)

Arguments

NameTypeDescription
indexrequiredintThe position's number in the list of open positions.

Return value

Type
string
What comes back
The symbol's name, or an empty string when no position is found. On failure the page points to GetLastError() for the reason.

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()
  {
   for(int i=0; i<PositionsTotal(); i++)
     {
      string symbol=PositionGetSymbol(i);
      if(symbol!="")
         PrintFormat("%s %.2f lots",symbol,PositionGetDouble(POSITION_VOLUME));
     }
  }