feat: add positional arguments for candles

Author: ksm2

python_bitvavo_api/bitvavo.py

@@ -36,6 +36,9 @@ def createPostfix(options):
 def _default(value, fallback):
   return value if value is not None else fallback
 
+def _epoch_millis(dt):
+  return int(dt.timestamp() * 1000)
+
 def asksCompare(a, b):
   if(a < b):
     return True
@@ -249,9 +252,15 @@ def publicTrades(self, symbol, options=None):
     return self.publicRequest((self.base + '/' + symbol + '/trades' + postfix))
 
   # options: limit, start, end
-  def candles(self, symbol, interval, options=None):
+  def candles(self, symbol, interval, options=None, limit=None, start=None, end=None):
     options = _default(options, {})
     options['interval'] = interval
+    if limit is not None:
+      options['limit'] = limit
+    if start is not None:
+      options['start'] = _epoch_millis(start)
+    if end is not None:
+      options['end'] = _epoch_millis(end)
     postfix = createPostfix(options)
     return self.publicRequest((self.base + '/' + symbol + '/candles' + postfix))
 

python_bitvavo_api/testApi.py

@@ -1,6 +1,5 @@
+from datetime import datetime, timezone
 from python_bitvavo_api.bitvavo import Bitvavo
-import sys
-import signal
 import time
 import json
 
@@ -48,10 +47,12 @@ def testREST(bitvavo):
   #   print(json.dumps(trade, indent=2))
 
   # Timestamp: candle[0], open: candle[1], high: candle[2], low: candle[3], close: candle[4], volume: candle[5]
-  # response = bitvavo.candles('BTC-EUR', '1h', {})
-  # for candle in response:
-  #   print(json.dumps(candle, indent=2))
-  
+  # candles = bitvavo.candles('BTC-EUR', '15m')
+  # candles = bitvavo.candles('BTC-EUR', '15m', limit=10)
+  # candles = bitvavo.candles('BTC-EUR', '15m', start=datetime(year=2024, month=1, day=1, hour=0, tzinfo=timezone.utc), end=datetime(year=2024, month=1, day=1, hour=1, tzinfo=timezone.utc))
+  # for candle in candles:
+  #   print('Timestamp', candle[0], ' open', candle[1], ' high', candle[2], ' low', candle[3], ' close', candle[4], ' volume', candle[5])
+
   # response = bitvavo.tickerPrice({})
   # print(json.dumps(response, indent=2))
 
@@ -115,7 +116,7 @@ def testREST(bitvavo):
   # for item in response:
   #   print(json.dumps(item, indent=2))
 
-# Normally you would define a seperate callback for every function.
+# Normally you would define a separate callback for every function.
 def callback(response):
   print("Callback:", json.dumps(response, indent=2))
 
@@ -172,4 +173,4 @@ def testWebsockets(bitvavo):
     websocket.closeSocket()
 
 if __name__ == '__main__':
-  main()
+  main()