A unit-tested fork of the Bitvavo API
Project description
Bitvavo API (upgraded)
Hi, this is not the official API, but this one has:
- build-in documentation
- typing for all functions and classes
- unit tests (I already found
threefourfivesix bugs that I fixed, because the original code wasn't tested, at all) - a changelog, so you can track of the changes that I make
- compatible with Python 3.7 and newer (3.6 isn't supported as of 2021-12-23)
- a working version of
getRemainingLimit()
- will actually wait until the ban has been lifted (in case you get banned)
- more stable api-calls, due to calculating lag between client and server
- fancy logging via
structlog
, including external loggers like from the urllib3 and websocket libs! - a working
ACCESSWINDOW
variable that actually times the api calls out - makes failing Bitvavo API calls fail faster!
Version 1.*
is guaranteed compatible* with the original API.
*: Except for Bitvavo.candles
. I had to renamed the symbol
argument to market
, because the candles
call actually excpects a market
. So that's more of a bugfix.
**: Same goes for Bitvavo.book
; it had the same problem as candles
.
***: And I removed the rateLimitThread
class, but that should've been used internally only anyway
Customizable settings
Through the magic of the python-decouple lib, when you use this lib, you can create a settings.ini
(Windows example) or a .env
(Linux example) and add some handy settings there.
Here is an example list of the settings for this lib:
BITVAVO_API_UPGRADED_LOG_LEVEL=INFO # Set the lib's log level
BITVAVO_API_UPGRADED_LOG_EXTERNAL_LEVEL=WARNING # Set the libs that are used by *this* lib's log level
BITVAVO_API_UPGRADED_LAG=50 # the time difference between the server and your local time (you'll have to calculate this yourself - tip: use the bitvavo.time() functionality in a separate script)
BITVAVO_API_UPGRADED_RATE_LIMITING_BUFFER=25 # default 25, set to 50 if you get "you have been banned" messages (or even higher, if needed)
Links
- Official API Documentation
- Official Trading Rules (recommended read, as it explains a lot of jargon; It's OK to not understand this document if you're just starting out - I don't fully understand the document either)
- Github for this lib
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for bitvavo-api-upgraded-1.14.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 84ab807aa069aeed929d6d0217fb69ef87e178782d13e83b24a4dd2ca839ecc9 |
|
MD5 | ce45a1038bae7d4a553233c2abb4b2f5 |
|
BLAKE2b-256 | bcb2f8de0e176b4baa581bdb20a935b2cdc6826b647b8e6853b0d5f151f47aa8 |
Hashes for bitvavo_api_upgraded-1.14.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2878e55b77858bf7800da2dc74ca9e56500369602bf2c320f33d0f247432416f |
|
MD5 | 836fd0362f912e44900a3304af8cc36f |
|
BLAKE2b-256 | f367a27fec4d19ba25d7312cc7295a6ca4245c41db9bf569b71b9663007ab721 |