GitHub release GitHub PyPI - Python Version Downloads PyPI - Wheel PyPI - Status Python application Total alerts Language grade: Python codecov Telegram Donations/week Patrons

UNICORN Binance REST API

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

An unofficial Python API to use the Binance REST API`s (com+testnet, com-margin+testnet, com-isolated_margin+testnet, com-futures+testnet, us, tr) in a easy, fast, flexible, robust and fully-featured way.

Part of ‘UNICORN Binance Suite’.

Description

This is a fork of Sam McHardy`s python-binance 0.7.10 - package. Extended, cleaned up and reduced to pure REST tasks, with PRs added and improved. No asyncio support!!

from unicorn_binance_rest_api.unicorn_binance_rest_api_manager import BinanceRestApiManager

api_key = "aaa"
api_secret = "bbb"
ubra = BinanceRestApiManager(api_key, api_secret, exchange="binance.com")

# get market depth
depth = ubra.get_order_book(symbol='BNBBTC')
print(f"{depth}")

# get all symbol prices
prices = ubra.get_all_tickers()
print(f"{prices}")

# get the used weight: https://github.com/binance-us/binance-official-api-docs/blob/master/rest-api.md#limits
print(f"Used weight: {ubra.get_used_weight()}")

What are the benefits of the UNICORN Binance REST API?

  • Supported exchanges:

Exchange Exchange string
Binance BinanceRestApiManager(exchange="binance.com")
Binance Testnet BinanceRestApiManager(exchange="binance.com-testnet")
Binance Margin BinanceRestApiManager(exchange="binance.com-margin")
Binance Margin Testnet BinanceRestApiManager(exchange="binance.com-margin-testnet")
Binance Isolated Margin BinanceRestApiManager(exchange="binance.com-isolated_margin")
Binance Isolated Margin Testnet BinanceRestApiManager(exchange="binance.com-isolated_margin-testnet")
Binance USD-M Futures BinanceRestApiManager(exchange="binance.com-futures")
Binance USD-M Futures Testnet BinanceRestApiManager(exchange="binance.com-futures-testnet")
Binance Coin-M Futures BinanceRestApiManager(exchange="binance.com-coin-futures")
Binance US BinanceRestApiManager(exchange="binance.us")
Binance TR BinanceRestApiManager(exchange="trbinance.com")

Installation and Upgrade

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-rest-api --upgrade

From source of the latest release with PIP from Github

Linux, macOS, …

Run in bash:

pip install https://github.com/oliver-zehentleitner/unicorn-binance-rest-api/archive/$(curl -s https://api.github.com/repos/oliver-zehentleitner/unicorn-binance-rest-api/releases/latest | grep -oP '"tag_name": "\K(.*)(?=")').tar.gz --upgrade

Windows

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

pip install https://github.com/oliver-zehentleitner/unicorn-binance-rest-api/archive/1.3.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/oliver-zehentleitner/unicorn-binance-rest-api/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

Documentation

Receive Notifications

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

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

How to report Bugs or suggest Improvements?

List of planned features - click thumbs-up 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 REST API 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

Contributors

We love open source!

Commercial Support

Need a Python developer or consulting?

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