unicorn-binance-local-depth-cache 0.5.0

No project description provided

UNICORN Binance Local Depth Cache

Description | Installation | Documentation | Examples | Change Log | Wiki | Social | Notifications | Bugs | Contributing| Commercial Support

A local Binance DepthCache Manager for Python that supports multiple depth caches in one instance in a easy, fast, flexible, robust and fully-featured way.

Part of 'UNICORN Binance Suite'.

Create a local depth_cache for Binance with just 3 lines of code:

import unicorn_binance_local_depth_cache

ubldc = unicorn_binance_local_depth_cache.BinanceLocalDepthCacheManager(exchange="binance.com")
ubldc.create_depth_cache("LUNABTC")

Get the asks and bids depth with:

asks = ubldc.get_asks("LUNABTC")
bids = ubldc.get_bids("LUNABTC")

Catch an exception, if the depth_cache is out of sync while accessing its data:

try:
    print(f"Top 10 asks: {ubldc.get_asks(market=market)[:10]}")
    print(f"Top 10 bids: {ubldc.get_bids(market=market)[:10]}")
except DepthCacheOutOfSync as error_msg:
    print(f"ERROR: {error_msg}")

Stop and delete a depth_cache:

ubldc.stop_depth_cache("LUNABTC")

Stop the full instance:

ubldc.stop_manager_with_all_depth_caches()

Get the right logger:

logging.getLogger("unicorn_binance_local_depth_cache")

Discover more possibilities.

Description

The Python package UNICORN Binance Local Depth Cache provides a local depth_cache for the Binance Exchanges Binance (+Testnet), Binance Futures (+Testnet) - more are coming soon.

The algorithm of the depth_cache management was designed according to these instructions:

• Binance Spot: "How to manage a local order book correctly"
• Binance Futures: "How to manage a local order book correctly"

By create_depth_cache() the depth_cache is started and initialized, that means for each depth_cache you want to create a separate thread is started. As soon as at least one depth update is received via websocket, a REST snapshot is downloaded and the depth updates are applied to it, keeping it in sync in real-time. Once this is done, the state of the cache is set to "synchronous".

Data in the depth_cache can be accessed with 'get_asks()' and 'get_bids()'. If the state of the depth_cache is not synchronous during access, the exception 'DepthCacheOutOfSync' is thrown.

The depth_cache will immediately start an automatic re-initialization if a gap in the UpdateID`s is detected (missing update event) or if the websocket connection is interrupted. As soon as this happens the state of the depth_cache is set to "out of sync" and when accessing the cache the exception 'DepthCacheOutOfSync' is thrown.

Why a local depth_cache?

A local depth_cache is the fastest way to access current order book depth. A REST snapshot takes a long time and the amount of data transferred is relatively large. A local depth_cache is initialized once with a REST snapshot and then applies depth updates of the websocket connection. Thus, by transferring a small amount of data (only the changes), a local depth_cache is kept in sync in real time and also allows extremely fast access to the data.

What are the benefits of the UNICORN Binance Local Depth Cache?

• Always know if the cache is in sync! If the depth_cache is out of sync, the exception 'DepthCacheOutOfSync' is thrown or ask with is_depth_cache_synchronized().
• If a depth cache is out of sync it gets refreshed automatically within a few seconds.
• 100% Websocket auto-reconnect!
• Supported Exchanges

Exchange	Exchange string
Binance	BinanceLocalDepthCacheManager(exchange="binance.com")
Binance Testnet	BinanceLocalDepthCacheManager(exchange="binance.com-testnet")
Binance USD-M Futures	BinanceLocalDepthCacheManager(exchange="binance.com-futures")
Binance USD-M Futures Testnet	BinanceLocalDepthCacheManager(exchange="binance.com-futures-testnet")
More are coming soon	-

• Create multiple depth caches within a single object instance.
• Each dept_cache is processed in a separate thread.
• Start or stop multiple caches with just one command create_depth_cache() or stop_depth_cache().
• Powered by UNICORN Binance REST API and UNICORN Binance WebSocket API.

Installation and Upgrade

The module requires Python 3.7 or above.

The current dependencies are listed here.

If you run into errors during the installation take a look here.

A wheel of the latest release with PIP from PyPI

pip install unicorn-binance-local-depth-cache --upgrade

From source of the latest release with PIP from Github

Linux, macOS, ...

Run in bash:

pip install https://github.com/LUCIT-Systems-and-Development/unicorn-binance-local-depth-cache/archive/$(curl -s https://api.github.com/repos/LUCIT-Systems-and-Development/unicorn-binance-local-depth-cache/releases/latest | grep -oP '"tag_name": "\K(.*)(?=")').tar.gz --upgrade

Windows

Use the below command with the version (such as 0.5.0) you determined here:

pip install https://github.com/LUCIT-Systems-and-Development/unicorn-binance-local-depth-cache/archive/0.5.0.tar.gz --upgrade

From the latest source (dev-stage) with PIP from Github

This is not a release version and can not be considered to be stable!

pip install https://github.com/LUCIT-Systems-and-Development/unicorn-binance-local-depth-cache/tarball/master --upgrade

Conda environment, Virtualenv or plain Python

Download the latest release or the current master branch and use:

• ./environment.yml
• ./requirements.txt
• ./setup.py

Change Log

https://lucit-systems-and-development.github.io/unicorn-binance-local-depth-cache/CHANGELOG.html

Documentation

• General
• Modules

Examples

• example_depth_cache.py
• example_log_to_console.py
• example_refresh_interval.py
• example_shared_ubwa_instance.py
• example_update_interval.py
• example_version_of_this_package.py

Project Homepage

https://github.com/LUCIT-Systems-and-Development/unicorn-binance-local-depth-cache

Wiki

https://github.com/LUCIT-Systems-and-Development/unicorn-binance-local-depth-cache/wiki

Social

• Discussions
• https://t.me/unicorndevs
• https://dev.binance.vision
• https://community.binance.org

Receive Notifications

To receive notifications on available updates you can the repository on GitHub, write your own script with using is_update_available().

Follow us on Twitter or on Facebook for general news about the unicorn-binance-suite!

To receive news (like inspection windows/maintenance) about the Binance API`s subscribe to their telegram groups:

• https://t.me/binance_api_announcements
• https://t.me/binance_api_english
• https://t.me/BinanceExchange
• https://t.me/Binance_USA
• https://t.me/Binance_JEX_EN
• https://t.me/BinanceDEXchange

How to report Bugs or suggest Improvements?

List of planned features - click if you need one of them or suggest a new feature!

Before you report a bug, try the latest release. If the issue still exists, provide the error trace, OS and Python version and explain how to reproduce the error. A demo script is appreciated.

If you dont find an issue related to your topic, please open a new issue!

Report a security bug!

Contributing

UNICORN Binance Local Depth Cache is an open source project which welcomes contributions which can be anything from simple documentation fixes and reporting dead links to new features. To contribute follow this guide.

Contributors

We open source!

Commercial Support

Do you need a developer, operator or consultant?

Contact me for a non-binding initial consultation via my company LUCIT from Vienna (Austria) or via Telegram.