Merge pull request #42 from bitvavo/feat/FAVO-8349-option-arguments

Feat: Improve option arguments

Author: ksm2

python_bitvavo_api/bitvavo.py

@@ -24,6 +24,7 @@ def createSignature(timestamp, method, url, body, APISECRET):
   return signature
 
 def createPostfix(options):
+  options = _default(options, {})
   params = []
   for key in options:
     params.append(key + '=' + str(options[key]))
@@ -32,6 +33,12 @@ def createPostfix(options):
     postfix = '?' + postfix
   return postfix
 
+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
@@ -225,43 +232,50 @@ def time(self):
     return self.publicRequest((self.base + '/time'))
 
   # options: market
-  def markets(self, options):
+  def markets(self, options=None):
     postfix = createPostfix(options)
     return self.publicRequest((self.base + '/markets' + postfix))
 
   # options: symbol
-  def assets(self, options):
+  def assets(self, options=None):
     postfix = createPostfix(options)
     return self.publicRequest((self.base + '/assets' + postfix))
 
   # options: depth
-  def book(self, symbol, options):
+  def book(self, symbol, options=None):
     postfix = createPostfix(options)
     return self.publicRequest((self.base + '/' + symbol + '/book' + postfix))
 
   # options: limit, start, end, tradeIdFrom, tradeIdTo
-  def publicTrades(self, symbol, options):
+  def publicTrades(self, symbol, options=None):
     postfix = createPostfix(options)
     return self.publicRequest((self.base + '/' + symbol + '/trades' + postfix))
 
   # options: limit, start, end
-  def candles(self, symbol, interval, options):
+  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))
 
   # options: market
-  def tickerPrice(self, options):
+  def tickerPrice(self, options=None):
     postfix = createPostfix(options)
     return self.publicRequest((self.base + '/ticker/price' + postfix))
 
   # options: market
-  def tickerBook(self, options):
+  def tickerBook(self, options=None):
     postfix = createPostfix(options)
     return self.publicRequest((self.base + '/ticker/book' + postfix))
 
   # options: market
-  def ticker24h(self, options):
+  def ticker24h(self, options=None):
     postfix = createPostfix(options)
     return self.publicRequest((self.base + '/ticker/24h' + postfix))
 
@@ -292,23 +306,25 @@ def cancelOrder(self, market, orderId):
     return self.privateRequest('/order', postfix, {}, 'DELETE')
 
   # options: limit, start, end, orderIdFrom, orderIdTo
-  def getOrders(self, market, options):
+  def getOrders(self, market, options=None):
+    options = _default(options, {})
     options['market'] = market
     postfix = createPostfix(options)
     return self.privateRequest('/orders', postfix, {}, 'GET')
 
   # options: market
-  def cancelOrders(self, options):
+  def cancelOrders(self, options=None):
     postfix = createPostfix(options)
     return self.privateRequest('/orders', postfix, {}, 'DELETE')
 
   # options: market
-  def ordersOpen(self, options):
+  def ordersOpen(self, options=None):
     postfix = createPostfix(options)
     return self.privateRequest('/ordersOpen', postfix, {}, 'GET')
 
   # options: limit, start, end, tradeIdFrom, tradeIdTo
-  def trades(self, market, options):
+  def trades(self, market, options=None):
+    options = _default(options, {})
     options['market'] = market
     postfix = createPostfix(options)
     return self.privateRequest('/trades', postfix, {}, 'GET')
@@ -317,7 +333,7 @@ def account(self):
     return self.privateRequest('/account', '', {}, 'GET')
 
   # options: symbol
-  def balance(self, options):
+  def balance(self, options=None):
     postfix = createPostfix(options)
     return self.privateRequest('/balance', postfix, {}, 'GET')
 
@@ -333,12 +349,12 @@ def withdrawAssets(self, symbol, amount, address, body):
     return self.privateRequest('/withdrawal', '', body, 'POST')
 
   # options: symbol, limit, start, end
-  def depositHistory(self, options):
+  def depositHistory(self, options=None):
     postfix = createPostfix(options)
     return self.privateRequest('/depositHistory', postfix, {}, 'GET')
 
   # options: symbol, limit, start, end
-  def withdrawalHistory(self, options):
+  def withdrawalHistory(self, options=None):
     postfix = createPostfix(options)
     return self.privateRequest('/withdrawalHistory', postfix, {}, 'GET')
 

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
 
@@ -32,26 +31,28 @@ def testREST(bitvavo):
   response = bitvavo.time()
   print(response)
 
-  # response = bitvavo.markets({})
+  # response = bitvavo.markets()
   # for market in response:
   #   print(json.dumps(market, indent=2))
 
-  # response = bitvavo.assets({})
+  # response = bitvavo.assets()
   # for asset in response:
   #   print(json.dumps(asset, indent=2))
 
-  # response = bitvavo.book('BTC-EUR', {})
+  # response = bitvavo.book('BTC-EUR')
   # print(json.dumps(response, indent=2))
 
-  # response = bitvavo.publicTrades('BTC-EUR', {})
+  # response = bitvavo.publicTrades('BTC-EUR')
   # for trade in response:
   #   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))
 
@@ -78,26 +79,26 @@ def testREST(bitvavo):
   # response = bitvavo.cancelOrder('BTC-EUR', 'dd055772-0f02-493c-a049-f4356fa0d221')
   # print(json.dumps(response, indent=2))
 
-  # response = bitvavo.getOrders('BTC-EUR', {})
+  # response = bitvavo.getOrders('BTC-EUR')
   # for item in response:
   #   print(json.dumps(item, indent=2))
 
   # response = bitvavo.cancelOrders({ 'market': 'BTC-EUR' })
   # for item in response:
   #   print(json.dumps(item, indent=2))
 
-  # response = bitvavo.ordersOpen({})
+  # response = bitvavo.ordersOpen()
   # for item in response:
   #   print(json.dumps(item, indent=2))
 
-  # response = bitvavo.trades('BTC-EUR', {})
+  # response = bitvavo.trades('BTC-EUR')
   # for item in response:
   #   print(json.dumps(item, indent=2))
 
   # response = bitvavo.account()
   # print(json.dumps(response, indent=2))
 
-  # response = bitvavo.balance({})
+  # response = bitvavo.balance()
   # for item in response:
   #   print(json.dumps(item, indent=2))
 
@@ -107,15 +108,15 @@ def testREST(bitvavo):
   # response = bitvavo.withdrawAssets('BTC', '1', 'BitcoinAddress', {})
   # print(json.dumps(response, indent=2))
 
-  # response = bitvavo.depositHistory({})
+  # response = bitvavo.depositHistory()
   # for item in response:
   #   print(json.dumps(item, indent=2))
 
-  # response = bitvavo.withdrawalHistory({})
+  # response = bitvavo.withdrawalHistory()
   # 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()