MetaTraderPy
Update of "API"
Not logged in

Many hyperlinks are disabled.
Use anonymous login to enable hyperlinks.

Overview

Artifact ID: e94ac3604cfc1327037901668501f7d5f792a9ca
Page Name:API
Date: 2012-10-03 19:28:54
Original User: polymeris
Parent: 6c478954b2038d7171ccafaf10902b014248160b
Content

 
Classes

 
class Account

   

Information about the currently active account.
 

 

Methods defined here:
balance(self)
Account's current amount of money in the account.
credit(self)
Account's credit value.
currency(self)
Account's currency name.
equity(self)
Account's equity value. This depends on trading server

settings.

freeMargin(self)
Account's free margin value.
isDemo(self)
Returns true if this is a demo account.
leverage(self)
Returns the current leverage of this account.
margin(self)
Account's margin value.
name(self)
Account's name.

 
class Advisor

   

An expert advisor takes care of trade for one symbol.
This is the base class to MetaTrader expert advisors written in Python.

Implement a tick() with no arguments method in your derived classes.
 

  Methods defined here:
__init__(self)
You may want to implement your own __init__ method.

If so, the arguments passed will be the advisor's symbol,
point and relevant digits.

account(self)
Returns an instance with information about the active
account.
This information isn't available before the first tick.
askPrice(self)
Returns the current tick's ask price.
This information isn't available before the first tick.
bidPrice(self)
Returns the current tick's bid price.
This information isn't available before the first tick.
closeOrder(self, order)
Closes an open order.
Alternatively, cancels the order if it hasn't been issued yet.
datetime(self)
Returns the current tick's server time. The time is modelled
when testing.
digits(self)
Relevant digits after the decimal point for this symbol.
This information isn't available before the first tick.
indicators(self)
Returns a dictionary of watched indicators to their values
this tick.
isTesting(self)
Returns true if this advisor is being tested.
This information isn't available before the first tick.
openOrder(self, order)
Opens an order.
The order is issued in between this tick() call and the next.

See Order, BuyOrder and SellOrder classes.

orders(self)
Returns a list of open orders.

Only orders issued by this advisor are included.

point(self)
Returns the symbols point in currency.

This information isn't available before the first tick.

symbol(self)
Returns the advisors symbol as string.

This information isn't available before the first tick.

unwatchIndicator(self, indicator)
Stop watching this indicator.
watchIndicator(self, indicator)
Watch an Indicator. It will be updated between ticks.

 
class Indicator

   

Technical indicators.
To use them call Advisor.watchIndicator().
 

 

Methods defined here:
__init__(self, indicator, timeframe, shift=0, **kwargs)
Construct an indicator.
You must specify any parameters using MQL4 parameter names

as keywords, e.g. 'appied_price' or 'ma_shift'.
In the case of the Stochastic Indicator, the keywords for the

%Kperiod and %Dperiod parameters are 'k_period' and 'd_period',
respectively.
If the indicator only takes timeframe and shift as parameters,

you may omit the keywords.

value(self)
Return the indicator value for this tick.

Data and other attributes defined here:

AC = 0
AD = 1
ADX = 2
ALLIGATOR = 3
AO = 4
ATR = 5
AppliedPrice = <class metatrader.AppliedPrice>
BANDS = 6
BEARS_POWER = 7
BULLS_POWER = 8
BWMFI = 9
CCI = 10
DE_MARKER = 11
ENVELOPES = 12
FORCE = 13
FRACTALS = 14
GATOR = 15
ICHIMOKU = 16
MA = 17
MACD = 18
MFI = 19
MOMENTUM = 20
Mode = <class metatrader.Mode>
MovingAverage = <class metatrader.MovingAverage>
OBV = 21
OSMA = 22
RSI = 23
RVI = 24
SAR = 25
STDDEV = 26
STOCHASTIC = 27
Timeframe = <class metatrader.Timeframe>
WPR = 28

 
class Order

   

An order to buy or sell that can be issued to the broker.

And later closed. See Advisor.openOrder() and Advisor.closeOrder()
methods.
 

  Methods defined here:
__init__(self, command, volume, slippage=2, stopLoss=25, takeProfit=50)
Create an order.

The order command parameter may be one of Order.BUY or
Order.SELL. Volume is in lots. Slippage in points.


Data and other attributes defined here:

BUY = 0
SELL = 1

 
Data

      

  VERSION = 1.1