UNICORN Binance REST API

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

A Python SDK by LUCIT to use the Binance REST API`s (com+testnet, com-margin+testnet,
com-isolated_margin+testnet, com-futures+testnet, us, tr) in a simple, fast, flexible, robust and fully-featured way.

Part of ‘UNICORN Binance Suite’.

Get help with the integration of the UNICORN Binance Suite modules!

Get a UNICORN Binance Suite License

To run modules of the UNICORN Binance Suite you need a valid license!

Receive Data from Binance REST API Endpoints

Initiate BinanceRestApiManager()

from unicorn_binance_rest_api import BinanceRestApiManager
ubra = BinanceRestApiManager(api_key="YOUR_BINANCE_API_KEY", 
                             api_secret="YOUR_BINANCE_API_SECRET", 
                             exchange="binance.com")

Print a snapshot of an order book

print(f"BNBBTC order book: {ubra.get_order_book(symbol='BNBBTC')}")

Get all symbol prices

print(f"All tickers:\r\n{ubra.get_all_tickers()}")

Get the used weight

Please Note:
https://github.com/binance-us/binance-official-api-docs/blob/master/rest-api.md#limits

print(f"Used weight: {ubra.get_used_weight()}")

Send data to Binance REST API Endpoints

Initiate BinanceRestApiManager()

ubra = BinanceRestApiManager(api_key="YOUR_BINANCE_API_KEY", 
                             api_secret="YOUR_BINANCE_API_SECRET", 
                             exchange="binance.com-isolated_margin")

Buy BTC with a market order using 100 USDT

buy_order = ubra.create_margin_order(symbol="BTCUSDT",
                                     isIsolated="TRUE",
                                     side="BUY",
                                     type="MARKET",
                                     quoteOrderQty=100)
print(f"Buy Order Result: {buy_order}")

Stop ubra after usage to avoid memory leaks

When you instantiate UBRA with with, ubra.stop_manager() is automatically executed upon exiting the with-block.

with BinanceRestApiManager() as ubra:
    depth = ubra.get_order_book(symbol='BNBBTC')

Without with, you must explicitly execute ubra.stop_manager() yourself.

ubra.stop_manager()

More?

Discover even more possibilities
or try our examples!

Description

The Python module UNICORN Binance REST API
provides an API to the Binance REST API`s of
Binance
(+Testnet),
Binance Margin
(+Testnet),
Binance Isolated Margin
(+Testnet),
Binance Futures
(+Testnet),
Binance COIN-M Futures,
Binance US and
Binance TR and needs to be used with a valid
api_key and api_secret
from the Binance Exchange
www.binance.com,
testnet.binance.vision or
www.binance.us.

Be aware that the Binance REST API is request based. if you want to send and receive high frequency and high volume
data, you can use the UNICORN Binance Websocket API in
combination.

What are the benefits of the UNICORN Binance REST API?

• Supported exchanges:

• Helpful management features like
  get_used_weight(),

• Available as a package via pip and conda as precompiled C extension with stub files for improved Intellisense
  functions and source code for easier debugging of the source code. To the installation.

• Integration of test cases and examples.

• Customizable base URL and request timeout.

• Socks5 Proxy support:

  ubra = BinanceRestApiManager(exchange="binance.com", socks5_proxy_server="127.0.0.1:9050")

  Read the docs
  or this @oliverzehentleitner/how-to-connect-to-binance-com-rest-api-using-python-via-a-socks5-proxy-638dbbecacfd">how to
  for more information or try
  example_socks5_proxy.py.

• Excessively tested on Linux, Mac and Windows

If you like the project, please it on
GitHub!

Installation and Upgrade

The module requires Python 3.7 and runs smoothly up to and including Python 3.12.

Anaconda packages are available from Python version 3.8 and higher, but only in the latest version!

For the PyPy interpreter we offer packages only from Python version 3.9 and higher.

The current dependencies are listed
here.

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

Packages are created automatically with GitHub Actions

When a new release is to be created, we start two GitHubActions:

• Build and Publish Anaconda
• Build and Publish GH+PyPi

