An unofficial Python API to use the Binance REST API`s.
Project description
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") |
- Helpful management features like
get_used_weight()
,
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
Change Log
https://oliver-zehentleitner.github.io/unicorn-binance-rest-api/CHANGELOG.html
Documentation
Examples
- example_doing_something.py
- example_easy_migration_from_python-binance.py
- example_orders.py
- example_version_of_this_package.py
Howto
Project Homepage
https://github.com/oliver-zehentleitner/unicorn-binance-rest-api
Wiki
https://github.com/oliver-zehentleitner/unicorn-binance-rest-api/wiki
Social
- https://t.me/unicorndevs
- unicorn-coding-club
- 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()
.
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/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!
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!
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.
Donate
Developing, documenting and testing the UNICORN Binance Suite and supporting the community takes a lot of time and time is a form of cost. I am extremely happy to do this, but need a solution for sharing the costs.
I think we are lucky, as our community consists of traders and programmers I expect to find mostly rational thinking people who also benefit financially from these libraries.
I would like to create a fair model for funding. My goals are that unicorn-binance-websocket-api, unicorn-binance-rest-api and unicorn-fy remain freely available as open source and that I am compensated at least to some extent and thus can invest my time more easily.
If you know the hooker principle from negotiation research or game theory, you know about the problem that people don't often pay for something out of their own impulse if they have already received it for free.
So my idea is to give every donor who gives an amount over 50 EUR access to a private Github repository where Python classes for trading algos are provided (OrderBook, advanced stop-loss, ...). Moreover, maybe a nice ApiTrader community will be formed.
So the donor not only helps to push the open source development but also gets access to a well maintained collection of practical code for little money.
Furthermore community members can help me by donating own developments to make the unicorn-coding-club repository more attractive to create further incentives for new donors. This way we generate added value for all sides in an uncomplicated way.
If you donated at least 50 EUR (without transaction fee), please send me a message with a confirmation and your Github username via https://www.lucit-development.co/contact.html, I will invite you to the unicorn-coding-club as soon as possible.
Terra (LUNA, UST, ...): terra1yt34qmmycextztnj9mpt3mnjzqqvl8jtqqq7g9
BTC: 39fS74fvcGnmEk8JUV8bG6P1wkdH29GtsA
DASH: XsRhBuPkXGF9WvifdpkVhTGSmVT4VcuQZ7
ETH: 0x1C15857Bf1E18D122dDd1E536705748aa529fc9C
LTC: LYNzHMFUbee3siyHvNCPaCjqXxjyq8YRGJ
XMR: 85dzsTRh6GRPGVSJoUbFDwAf9uwwAdim1HFpiGshLeKHgj2hVqKtYVPXMZvudioLsuLS1AegkUiQ12jwReRwWcFvF7kDAbF
ZEC: t1WvQMPJMriGWD9qkZGDdE9tTJaawvmsBie
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distribution
File details
Details for the file unicorn_binance_rest_api-1.3.0-py3-none-any.whl
.
File metadata
- Download URL: unicorn_binance_rest_api-1.3.0-py3-none-any.whl
- Upload date:
- Size: 44.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.22.0 setuptools/54.1.2 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.8.10
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8489d68f307e4a41b4a0d22074bbe3f9eae5dd409da92f56472825074b994417 |
|
MD5 | c5cce0f101543c39e5afccb2ae9f19ad |
|
BLAKE2b-256 | 53cc2024731680b6307d7229dc4d8d3eeb08f8539ba23576c02b98030df37cc0 |