Skip to main content

Add your description here

Project description

Crypto Orderbook MCP

An MCP server that analyzes order book depth and imbalance across major crypto exchanges, empowering AI agents and trading systems with real-time market structure insights.

License Python Status

Features

  • Order Book Metrics: Calculate bid/ask depth and imbalance for a specified trading pair on a given exchange.
  • Cross-Exchange Comparison: Compare order book depth and imbalance across multiple exchanges in a unified Markdown table.
  • Supported Exchanges: Binance, Kraken, Coinbase, Bitfinex, Okx, Bybit

Installation

Prerequisites

  • Python 3.10 or higher
  • uv (Python package and project manager)

Setup

  1. Clone the Repository

    git clone https://github.com/kukapay/crypto-orderbook-mcp.git
    cd crypto-orderbook-mcp
    
  2. Install Dependencies

    Use uv to install the required packages:

    uv sync
    
  3. Configure the MCP Client(Claude Desktop)

    "mcpServers": { 
      "crypto-orderbook-mcp": { 
        "command": "uv", 
        "args": [ "--directory", "/absolute/path/to/crypto-orderbook-mcp", "run", "main.py" ]
      } 
    }
    

Usage

The server provides two main tools:

  1. calculate_orderbook: Computes bid depth, ask depth, and imbalance for a trading pair on a specified exchange.
  2. compare_orderbook: Compares bid depth, ask depth, and imbalance across multiple exchanges, returning a Markdown table.

Example: Calculate Order Book Metrics

Prompt: "Calculate the order book metrics for BTC/USDT on Binance with a 1% depth range."

Expected Output (JSON object):

{
  "exchange": "binance",
  "symbol": "BTC/USDT",
  "bid_depth": 123.45,
  "ask_depth": 234.56,
  "imbalance": 0.1234,
  "mid_price": 50000.0,
  "timestamp": 1698765432000
}

Example: Compare Order Book Across Exchanges

Prompt: "Compare the order book metrics for BTC/USDT across Binance, Kraken, and OKX with a 1% depth range."

Expected Output (Markdown table):

| exchange | bid_depth | ask_depth | imbalance |
|----------|-----------|-----------|-----------|
| binance  |    123.45 |    234.56 |    0.1234 |
| kraken   |     89.12 |    178.34 |    0.0987 |
| okx      |    145.67 |    256.78 |    0.1345 |

License

This project is licensed under the MIT License. See the LICENSE file for details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

File details

Details for the file iflow_mcp_kukapay_crypto_orderbook_mcp-0.1.0.tar.gz.

File metadata

  • Download URL: iflow_mcp_kukapay_crypto_orderbook_mcp-0.1.0.tar.gz
  • Upload date:
  • Size: 5.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.28 {"installer":{"name":"uv","version":"0.9.28","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Debian GNU/Linux","version":"13","id":"trixie","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for iflow_mcp_kukapay_crypto_orderbook_mcp-0.1.0.tar.gz
Algorithm Hash digest
SHA256 de8e929ecb0e37cb9b57f396d9aa6591a2de1c8d36aab800b060f80c6ad8cf28
MD5 06d0caad89023d83fdcde921b7fd711a
BLAKE2b-256 a076a9817cdc67949005cb6f414cf429d4383be2c633e496f357c02024787382

See more details on using hashes here.

File details

Details for the file iflow_mcp_kukapay_crypto_orderbook_mcp-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: iflow_mcp_kukapay_crypto_orderbook_mcp-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 5.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.28 {"installer":{"name":"uv","version":"0.9.28","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Debian GNU/Linux","version":"13","id":"trixie","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for iflow_mcp_kukapay_crypto_orderbook_mcp-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 6d3f3dd1882b91e4472543e1fc4f9b171d67f3dd4dc5cc1d0d177ff6af53b5fa
MD5 0bc713d4d8e1e7e6a550b23c23ce80a8
BLAKE2b-256 380e025123acc719e4af8f0b6a7eb1b3921f802f8a1361b4e1f6aefc0e4a100c

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page