UNICORN Binance Local Depth Cache

Description | Installation | Documentation | Examples | Change Log | Wiki | Social | Notifications | Bugs | Contributing | Leave a review |Disclaimer | 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("BTCUSDT")

Get the asks and bids depth with:

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

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("BTCUSDT")

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 the current order book depth at any time while transferring as little data as necessary. A REST snapshot takes a lot of time and the amount of data that is transferred is relatively large. Continuous full transmission of the order book via websocket is faster, but the amount of data is huge. A local depth_cache is initialized once with a REST snapshot and then handles Diff. Depth updates applied by the websocket connection. 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 (local) access to the data without exceeding the Binance request weight limits.

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	binance.com
Binance Testnet	binance.com-testnet
Binance USD-M Futures	binance.com-futures
Binance USD-M Futures Testnet	binance.com-futures-testnet
More are coming ...	-

• Create multiple depth caches within a single object instance.
• Each depth_cache is processed in a separate thread.
• Start or stop multiple caches with just one command create_depth_cache() or stop_depth_cache().
• Control websocket out of sync detection with websocket_ping_interval, websocket_ping_timeout and websocket_close_timeout
• Powered by UNICORN Binance REST API and UNICORN Binance WebSocket API.

If you like the project, please it on GitHub!

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 and a source file of the latest release with pip from PyPI

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

A conda package of the latest release with conda from Anaconda via CONDA-FORGE.

conda install -c conda-forge unicorn-binance-local-depth-cache

conda update -c conda-forge unicorn-binance-local-depth-cache

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/Binance_JEX_EN
• https://t.me/Binance_USA
• https://t.me/TRBinanceTR
• https://t.me/BinanceDEXchange
• https://t.me/BinanceExchange

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!

You want to say Thank You?

We hope you are enjoying using our libraries and that they are proving to be useful to you. If you have a moment, we would greatly appreciate it if you could leave us a review on Google. Thank you for your support!

Disclaimer

This project is for informational purposes only. You should not construe this information or any other material as legal, tax, investment, financial or other advice. Nothing contained herein constitutes a solicitation, recommendation, endorsement or offer by us or any third party provider to buy or sell any securities or other financial instruments in this or any other jurisdiction in which such solicitation or offer would be unlawful under the securities laws of such jurisdiction.

If you intend to use real money, use it at your own risk.

Under no circumstances will we be responsible or liable for any claims, damages, losses, expenses, costs or liabilities of any kind, including but not limited to direct or indirect damages for loss of profits.