bitvavo-api-upgraded
Advanced tools
pip install bitvavo_api_upgraded
Works the same as the official API lib, but I have:
echo "install development requirements"
uv sync
echo "run tox, a program that creates separate environments for different python versions, for testing purposes (among other things)"
uv run tox
I'm using semantic versioning, which means that changes mean this:
Copy the following block to CHANGELOG.md and add all information since last version bump
## $UNRELEASED
### Added
...
### Changed
...
### Removed
...
Commit those changes.
After that, run bump-my-version bump (major|minor|patch) to automatically
replace $UNRELEASED with the new version number, and also automatically tag
and commit (with tag) to release a new version via the Github workflow.
Perhaps a curious file, but it simply exists to let mypy know that the code is
typed: Don't forget py.typed for your typed Python package
below this line is the old README.md
Crypto starts with Bitvavo. You use Bitvavo SDK for Python to buy, sell, and store over 200 digital assets on Bitvavo from inside your app.
To trade and execute your advanced trading strategies, Bitvavo SDK for Python is a wrapper that enables you to easily call every endpoint in Bitvavo API.
This page shows you how to use Bitvavo SDK for Python with WebSockets. For REST, see the REST readme.
To start programming with Bitvavo SDK for Python you need:
Python3 installed on your development environment
If you are working on macOS, ensure that you have installed SSH certificates:
open /Applications/Python\ 3.12/Install\ Certificates.command
open /Applications/Python\ 3.12/Update\ Shell\ Profile.command
A Python app. Use your favorite IDE, or run from the command line
An API key and secret associated with your Bitvavo account
You control the actions your app can do using the rights you assign to the API key. Possible rights are:
View: retrieve information about your balance, account, deposit and withdrawals
Trade: place, update, view and cancel orders
Withdraw: withdraw funds
Best practice is to not grant this privilege, withdrawals using the API do not require 2FA and e-mail confirmation.
Want to quickly make a trading app? Here you go:
Install Bitvavo SDK for Python
In your Python app, add Bitvavo SDK for Python from pypi.org:
python -m pip install python_bitvavo_api
If you installed from test.pypi.com, update the requests library: pip install --upgrade requests.
Create a simple Bitvavo implementation
Add the following code to a new file in your app:
from python_bitvavo_api.bitvavo import Bitvavo
import json
import time
# Use this class to connect to Bitvavo and make your first calls.
# Add trading strategies to implement your business logic.
class BitvavoImplementation:
api_key = "<Replace with your your API key from Bitvavo Dashboard>"
api_secret = "<Replace with your API secret from Bitvavo Dashboard>"
bitvavo_engine = None
bitvavo_socket = None
# Connect securely to Bitvavo, create the WebSocket and error callbacks.
def __init__(self):
self.bitvavo_engine = Bitvavo({
'APIKEY': self.api_key,
'APISECRET': self.api_secret
})
self.bitvavo_socket = self.bitvavo_engine.newWebsocket()
self.bitvavo_socket.setErrorCallback(self.error_callback)
# Handle errors.
def error_callback(self, error):
print("Add your error message.")
#print("Errors:", json.dumps(error, indent=2))
# Retrieve the data you need from Bitvavo in order to implement your
# trading logic. Use multiple workflows to return data to your
# callbacks.
def a_trading_strategy(self):
self.bitvavo_socket.ticker24h({}, self.a_trading_strategy_callback)
# In your app you analyse data returned by the trading strategy, then make
# calls to Bitvavo to respond to market conditions.
def a_trading_strategy_callback(self, response):
# Iterate through the markets
for market in response:
match market["market"]:
case "ZRX-EUR":
print("Eureka, the latest bid for ZRX-EUR is: ", market["bid"] )
# Implement calculations for your trading logic.
# If they are positive, place an order: For example:
# self.bitvavo_socket.placeOrder("ZRX-EUR",
# 'buy',
# 'limit',
# { 'amount': '1', 'price': '00001' },
# self.order_placed_callback)
case "a different market":
print("do something else")
case _:
print("Not this one: ", market["market"])
def order_placed_callback(self, response):
# The order return parameters explain the quote and the fees for this trade.
print("Order placed:", json.dumps(response, indent=2))
# Add your business logic.
# Sockets are fast, but asynchronous. Keep the socket open while you are
# trading.
def wait_and_close(self):
# Bitvavo uses a weight based rate limiting system. Your app is limited to 1000 weight points per IP or
# API key per minute. The rate weighting for each endpoint is supplied in Bitvavo API documentation.
# This call returns the amount of points left. If you make more requests than permitted by the weight limit,
# your IP or API key is banned.
limit = self.bitvavo_engine.getRemainingLimit()
try:
while (limit > 0):
time.sleep(0.5)
limit = self.bitvavo_engine.getRemainingLimit()
except KeyboardInterrupt:
self.bitvavo_socket.closeSocket()
# Shall I re-explain main? Naaaaaaaaaa.
if __name__ == '__main__':
bvavo = BitvavoImplementation()
bvavo.a_trading_strategy()
bvavo.wait_and_close()
Add security information
You must supply your security information to trade on Bitvavo and see your
account information using the authenticate methods. Replace the values of
api_key and api_secret with your credentials from Bitvavo
Dashboard.
You can retrieve public information such as available markets, assets and current market without supplying your key and secret. However, unauthenticated calls have lower rate limits based on your IP address, and your account is blocked for longer if you exceed your limit.
Run your app
python3 <filename>.Your app connects to Bitvavo and returns a list the latest trade price for each market. You use this data to implement your trading logic.
This section explains global concepts about Bitvavo SDK for Python.
Bitvavo uses a weight based rate limiting system. Your app is limited to 1000 weight points per IP or API key per minute. When you make a call to Bitvavo API, your remaining weight points are returned in the header of each REST request.
Websocket methods do not return your returning weight points, you track your remaining weight points with a call to:
limit = bitvavo.getRemainingLimit()
If you make more requests than permitted by the weight limit, your IP or API key is banned.
The rate weighting for each endpoint is supplied in the Bitvavo API documentation.
For all methods, required parameters are passed as separate values, optional
parameters are passed as a dictionary. Return parameters are in dictionary
format: response['<key>'] = '<value>'. However, as a limit order requires more
information than a market order, some optional parameters are required when you
place an order.
You must set your API key and secret for authenticated endpoints, public endpoints do not require authentication.
FAQs
A unit-tested fork of the Bitvavo API
We found that bitvavo-api-upgraded demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
PyPI confirms no security flaws were exploited in the Ultralytics supply chain attack and highlights improvements for safer package publishing.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.