Both start virtual Windows/Linux/Mac servers provided by GitHub in the cloud with preconfigured environments and
create the respective compilations and stub files, pack them into wheels and conda packages and then publish them on
GitHub, PYPI and Anaconda. This is a transparent method that makes it possible to trace the source code behind a
compilation.

A Cython binary, PyPy or source code based CPython wheel of the latest version with pip from PyPI

Our Cython and PyPy Wheels are available on PyPI,
these wheels offer significant advantages for Python developers:

• Performance Boost with Cython Wheels: Cython is a programming language that supplements Python with static typing and C-level performance. By compiling
  Python code into C, Cython Wheels can significantly enhance the execution speed of Python code, especially in
  computationally intensive tasks. This means faster runtimes and more efficient processing for users of our package.

• PyPy Wheels for Enhanced Efficiency: PyPy is an alternative Python interpreter known for its speed and efficiency. It uses Just-In-Time (JIT) compilation,
  which can dramatically improve the performance of Python code. Our PyPy Wheels are tailored for compatibility with
  PyPy, allowing users to leverage this speed advantage seamlessly.

Both Cython and PyPy Wheels on PyPI make the installation process simpler and more straightforward. They ensure that
you get the optimized version of our package with minimal setup, allowing you to focus on development rather than
configuration.

On Raspberry Pi and other architectures for which there are no pre-compiled versions, the package can still be
installed with PIP. PIP then compiles the package locally on the target system during installation. Please be patient,
this may take some time!

Installation

pip install unicorn-binance-rest-api

Update

pip install unicorn-binance-rest-api --upgrade

A Conda Package of the latest version with conda from Anaconda

The unicorn-binance-rest-api package is also available as a Cython version for the linux-64, osx-64
and win-64 architectures with Conda through the
lucit channel.

For optimal compatibility and performance, it is recommended to source the necessary dependencies from the
conda-forge channel.

Installation

conda config --add channels conda-forge
conda config --add channels lucit
conda install -c lucit unicorn-binance-rest-api

Update

conda update -c lucit unicorn-binance-rest-api

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-rest-api/archive/$(curl -s https://api.github.com/repos/lucit-systems-and-development/unicorn-binance-rest-api/releases/latest | grep -oP '"tag_name": "\K(.*)(?=")').tar.gz --upgrade

Windows

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

pip install https://github.com/LUCIT-Systems-and-Development/unicorn-binance-rest-api/archive/2.6.1.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-rest-api/tarball/master --upgrade

Conda environment, Virtualenv or plain Python

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

• ./environment.yml
• ./meta.yaml
• ./pyproject.toml
• ./requirements.txt
• ./setup.py

Change Log

https://unicorn-binance-rest-api.docs.lucit.tech/changelog.html

Documentation

• General
• Modules

Examples

• Look here!

Howto

• How to Obtain and Use a Unicorn Binance Suite License Key and Run the UBS Module According to Best Practice
• Restful Binance Requests in Python with UNICORN Binance REST API
• How to Download Klines from Binance using Python?
• How to Connect to binance.com REST API using Python via a SOCKS5 Proxy
• Buy an Asset and instantly create a Take Profit and Stop Loss OCO Sell Order using Python in Binance Isolated Margin

Project Homepage

https://www.lucit.tech/unicorn-binance-rest-api.html

Wiki

https://github.com/LUCIT-Systems-and-Development/unicorn-binance-rest-api/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_availabe().

Follow us on GitHub, Medium,
@LUCIT_Systems_and_Development">YouTube,
LinkedIn,
X or Facebook!

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_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 don’t 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

We open source!

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.

SOCKS5 Proxy / Geoblocking

We would like to explicitly point out that in our opinion US citizens are exclusively authorized to trade on Binance.US
and that this restriction must not be circumvented!

The purpose of supporting a SOCKS5 proxy in the UNICORN Binance Suite and its modules is to allow non-US citizens to use
US services. For example, GitHub actions with UBS will not work without a SOCKS5 proxy, as they will inevitably run on
servers in the US and be blocked by Binance.com. Moreover, it also seems justified that traders, data scientists and
companies from the US analyze binance.com market data - as long as they do not trade there.

Commercial Support

Do you need a developer, operator or consultant? Contact us for a non-binding initial consultation!