Metadata-Version: 2.1
Name: exchange-radar
Version: 1.2.0
Summary: Live trading information from various cryptocurrency exchanges.
Home-page: https://exchangeradar.tech
License: GNU GPLv3
Keywords: cryptocurrency,bitcoin,btc,ethereum,eth,chainlink,link,trading,crypto exchanges,exchange,crypto,binance,coinbase,kraken,kucoin,okx,bybit,bitstamp,mexc,htx
Author: Paulo Antunes
Author-email: pjmlantunes@gmail.com
Requires-Python: >=3.11,<4.0
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Financial and Insurance Industry
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: License :: Other/Proprietary License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Dist: click (>=8.1.5,<9.0.0)
Requires-Dist: copra (>=1.2.9,<2.0.0)
Requires-Dist: environs (>=9.5.0,<10.0.0)
Requires-Dist: jinja2 (>=3.1.2,<4.0.0)
Requires-Dist: pika (>=1.3.2,<2.0.0)
Requires-Dist: pybit (>=5.6.2,<6.0.0)
Requires-Dist: pydantic (>=2.0,<3.0)
Requires-Dist: pymexc (>=1.0.10,<2.0.0)
Requires-Dist: python-binance (>=1.0.17,<2.0.0)
Requires-Dist: python-kucoin (>=2.1.3,<3.0.0)
Requires-Dist: python-okx (>=0.2.6,<0.3.0)
Requires-Dist: redis-om (>=0.2.1,<0.3.0)
Requires-Dist: requests (>=2.31.0,<3.0.0)
Requires-Dist: starlette (>=0.30.0,<0.31.0)
Requires-Dist: types-requests (==2.31.0.0)
Requires-Dist: urllib3 (>=1.26.16,<2.0.0)
Requires-Dist: uvicorn[standard] (>=0.22.0,<0.23.0)
Project-URL: Repository, https://github.com/pantunes/exchange-radar
Description-Content-Type: text/markdown

# exchange-radar: Real-time Crypto Exchange Trades Monitor

[![Version][version-svg]][package-url]
[![License][license-image]][license-url]
[![Build Status][ci-svg]][ci-url]

Welcome to Exchange Radar, your gateway to real-time trade data from major cryptocurrency exchanges.

### Supported Exchanges
Exchange Radar currently supports the following top exchanges by reputation and trading volume:
- Binance
- Coinbase
- Kraken
- KuCoin
- OKX
- Bybit
- Bitstamp
- MEXC
- HTX

### Build & Run
Get started effortlessly:

#### Locally

    $ docker-compose -f local.yml up --build -d

#### Production

    $ docker-compose -f production.yml up --build -d

Scale the consumer service horizontally with 2 instances:

    $ docker-compose -f production.yml up --build --scale consumer=2

### Run Test Cases & Code Coverage

#### Tests

    $ make tests

#### Code Coverage

    $ make coverage

### Run Benchmarks

    $ make benchmark

Example of the benchmark output can be seen [here](benchmarks/results.out).

### Accessing data
Explore real-time trade information effortlessly:
- Visit http://127.0.0.1:9000/BTC to access real-time BTC trades.
- To track BTC whales' transactions, navigate to http://127.0.0.1:9000/BTC/whales.
- For BTC dolphins' transactions, use http://127.0.0.1:9000/BTC/dolphins.
- To monitor BTC octopuses' transactions, head to http://127.0.0.1:9000/BTC/octopuses.

Feel free to replace BTC with any other supported coin across the exchanges.

### Hardware Requirements
Exchange Radar operates efficiently without requiring extensive resources. In fact, all services run seamlessly on a single Raspberry Pi 4.

<!-- Links -->

<!-- badges -->
[version-svg]: https://img.shields.io/pypi/v/exchange-radar?style=flat-square
[package-url]: https://pypi.org/project/exchange-radar/
[ci-svg]: https://github.com/pantunes/exchange-radar/actions/workflows/ci-cd.yml/badge.svg
[ci-url]: https://github.com/pantunes/exchange-radar/actions/workflows/ci-cd.yml
[license-image]: https://shields.io/badge/license-GNU%20General%20Public%20License%20v3.0-green
[license-url]: LICENSE

