exchange-radar


Nameexchange-radar JSON
Version 1.5.0 PyPI version JSON
download
home_pagehttps://exchangeradar.tech
SummaryLive trading information from various cryptocurrency exchanges.
upload_time2024-03-24 09:29:15
maintainerNone
docs_urlNone
authorPaulo Antunes
requires_python<4.0,>=3.11
licenseGNU GPLv3
keywords cryptocurrency bitcoin btc ethereum eth chainlink link trading crypto exchanges exchange crypto binance coinbase kraken kucoin okx bybit bitstamp mexc htx
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # 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).

### 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.11",
    "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/b9/bd/fdfa0a711410252a8b58dd56b485144da5b27464ad3b5f2f106aae4ba433/exchange_radar-1.5.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    $ docker-compose -f local.yml up --build -d\n\n#### Production\n\n    $ docker-compose -f production.yml up --build -d\n\nScale the consumer service horizontally with 2 instances:\n\n    $ docker-compose -f production.yml up --build --scale consumer=2\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.5.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": "4375e0030f55ac8702241a26bd8e097828f7e368c333b635506659e6943845ff",
                "md5": "0d47f5c8585384abd3d01d09c6efba51",
                "sha256": "cfa3b6afcfa147959c48b337f39a9a87b5c041a1e599a256a6c853f324c6923d"
            },
            "downloads": -1,
            "filename": "exchange_radar-1.5.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "0d47f5c8585384abd3d01d09c6efba51",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.11",
            "size": 80829,
            "upload_time": "2024-03-24T09:29:14",
            "upload_time_iso_8601": "2024-03-24T09:29:14.023926Z",
            "url": "https://files.pythonhosted.org/packages/43/75/e0030f55ac8702241a26bd8e097828f7e368c333b635506659e6943845ff/exchange_radar-1.5.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "b9bdfdfa0a711410252a8b58dd56b485144da5b27464ad3b5f2f106aae4ba433",
                "md5": "202de559751b7353685f2c1bddfecada",
                "sha256": "3cdb5baddb9538404829654811922ec34b5318e0a0c93643f33370bef1a433bf"
            },
            "downloads": -1,
            "filename": "exchange_radar-1.5.0.tar.gz",
            "has_sig": false,
            "md5_digest": "202de559751b7353685f2c1bddfecada",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0,>=3.11",
            "size": 54510,
            "upload_time": "2024-03-24T09:29:15",
            "upload_time_iso_8601": "2024-03-24T09:29:15.417355Z",
            "url": "https://files.pythonhosted.org/packages/b9/bd/fdfa0a711410252a8b58dd56b485144da5b27464ad3b5f2f106aae4ba433/exchange_radar-1.5.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-03-24 09:29:15",
    "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"
}
        
Elapsed time: 0.22854s