✨ New account endpoint, stoploss example

Author: Joeri van Vuuren

.gitignore

@@ -0,0 +1,4 @@
+.DS_Store
+setup.py
+dist
+python_bitvavo_api.egg-info

README.md

@@ -27,6 +27,7 @@ This is the python wrapper for the Bitvavo API. This project can be used to buil
   * Cancel Orders       [REST](https://github.com/bitvavo/python-bitvavo-api#cancel-orders) [Websocket](https://github.com/bitvavo/python-bitvavo-api#cancel-orders-1)
   * Orders Open         [REST](https://github.com/bitvavo/python-bitvavo-api#get-orders-open) [Websocket](https://github.com/bitvavo/python-bitvavo-api#get-orders-open-1)
   * Trades              [REST](https://github.com/bitvavo/python-bitvavo-api#get-trades) [Websocket](https://github.com/bitvavo/python-bitvavo-api#get-trades-1)
+  * Account             [REST](https://github.com/bitvavo/python-bitvavo-api#get-account) [Websocket](https://github.com/bitvavo/python-bitvavo-api#get-account-1)
   * Balance             [REST](https://github.com/bitvavo/python-bitvavo-api#get-balance) [Websocket](https://github.com/bitvavo/python-bitvavo-api#get-balance-1)
   * Deposit Assets     [REST](https://github.com/bitvavo/python-bitvavo-api#deposit-assets) [Websocket](https://github.com/bitvavo/python-bitvavo-api#deposit-assets-1)
   * Withdraw Assets   [REST](https://github.com/bitvavo/python-bitvavo-api#withdraw-assets) [Websocket](https://github.com/bitvavo/python-bitvavo-api#withdraw-assets-1)
@@ -563,7 +564,9 @@ print(response)
 When placing an order, make sure that the correct optional parameters are set. For a limit order it is required to set both the amount and price. A market order is valid if either amount or amountQuote is set.
 ```python
 # optional parameters: limit:(amount, price, postOnly), market:(amount, amountQuote, disableMarketProtection),
-# both: timeInForce, selfTradePrevention, responseRequired
+#                      stopLoss/takeProfit:(amount, amountQuote, disableMarketProtection, triggerType, triggerReference, triggerAmount)
+#                      stopLossLimit/takeProfitLimit:(amount, price, postOnly, triggerType, triggerReference, triggerAmount)
+#                      all orderTypes: timeInForce, selfTradePrevention, responseRequired
 response = bitvavo.placeOrder('BTC-EUR', 'buy', 'limit', { 'amount': '1', 'price': '3000' })
 print(response)
 ```
@@ -601,7 +604,8 @@ print(response)
 When updating an order make sure that at least one of the optional parameters has been set. Otherwise nothing can be updated.
 ```python
 # Optional parameters: limit:(amount, amountRemaining, price, timeInForce, selfTradePrevention, postOnly)
-# (set at least 1) (responseRequired can be set as well, but does not update anything)
+#          untriggered stopLoss/takeProfit:(amount, amountQuote, disableMarketProtection, triggerType, triggerReference, triggerAmount)
+#                      stopLossLimit/takeProfitLimit: (amount, price, postOnly, triggerType, triggerReference, triggerAmount)
 response = bitvavo.updateOrder('BTC-EUR', '5444f908-67c4-4c5d-a138-7e834b94360e', { 'amount': '1.1' })
 print(response)
 ```
@@ -923,6 +927,26 @@ print(response)
 ```
 </details>
 
+#### Get account
+Returns the fee tier for this account.
+```python
+response = bitvavo.account()
+print(response)
+```
+<details>
+ <summary>View Response</summary>
+
+```python
+{
+  "fees": {
+    "taker": "0.0025",
+    "maker": "0.0015",
+    "volume": "100.00"
+  }
+}
+```
+</details>
+
 #### Get balance
 Returns the balance for this account.
 ```python
@@ -1584,7 +1608,9 @@ websocket.ticker24h({}, timeCallback)
 When placing an order, make sure that the correct optional parameters are set. For a limit order it is required to set both the amount and price. A market order is valid if either amount or amountQuote has been set.
 ```python
 # optional parameters: limit:(amount, price, postOnly), market:(amount, amountQuote, disableMarketProtection),
-# both: timeInForce, selfTradePrevention, responseRequired
+#                      stopLoss/takeProfit:(amount, amountQuote, disableMarketProtection, triggerType, triggerReference, triggerAmount)
+#                      stopLossLimit/takeProfitLimit:(amount, price, postOnly, triggerType, triggerReference, triggerAmount)
+#                      all orderTypes: timeInForce, selfTradePrevention, responseRequired
 websocket.placeOrder('BTC-EUR', 'buy', 'limit', { 'amount': '1', 'price': '3000' }, ownCallback)
 ```
 <details>
@@ -1621,7 +1647,8 @@ websocket.placeOrder('BTC-EUR', 'buy', 'limit', { 'amount': '1', 'price': '3000'
 When updating an order make sure that at least one of the optional parameters has been set. Otherwise nothing can be updated.
 ```python
 # Optional parameters: limit:(amount, amountRemaining, price, timeInForce, selfTradePrevention, postOnly)
-# (set at least 1) (responseRequired can be set as well, but does not update anything)
+#          untriggered stopLoss/takeProfit:(amount, amountQuote, disableMarketProtection, triggerType, triggerReference, triggerAmount)
+#                      stopLossLimit/takeProfitLimit: (amount, price, postOnly, triggerType, triggerReference, triggerAmount)
 websocket.updateOrder('BTC-EUR', '5444f908-67c4-4c5d-a138-7e834b94360e', { 'amount': '1.1' }, ownCallback)
 ```
 <details>
@@ -1936,6 +1963,25 @@ websocket.trades('BTC-EUR', {}, ownCallback)
 ```
 </details>
 
+#### Get account
+Returns the fee tier for this account.
+```python
+websocket.account(ownCallback)
+```
+<details>
+ <summary>View Response</summary>
+
+```python
+{
+  "fees": {
+    "taker": "0.0025",
+    "maker": "0.0015",
+    "volume": "100.00"
+  }
+}
+```
+</details>
+
 #### Get balance
 Returns the balance for this account.
 ```python

python_bitvavo_api/bitvavo.py

@@ -269,7 +269,10 @@ def ticker24h(self, options):
     postfix = createPostfix(options)
     return self.publicRequest((self.base + '/ticker/24h' + postfix))
 
-  # optional body parameters: limit:(amount, price, postOnly), market:(amount, amountQuote, disableMarketProtection), both: timeInForce, selfTradePrevention, responseRequired
+  # optional body parameters: limit:(amount, price, postOnly), market:(amount, amountQuote, disableMarketProtection)
+  #                           stopLoss/takeProfit:(amount, amountQuote, disableMarketProtection, triggerType, triggerReference, triggerAmount)
+  #                           stopLossLimit/takeProfitLimit:(amount, price, postOnly, triggerType, triggerReference, triggerAmount)
+  #                           all orderTypes: timeInForce, selfTradePrevention, responseRequired
   def placeOrder(self, market, side, orderType, body):
     body['market'] = market
     body['side'] = side
@@ -280,8 +283,9 @@ def getOrder(self, market, orderId):
     postfix = createPostfix({ 'market': market, 'orderId': orderId })
     return self.privateRequest('/order', postfix, {}, 'GET')
 
-  # Optional body parameters: limit:(amount, amountRemaining, price, timeInForce, selfTradePrevention, postOnly)
-  # (set at least 1) (responseRequired can be set as well, but does not update anything)
+  # Optional parameters: limit:(amount, amountRemaining, price, timeInForce, selfTradePrevention, postOnly)
+  #          untriggered stopLoss/takeProfit:(amount, amountQuote, disableMarketProtection, triggerType, triggerReference, triggerAmount)
+  #                      stopLossLimit/takeProfitLimit: (amount, price, postOnly, triggerType, triggerReference, triggerAmount)
   def updateOrder(self, market, orderId, body):
     body['market'] = market
     body['orderId'] = orderId
@@ -313,6 +317,9 @@ def trades(self, market, options):
     postfix = createPostfix(options)
     return self.privateRequest('/trades', postfix, {}, 'GET')
 
+  def account(self):
+    return self.privateRequest('/account', '', {}, 'GET')
+
   # options: symbol
   def balance(self, options):
     postfix = createPostfix(options)
@@ -438,6 +445,8 @@ def on_message(ws, msg):
           callbacks['ordersOpen'](msg['response'])
         elif(msg['action'] == 'privateGetTrades'):
           callbacks['trades'](msg['response'])
+        elif(msg['action'] == 'privateGetAccount'):
+          callbacks['account'](msg['response'])
         elif(msg['action'] == 'privateGetBalance'):
           callbacks['balance'](msg['response'])
         elif(msg['action'] == 'privateDepositAssets'):
@@ -594,7 +603,10 @@ def tickerBook(self, options, callback):
       options['action'] = 'getTickerBook'
       self.doSend(self.ws, json.dumps(options))
 
-    # optional body parameters: limit:(amount, price, postOnly), market:(amount, amountQuote, disableMarketProtection), both: timeInForce, selfTradePrevention, responseRequired
+    # optional body parameters: limit:(amount, price, postOnly), market:(amount, amountQuote, disableMarketProtection)
+    #                           stopLoss/takeProfit:(amount, amountQuote, disableMarketProtection, triggerType, triggerReference, triggerAmount)
+    #                           stopLossLimit/takeProfitLimit:(amount, price, postOnly, triggerType, triggerReference, triggerAmount)
+    #                           all orderTypes: timeInForce, selfTradePrevention, responseRequired
     def placeOrder(self, market, side, orderType, body, callback):
       self.callbacks['placeOrder'] = callback
       body['market'] = market
@@ -608,8 +620,9 @@ def getOrder(self, market, orderId, callback):
       options = { 'action': 'privateGetOrder', 'market': market, 'orderId': orderId }
       self.doSend(self.ws, json.dumps(options), True)
 
-    # Optional body parameters: limit:(amount, amountRemaining, price, timeInForce, selfTradePrevention, postOnly)
-    # (set at least 1) (responseRequired can be set as well, but does not update anything)
+    # Optional parameters: limit:(amount, amountRemaining, price, timeInForce, selfTradePrevention, postOnly)
+    #          untriggered stopLoss/takeProfit:(amount, amountQuote, disableMarketProtection, triggerType, triggerReference, triggerAmount)
+    #                      stopLossLimit/takeProfitLimit: (amount, price, postOnly, triggerType, triggerReference, triggerAmount)
     def updateOrder(self, market, orderId, body, callback):
       self.callbacks['updateOrder'] = callback
       body['market'] = market
@@ -648,6 +661,10 @@ def trades(self, market, options, callback):
       options['market'] = market
       self.doSend(self.ws, json.dumps(options), True)
 
+    def account(self, callback):
+      self.callbacks['account'] = callback
+      self.doSend(self.ws, json.dumps({ 'action': 'privateGetAccount' }), True)
+
     # options: symbol
     def balance(self, options, callback):
       options['action'] = 'privateGetBalance'

python_bitvavo_api/testApi.py

@@ -66,6 +66,9 @@ def testREST(bitvavo):
   # response = bitvavo.placeOrder('BTC-EUR', 'buy', 'limit', { 'amount': '0.1', 'price': '2000' })
   # print(json.dumps(response, indent=2))
 
+  # response = bitvavo.placeOrder('BTC-EUR', 'sell', 'stopLoss', { amount: '0.1', 'triggerType': 'price', 'triggerReference': 'lastTrade', 'triggerAmount': '5000' })
+  # print(json.dumps(response, indent=2))
+
   # response = bitvavo.getOrder('BTC-EUR', 'dd055772-0f02-493c-a049-f4356fa0d221')
   # print(json.dumps(response, indent=2))
 
@@ -91,6 +94,9 @@ def testREST(bitvavo):
   # for item in response:
   #   print(json.dumps(item, indent=2))
 
+  # response = bitvavo.account()
+  # print(json.dumps(response, indent=2))
+
   # response = bitvavo.balance({})
   # for item in response:
   #   print(json.dumps(item, indent=2))
@@ -142,6 +148,7 @@ def testWebsockets(bitvavo):
 
   # websocket.trades('BTC-EUR', {}, callback)
 
+  # websocket.account(callback)
   # websocket.balance({}, callback)
   # websocket.depositAssets('BTC', callback)
   # websocket.withdrawAssets('BTC', '1', 'BitcoinAddress', {}, callback)