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.
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!
To run modules of the UNICORN Binance Suite you need a valid license!
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(f"BNBBTC order book: {ubra.get_order_book(symbol='BNBBTC')}")
print(f"All tickers:\r\n{ubra.get_all_tickers()}")
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()}")
ubra = BinanceRestApiManager(api_key="YOUR_BINANCE_API_KEY",
api_secret="YOUR_BINANCE_API_SECRET",
exchange="binance.com-isolated_margin")
buy_order = ubra.create_margin_order(symbol="BTCUSDT",
isIsolated="TRUE",
side="BUY",
type="MARKET",
quoteOrderQty=100)
print(f"Buy Order Result: {buy_order}")
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()
Discover even more possibilities or try our examples!
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 apikey and apisecret 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.
| Exchange | Exchange string |
|--------------------------------------------------------------------|---------------------------------------|
| Binance | binance.com
|
| Binance Testnet | binance.com-testnet
|
| Binance Margin | binance.com-margin
|
| Binance Margin Testnet | binance.com-margin-testnet
|
| Binance Isolated Margin | binance.com-isolated_margin
|
| Binance Isolated Margin Testnet | binance.com-isolated_margin-testnet
|
| Binance USD-M Futures | binance.com-futures
|
| Binance USD-M Futures Testnet | binance.com-futures-testnet
|
| Binance Coin-M Futures | binance.com-coin_futures
|
| Binance US | binance.us
|
| Binance TR | trbinance.com
|
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")
conda config --add channels conda-forge
conda config --add channels lucit
conda install -c lucit unicorn-binance-rest-api
`conda update -c lucit unicorn-binance-rest-api`
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`
Use the below command with the version (such as 2.6.1) you determined
[here](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-rest-api/releases/latest):
`pip install https://github.com/LUCIT-Systems-and-Development/unicorn-binance-rest-api/archive/2.6.1.tar.gz --upgrade`
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`
Download the [latest release](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-rest-api/releases/latest)
or the [current master branch](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-rest-api/archive/master.zip)
and use:
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!
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.
We open source!
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.
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.
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.
Do you need a developer, operator or consultant? Contact us for a non-binding initial consultation!