Skip to main content

Convert received raw data from crypto exchange API endpoints into well-formed python dictionaries.

Project description

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

UnicornFy

Supported Exchanges | Installation | Documentation | Change Log | Wiki | Social | Notifications | Bugs | Contributing | Commercial Support | Donate

Convert received raw data from crypto exchange API endpoints into well-formed python dictionaries.

Part of 'UNICORN Binance Suite'.

from unicorn_fy.unicorn_fy import UnicornFy

received_stream_data_json = {"stream": "btcusdt@trade",
                             "data": {"e": "trade",
                                      "E": 1556876873656,
                                      "s": "BTCUSDT",
                                      "t": 117727701,
                                      "p": "5786.76000000",
                                      "q": "0.03200500",
                                      "b": 341831847,
                                      "a": 341831876,
                                      "T": 1556876873648,
                                      "m": True,
                                      "M": True}}

unicorn_fied_stream_data = UnicornFy.binance_com_websocket(received_stream_data_json)
print(unicorn_fied_stream_data)
>>>
{'stream_type': 'btcusdt@trade', 'event_type': 'trade', 'event_time': 1556876873656, 'symbol': 'BTCUSDT', 'trade_id': 117727701, 'price': '5786.76000000', 'quantity': '0.03200500', 'buyer_order_id': 341831847, 'seller_order_id': 341831876, 'trade_time': 1556876873648, 'is_market_maker': True, 'ignore': True, 'unicorn_fied': ['binance', '0.1.0']}

Supported Exchanges

Websockets

Exchange Docs Status
Binance (API) binance_com_websocket(stream_data_json) STABLE
Binance Testnet (API) binance_com_websocket(stream_data_json) STABLE
Binance Margin (API) binance_com_margin_websocket(stream_data_json) STABLE
Binance Margin Testnet (API) binance_com_margin_websocket(stream_data_json) STABLE
Binance Isolated Margin (API) binance_com_isolated_margin_websocket(stream_data_json) STABLE
Binance Isolated Margin Testnet (API) binance_com_isolated_margin_websocket(stream_data_json) STABLE
Binance Futures (API) binance_com_futures_websocket(stream_data_json) STABLE
Binance Futures Testnet (API) binance_com_futures_websocket(stream_data_json) STABLE
Binance Coin Futures (API) binance_com_coin_futures_websocket(stream_data_json) NEEDS_YOUR_HELP
Binance Coin Futures Testnet (API) binance_com_coin_futures_websocket(stream_data_json) NEEDS_YOUR_HELP
Binance Jersey (API) binance_je_websocket(stream_data_json) STABLE
Binance US (API) binance_us_websocket(stream_data_json) STABLE
Binance TR (API) trbinance_com_websocket(stream_data_json) STABLE
Binance JEX (API) jex_com_websocket(stream_data_json) STABLE
Binance DEX (API) binance_org_websocket(stream_data_json) NEEDS_YOUR_HELP
Binance DEX Testnet (API) binance_org_websocket(stream_data_json) NEEDS_YOUR_HELP

REST

  • none

If you like the project, please star it on GitHub!

Installation and Upgrade

The module requires Python 3.6.0 or above.

The current dependencies are listed here.

A wheel of the latest release with PIP from PyPI

pip install unicorn-fy --upgrade

From source of the latest release with PIP from Github

Linux, macOS, ...

Run in bash:

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

Windows

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

pip install https://github.com/oliver-zehentleitner/unicorn-fy/archive/0.7.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-fy/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

Source, Downloads, Examples, ...

https://github.com/oliver-zehentleitner/unicorn-fy

Change Log

https://oliver-zehentleitner.github.io/unicorn-fy/CHANGELOG.html

Wiki

https://github.com/oliver-zehentleitner/unicorn-fy/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.

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: https://github.com/oliver-zehentleitner/unicorn-fy/issues

Report a security bug!

Contributing

unicorn-fy 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

:heart: Sponsor (GitHub)

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_fy-0.11.0-py3-none-any.whl (18.9 kB view hashes)

Uploaded Python 3

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