# 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
# Start all services (all crypto-exchange producers, consumer and web services)
$ docker compose -f local.yml up --build -d
# Start crypto-exchange OKX producer, consumer and web services
$ docker compose -f local.yml up --build consumer producer-okx
#### Production
# Start all services
$ 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
### OAS 3
OpenAPI Specification: http://127.0.0.1:9000/api/schema.yaml
### 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).
### UI
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
Raw data
{
"_id": null,
"home_page": "https://exchangeradar.tech",
"name": "exchange-radar",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.12",
"maintainer_email": null,
"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",
"download_url": "https://files.pythonhosted.org/packages/eb/fa/cc4e585c4b129052f757f66240b73d3cf92a8c03fb95613136ae4a7b8f5c/exchange_radar-1.6.0.tar.gz",
"platform": null,
"description": "# exchange-radar: Real-time Crypto Exchange Trades Monitor\n\n[![Version][version-svg]][package-url]\n[![License][license-image]][license-url]\n[![Build Status][ci-svg]][ci-url]\n\nWelcome to Exchange Radar, your gateway to real-time trade data from major cryptocurrency exchanges.\n\n### Supported Exchanges\nExchange Radar currently supports the following top exchanges by reputation and trading volume:\n- Binance\n- Coinbase\n- Kraken\n- KuCoin\n- OKX\n- Bybit\n- Bitstamp\n- MEXC\n- HTX\n\n### Build & Run\nGet started effortlessly:\n\n#### Locally\n\n # Start all services (all crypto-exchange producers, consumer and web services)\n $ docker compose -f local.yml up --build -d\n\n # Start crypto-exchange OKX producer, consumer and web services\n $ docker compose -f local.yml up --build consumer producer-okx\n\n#### Production\n\n # Start all services\n $ docker compose -f production.yml up --build -d\n\n # Scale the consumer service horizontally with 2 instances\n $ docker compose -f production.yml up --build --scale consumer=2\n\n### OAS 3\nOpenAPI Specification: http://127.0.0.1:9000/api/schema.yaml\n\n### Run Test Cases & Code Coverage\n\n#### Tests\n\n $ make tests\n\n#### Code Coverage\n\n $ make coverage\n\n### Run Benchmarks\n\n $ make benchmark\n\nExample of the benchmark output can be seen [here](benchmarks/results.out).\n\n### UI\nExplore real-time trade information effortlessly:\n- Visit http://127.0.0.1:9000/BTC to access real-time BTC trades.\n- To track BTC whales' transactions, navigate to http://127.0.0.1:9000/BTC/whales.\n- For BTC dolphins' transactions, use http://127.0.0.1:9000/BTC/dolphins.\n- To monitor BTC octopuses' transactions, head to http://127.0.0.1:9000/BTC/octopuses.\n\nFeel free to replace BTC with any other supported coin across the exchanges.\n\n### Hardware Requirements\nExchange Radar operates efficiently without requiring extensive resources. In fact, all services run seamlessly on a single Raspberry Pi 4.\n\n<!-- Links -->\n\n<!-- badges -->\n[version-svg]: https://img.shields.io/pypi/v/exchange-radar?style=flat-square\n[package-url]: https://pypi.org/project/exchange-radar/\n[ci-svg]: https://github.com/pantunes/exchange-radar/actions/workflows/ci-cd.yml/badge.svg\n[ci-url]: https://github.com/pantunes/exchange-radar/actions/workflows/ci-cd.yml\n[license-image]: https://shields.io/badge/license-GNU%20General%20Public%20License%20v3.0-green\n[license-url]: LICENSE\n",
"bugtrack_url": null,
"license": "GNU GPLv3",
"summary": "Live trading information from various cryptocurrency exchanges.",
"version": "1.6.0",
"project_urls": {
"Homepage": "https://exchangeradar.tech",
"Repository": "https://github.com/pantunes/exchange-radar"
},
"split_keywords": [
"cryptocurrency",
" bitcoin",
" btc",
" ethereum",
" eth",
" chainlink",
" link",
" trading",
" crypto exchanges",
" exchange",
" crypto",
" binance",
" coinbase",
" kraken",
" kucoin",
" okx",
" bybit",
" bitstamp",
" mexc",
" htx"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9bce73248a616db834273fa03f7974ac55a2962dcaa2932bd6581c20297916a2",
"md5": "21f1af8f1a0e91499d0116baf8979014",
"sha256": "46dee3735e76751c5114043fd4708f22e8743702d0fb4050d5f515db94c25bf4"
},
"downloads": -1,
"filename": "exchange_radar-1.6.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "21f1af8f1a0e91499d0116baf8979014",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.12",
"size": 88041,
"upload_time": "2024-10-28T20:45:52",
"upload_time_iso_8601": "2024-10-28T20:45:52.181071Z",
"url": "https://files.pythonhosted.org/packages/9b/ce/73248a616db834273fa03f7974ac55a2962dcaa2932bd6581c20297916a2/exchange_radar-1.6.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ebfacc4e585c4b129052f757f66240b73d3cf92a8c03fb95613136ae4a7b8f5c",
"md5": "483955a33814edeb29abd818ea947471",
"sha256": "e22a30ca80f680c533bf9fdf1f534047f3a5cac8503cf5349061ab657d7fff84"
},
"downloads": -1,
"filename": "exchange_radar-1.6.0.tar.gz",
"has_sig": false,
"md5_digest": "483955a33814edeb29abd818ea947471",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.12",
"size": 58796,
"upload_time": "2024-10-28T20:45:54",
"upload_time_iso_8601": "2024-10-28T20:45:54.136302Z",
"url": "https://files.pythonhosted.org/packages/eb/fa/cc4e585c4b129052f757f66240b73d3cf92a8c03fb95613136ae4a7b8f5c/exchange_radar-1.6.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-28 20:45:54",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "pantunes",
"github_project": "exchange-radar",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "exchange-radar"
}
JSON
