Cryptocurrency Exchange Feed Handler with synthetic NBBO
Clone or download
Permalink
Failed to load latest commit information.
cryptofeed fix tests Nov 11, 2018
examples binance support Nov 3, 2018
tests fix tests Nov 11, 2018
tools Change GDAX to coinbase, update endpoints Oct 7, 2018
.gitignore Gdax api (#35) Sep 24, 2018
.travis.yml Update .travis.yml Sep 24, 2018
CHANGES.md Update CHANGES.md Nov 11, 2018
LICENSE Trim whitespace Oct 7, 2018
README.md Update README.md Nov 3, 2018
setup.py Update setup.py Nov 3, 2018

README.md

Cryptocurrency Exchange Feed Handler

License Python Build Status Codacy Badge PyPi

Handles multiple feeds and returns normalized and standardized results across exchanges to client registered callbacks for events like trades, book updates, ticker updates, etc.

Please see the examples for more code samples.

from cryptofeed import FeedHandler

fh = FeedHandler()

# ticker, trade, and book are user defined functions that
# will be called when ticker, trade and book updates are received
ticker_cb = {TICKER: TickerCallback(ticker)}
trade_cb = {TRADES: TradeCallback(trade)}
gemini_cb = {TRADES: TradeCallback(trade), L3_BOOK: BookCallback(book)}


fh.add_feed(Coinbase(pairs=['BTC-USD'], channels=[TICKER], callbacks=ticker_cb)
fh.add_feed(Bitfinex(pairs=['BTC-USD'], channels=[TICKER], callbacks=ticker_cb)
fh.add_feed(Poloniex(channels=['USDT-BTC'], callbacks=trade_cb))
fh.add_feed(Gemini(pairs=['BTC-USD'], callbacks=gemini_cb)

fh.run()

Supports the following exchanges:

  • Bitfinex
  • Coinbase
  • Poloniex
  • Gemini
  • HitBTC
  • Bitstamp
  • BitMEX
  • Kraken
  • Binance

Also provides a synthetic NBBO (National Best Bid/Offer) feed that aggregates the best bids and asks from the user specified feeds.

from cryptofeed.feedhandler import FeedHandler
from cryptofeed import Coinbase, Bitfinex, HitBTC


def nbbo_ticker(pair, bid, ask, bid_feed, ask_feed):
    print('Pair: {} Bid: {} Bid Feed: {} Ask: {} Ask Feed: {}'.format(pair,
                                                                      bid,
                                                                      bid_feed,
                                                                      ask,
                                                                      ask_feed))


fh = FeedHandler()
fh.add_nbbo([Coinbase, Bitfinex, HitBTC], ['BTC-USD'], nbbo_ticker)
fh.run()

Supported Channels

Cryptofeed supports the following channels:

  • L2_BOOK - Price aggregated sizes. Some exchanges provide the entire depth, some provide a subset.
  • L3_BOOK - Price aggregated orders. Like the L2 book, some exchanges may only provide partial depth.
  • TRADES
  • TICKER
  • VOLUME
  • FUNDING
  • BOOK_DELTA - Subscribed to with L2 or L3 books, receive book deltas rather than the entire book on updates. Full updates will be periodically sent on the L2 or L3 channel. If BOOK_DELTA is enabled, only L2 or L3 book can be enabled, not both. To received both create two feedhandler objects.

Backends

Cryptofeeds supports backend callbacks that will write directly to storage or other interfaces

Supported Backends:

  • Redis
  • Arctic
  • ZeroMQ
  • UDP Sockets

Rest API

Cryptofeed supports some REST interfaces for retrieving historical data and placing orders. See the rest package.

Planned Work

Future Feeds

  • EXX
  • CEX
  • BTCC
  • Many more...

REST

Continue to build out rest endpoints

Additional Callback Methods / Backends

  • Unix Domain Sockets
  • Postgres
  • InfluxDB