v3.15

examples/candles.py

@@ -1,25 +1,32 @@
 import asyncio
-from aiomql import Symbol, TimeFrame, Account
+from aiomql import Symbol, TimeFrame, Account, Candle, Candles
 
 
 async def main():
+    """Example of using the Candle and Candles classes.
+    The candle class is a single price bar. Holding the OHLCV data for a single price bar.
+    The Candles class is a container of Candle objects. It is an Iterable of Candle objects.
+    It is sliceable and indexable. It can also be accessed with keywords.
+    It is a wrapper around a pandas DataFrame. Which is what it uses to store the data.
+    """
     async with Account():
-        # create a symbol
-        sym = Symbol(name="AUDUSD")
+        sym = Symbol(name="EURUSD")
 
         # Get EURUSD price bars for the past 48 hours
-        candles = await sym.copy_rates_from_pos(timeframe=TimeFrame.H1, count=48, start_position=0)
+        candles: Candles = await sym.copy_rates_from_pos(timeframe=TimeFrame.H1, count=48, start_position=0)
+
+        # get size of candles
         print(len(candles))  # 48
 
         # get the latest candle by accessing the last one.
-        last = candles[-1]  # A Candle object
+        last: Candle = candles[-1]  # A Candle object
         print(type(last))
-        print(last.time)
+        print(last.Index)
 
-        # get the last five hours
-        last_five = candles[-5:]  # A Candles object.
-        print(type(last_five))
-        print(last_five)
+        # slicing returns a Candles object
+        half = candles[24:]
+        print(type(half))
+        print(len(half))
 
         close = candles['close']  # close price of all the candles as a pandas series
         print(type(close))
@@ -32,6 +39,7 @@ async def main():
 
         # use talib to compute crossover. This returns a series object that is not part of the candles object.
         closeXema = candles.ta_lib.cross(candles.close, candles.ema)
+
         # add to the candles
         candles['closeXema'] = closeXema
         print(candles)