Skip to main content

Cryptoexchange asynchronous python client

Project description

cryptolib-aio 2.0.0

cryptolib-aio is a compact Python library providing access to REST and WEBSOCKET API of selected crypto exchanges.

cryptolib-aio is designed as an asynchronous library utilizing modern features of Python and those of supporting asynchronous libraries (mainly async websockets and aiohttp).

Main mission

Today there are numerous existing libraries targeting similar audience as cryptolib-aio. In order to achieve the broadest coverage of exchanges the supported API is often limited, the most apparent example being lack of websockets.

The mission of cryptolib-aio is to:

  • serve as a single entry point for various crypto exchanges
  • provide full REST API as well as full implementation of exchange's websockets. For free and without subscription plans.

Full support of websockets is the corner stone of cryptolib-aio which attempts to set cryptolib-aio apart from existing solutions which either do not provide websocket support or do not provide it for free.

You will also find out that our subject of interest are often smaller exchanges (by world standards) not enjoying a seat in the mainstream crypto libraries.

Disclaimer: By no means we are suggesting that existing libraries are inferior to cryptolib-aio, they just appeal to different endusers.

Features

  • access to REST API as well as full support of websockets for selected exchanges (given websockets are provided by the exchange)
  • automatic connection management (reconnecting after remote termination, ...)
  • bundling of channels
  • lean architecture making it straightforward to implement API of a new exchange
  • fully asynchronous design aiming for the best performance

For the history of changes see CHANGELOG.

List of supported exchanges

As mentioned earlier, all exchanges listed below include full support for websockets.

Name Docs
bibox API
bibox_europe API
binance API
bitforex API
bitpanda API
bitvavo API
liquid API

Unlike REST API which is rather uniform across crypto exchanges websockets are often very exchange-specific and hence very time consuming to implement (which is the reason why they are not offered so broadly). Therefore cryptolib-aio comes at the cost of the number of exchanges it covers. This is in line with our ideology quality over quantity.

The list of supported exchanges will grow without any specific pattern, usually driven by personal needs. If there is a high demand for a new exchange/feature to be added, there is a high chance for it to happen (but not guranteed). For business related inquiries concerning customized changes tailored for the client please reach out via e-mail mentioned in the contacts.

Installation

pip install cryptolib-aio

Examples

BITPANDA
bitpanda = CryptoLib.create_bitpanda_client(api_key)

print("Account balance:")
await bitpanda.get_account_balances()

print("Order book:")
await bitpanda.get_order_book(Pair("BTC", "EUR"))

print("Create limit order:")
await bitpanda.create_limit_order(Pair("BTC", "EUR"), OrderSide.BUY, "10000", "1")

# Create first bundle of subscriptions
bitpanda.compose_subscriptions([
    AccountSubscription(),
    PricesSubscription([Pair("BTC", "EUR")]),
    OrderbookSubscription([Pair("BTC", "EUR")], "50", callbacks = [order_book_update]),
    CandlesticksSubscription([CandlesticksSubscriptionParams(Pair("BTC", "EUR"), TimeUnit.MINUTES, 1)]),
    MarketTickerSubscription([Pair("BTC", "EUR")])
])

# Bundle another subscriptions into a separate websocket
bitpanda.compose_subscriptions([
    OrderbookSubscription([Pair("ETH", "EUR")], "3", callbacks = [order_book_update]),
])

# Execute all websockets asynchronously
await bitpanda.start_websockets()
BITFOREX
bitforex = CryptoLib.create_bitforex_client(api_key, sec_key)

print("Order book:")
await bitforex.get_order_book(pair = Pair('ETH', 'BTC'), depth = "1")

print("Create order:")
await bitforex.create_order(Pair("ETH", "BTC"), side = enums.OrderSide.SELL, quantity = "1", price = "1")

# First bundle of subscriptions
bitforex.compose_subscriptions([
    OrderBookSubscription(pair = Pair('ETH', 'BTC'), depth = "0", callbacks = [order_book_update]),
    TradeSubscription(pair = Pair('ETH', 'BTC'), size = "2", callbacks = [trade_update]),
])

# Another bundle of subscriptions
bitforex.compose_subscriptions([
    TickerSubscription(pair = Pair('BTC', 'USDT'), size = "2", interval = enums.CandelstickInterval.I_1MIN, callbacks = [ticker_update]),
    Ticker24hSubscription(pair = Pair('BTC', 'USDT'), callbacks = [ticker24_update])
])

# Execute all websockets asynchronously
await bitforex.start_websockets()

Examples for every exchange can be found in the folder examples.

Contact

  • to report issues, bugs, docu corrections or to propose new features use preferably Github Issues
  • for topics requiring more personal approach feel free to send an e-mail to

Support

If you like the library and you feel like you want to support its further development, enhancements and bugfixing, then it will be of great help and most appreciated if you:

  • file bugs, proposals, pull requests, ...
  • spread the word
  • donate an arbitrary tip
    • BTC: 15JUgVq3YFoPedEj5wgQgvkZRx5HQoKJC4
    • ETH: 0xf29304b6af5831030ba99aceb290a3a2129b993d
    • ADA: DdzFFzCqrhshyLV3wktXFvConETEr9mCfrMo9V3dYz4pz6yNq9PjJusfnn4kzWKQR91pWecEbKoHodPaJzgBHdV2AKeDSfR4sckrEk79
    • XRP: rhVWrjB9EGDeK4zuJ1x2KXSjjSpsDQSaU6 + tag 599790141

Project details


Download files

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

Files for cryptolib-aio, version 2.0.0
Filename, size File type Python version Upload date Hashes
Filename, size cryptolib_aio-2.0.0-py3-none-any.whl (41.7 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size cryptolib-aio-2.0.0.tar.gz (23.9 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page