MQL5 OrderCalcMargin()
Works out the margin, in the account's currency, that an order of a given type, symbol, volume and price would need on the account as it stands.
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.
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.
bool OrderCalcMargin( ENUM_ORDER_TYPE action, string symbol, double volume, double price, double& margin )
Arguments
| Name | Type | Description |
|---|---|---|
| actionrequired | ENUM_ORDER_TYPE | The order type, as a value of the ENUM_ORDER_TYPE enumeration. |
| symbolrequired | string | The symbol's name. |
| volumerequired | double | The volume of the trade. |
| pricerequired | double | The opening price. |
| marginrequired | double& | The variable that receives the margin when the function succeeds. The page says the sum is done as if the account had no pending orders and no open positions. |
Return value
- Type
- bool
- What comes back
- True on success, false otherwise. 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()
{
double margin=0.0;
double price=SymbolInfoDouble(_Symbol,SYMBOL_ASK);
if(OrderCalcMargin(ORDER_TYPE_BUY,_Symbol,0.1,price,margin))
PrintFormat("margin for 0.1 lots: %.2f",margin);
else
PrintFormat("OrderCalcMargin error %d",GetLastError());
}