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

iflow_mcp_crypto_orderbook_mcp-0.1.0.tar.gz (5.4 kB view details)

Uploaded Source

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_crypto_orderbook_mcp-0.1.0.tar.gz.

File metadata

File hashes

Hashes for iflow_mcp_crypto_orderbook_mcp-0.1.0.tar.gz
Algorithm Hash digest
SHA256 0bf1bc2f7553da9818555ad58e246d3f53befb186fb482ae475660ab83924c67
MD5 e18040e578e437e8a305d407a612384a
BLAKE2b-256 cd6e3064fc0e0ede5afb8bc1d3dda9b2e46c36002917b3b9e745488a27999b91

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for iflow_mcp_crypto_orderbook_mcp-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c81fe3ee6b25c718d8bf527e8418cca7c9127208eda0f54577351541993c55fd
MD5 9e318b9b838c3bd30b75e78e4a314436
BLAKE2b-256 a727c1d321375704e88e34514ce2806ef8f3fe4872f3d08a7edfd6e0838e0cfe

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