/easycoins

Primary LanguageJavaScriptApache License 2.0Apache-2.0

EasyCoins

A python sdk wrapper for various bitcoin trading platforms.

The wrappers in EasyCoins usually have high availability. For example, websocket auto-reconnection is implemented,

Usage & API references

For detailed usage reference, I suggest you go to the README.md under each sub-directory.

For example, you can find API references for OKCoin (which is a BitCoin Trading Platform in mainland China) in EasyCoins/OKCoin/README.md

Prerequisites:

The package is developed and tested on Python 3.5 & Ubuntu 16.04, tested on Win10.

The following prerequisites is required

  • Python 3.4+
  • pip install websocket-client
  • pip install requests

Quick Start

Note: Simply running the following code will establish a Web Socket connection to the OKCoin server. It subscribes the BitCoin ticker as soon as the connection is open. However, you probably need to set logging to see screen outputs.

from easycoins import OKCoin

okcoin = OKCoin()
okcoin.okcoin_ws.start()
okcoin.okcoin_ws.subscribe_ticker("btc")

If you are familiar with logging, you can write your own logging handlers. Otherwise, try the following full example:


"""
We set the logging level to be DEBUG, so that we can see what's going on inside.
In production environment, you can set the logging level to INFO, or even WARNING
"""python
import logging
# Set Screen Output handler
formatter = logging.Formatter(
    '[%(levelname)s] %(asctime)s - %(name)s - %(lineno)d - %(message)s'
)

logger = logging.getLogger("OKCoinWS")
logger.setLevel(logging.DEBUG)
handler = logging.StreamHandler()
handler.setFormatter(formatter)
logger.addHandler(handler)

from EasyCoins import OKCoin

okcoin = OKCoin()
okcoin.okcoin_ws.start()
okcoin.okcoin_ws.subscribe_ticker("btc")

# The main thread needs to be "joined". Otherwise, the WebSocket will be closed as the main thread exits.
import time
while okcoin.okcoin_ws._auto_reconnect or okcoin.okcoin_ws.is_open:
    time.sleep(60)

Introduction for trading platforms

TODOs

  • OKCoin API: Under Work
  • Huobi API
  • Bitmex

Donation

No. The author is so rich that he doesn't want any donation in any form ~