Skip to main content

Cryptocurrency Exchange Feed Handler

License Python Build Status PyPi Codacy Badge

Handles multiple cryptocurrency exchange data feeds and returns normalized and standardized results to client registered callbacks for events like trades, book updates, ticker updates, etc. Utilizes websockets when possible, but can also poll data via REST endpoints if a websocket is not provided.

Please see the examples for more code samples, the documentation or the FAQ for some oddities and gotchas.

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), L2_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(pairs=['BTC-USDT'], channels=[TRADES], callbacks=trade_cb))
fh.add_feed(Gemini(pairs=['BTC-USD', 'ETH-USD'], channels=[TRADES, L2_BOOK], callbacks=gemini_cb)

fh.run()

To see an example of an application using cryptofeed to aggregate and store cryptocurrency data to a database, please look at Cryptostore.

Supports the following exchanges:

  • Binance

  • Binance US

  • Binance Jersey

  • Binance Futures

  • Bitcoin.com

  • Bitfinex

  • BitMax

  • BitMEX

  • Bitstamp

  • Bittrex

  • Bybit

  • Coinbase

  • Deribit

  • EXX

  • FTX

  • Gemini

  • HitBTC

  • Huobi

  • HuobiDM

  • Kraken

  • Kraken Futures

  • OKCoin

  • OKEx

  • Poloniex

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.exchanges 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 - Note this reports the taker’s side, even for exchanges that report the maker side

  • 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 receive both create two feedhandler objects. Not all exchanges are supported, as some exchanges send complete books on every update.

  • *_SWAP (L2/L3 Books, Trades, Ticker) - Swap data on supporting exchanges

  • *_FUTURES (L2/L3 Books, Trades, Ticker) - Futures data on supporting exchanges

  • OPEN_INTEREST - Open interest data

Backends

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

Supported Backends:

  • Redis (Streams and Sorted Sets)

  • Arctic

  • ZeroMQ

  • UDP Sockets

  • TCP Sockets

  • Unix Domain Sockets

  • InfluxDB

  • MongoDB

  • Kafka

  • Elastic Search

  • RabbitMQ

  • Postgres

Rest API

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

Planned Work

Future Feeds

  • CEX

  • BTCC

  • Many more…

REST

Continue to build out rest endpoints and standardize exchange interfaces and data

Additional Callback Methods / Backends

  • Pulsar

  • More ZMQ improvements/options

Contributing

Issues and PRs are welcomed. If you’d like to discuss ongoing development please join the slack

Metadata

Release files for cryptofeed 1.3.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Built distribution (wheel)

Table of built distributions (wheels) for cryptofeed 1.3.0
File Interpreter ABI Platform Actions
cryptofeed-1.3.0-py3-none-any.whl Python 3 none any Details for cryptofeed-1.3.0-py3-none-any.whl

Release files / cryptofeed-1.3.0-py3-none-any.whl

Download URL cryptofeed-1.3.0-py3-none-any.whl
Size 108.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
949a9db84328ccbbc1224d35f054f90631d9164447c35e2bb632728b86a5584b
BLAKE2b-256 checksum
How to use checksums
55b98d2bffedf539a14496ea9c21752c97a624e8da9f030bdb0bb520781d6b0b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/44.0.0.post20200106 requests-toolbelt/0.9.1 tqdm/4.41.1 CPython/3.7.6

Security for cryptofeed 1.3.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

1.3.0 This release

1 release file No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page