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 Status Total alerts Language grade: Python Coverage Status 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.

UnicornFy is a side project of UNICORN Binance WebSocket API but can be used with every API that delivers the receives in raw format (as received without changes).

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 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).

Donate

Since you are probably a developer yourself, you will understand very well that the creation of open source software is not free - it requires technical knowledge, a lot of time and also financial expenditure.

If you would like to help me to dedicate my time and energy to this project, even small donations are very welcome.

Donate using Liberapay

BTC: 39fS74fvcGnmEk8JUV8bG6P1wkdH29GtsA
LUNA: terra1ncjg4a59x2pgvqy9qjyqprlj8lrwshm0wleht5 (Memo: 108157985)
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.9.0-py3-none-any.whl (11.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