Skip to main content

An unofficial Python API to use the Binance REST API`s.

Project description

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 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 v0.7.10 - package. cleaned up and reduced to pure REST tasks, with PRs added and improved, but still 100% compatible with python-binance v0.7.10.

from unicorn_binance_rest_api.unicorn_binance_rest_api_manager import BinanceRestApiManager

api_key = "aaa"
api_secret = "bbb"
ubra = BinanceRestApiManager(api_key, api_secret)

# 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}")

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.0.0) you determined here:

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

Howto

Project Homepage

https://github.com/oliver-zehentleitner/unicorn-binance-rest-api

Wiki

https://github.com/oliver-zehentleitner/unicorn-binance-rest-api/wiki

Social

Receive Notifications

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

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.

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.

Donate using Liberapay

Terra (LUNA, UST, ...): terra1yt34qmmycextztnj9mpt3mnjzqqvl8jtqqq7g9
BTC: 39fS74fvcGnmEk8JUV8bG6P1wkdH29GtsA
DASH: XsRhBuPkXGF9WvifdpkVhTGSmVT4VcuQZ7
ETH: 0x1C15857Bf1E18D122dDd1E536705748aa529fc9C
LTC: LYNzHMFUbee3siyHvNCPaCjqXxjyq8YRGJ
XMR: 85dzsTRh6GRPGVSJoUbFDwAf9uwwAdim1HFpiGshLeKHgj2hVqKtYVPXMZvudioLsuLS1AegkUiQ12jwReRwWcFvF7kDAbF
ZEC: t1WvQMPJMriGWD9qkZGDdE9tTJaawvmsBie

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

unicorn_binance_rest_api-1.0.1-py3-none-any.whl (40.6 kB view details)

Uploaded Python 3

File details

Details for the file unicorn_binance_rest_api-1.0.1-py3-none-any.whl.

File metadata

  • Download URL: unicorn_binance_rest_api-1.0.1-py3-none-any.whl
  • Upload date:
  • Size: 40.6 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.5

File hashes

Hashes for unicorn_binance_rest_api-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 5261143d91c7c158b6025596b5a0b56fde425e22f05e743ee4cfce27dc633754
MD5 0e413822e3b97405cf76d9db88c23505
BLAKE2b-256 ec3ea37a78f22bd24b5f2b9a1e3027a4f88f9dfcb7736bc1abd6185845fb858e

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page