bitkub-mcp-server
v0.2.0
Published
π¨ UNOFFICIAL MCP server for Bitkub cryptocurrency exchange public API - NOT affiliated with Bitkub - Use at your own risk
Maintainers
Readme
π Bitkub MCP Server
Get live cryptocurrency data from Bitkub exchange directly in Claude - zero setup required!
A Model Context Protocol (MCP) server that provides access to Bitkub cryptocurrency exchange public market data. No API keys needed, just real-time crypto data in your AI conversations.
β οΈ Important Disclaimer
π¨ THIS IS NOT AN OFFICIAL BITKUB PRODUCT π¨
This is an unofficial, community-built tool that uses Bitkub's public API endpoints. It is NOT affiliated with, endorsed by, or supported by Bitkub in any way.
β οΈ IMPORTANT WARNINGS:
- Do Your Own Research (DYOR) - Never make trading decisions based solely on this data
- Not Financial Advice - This tool provides market data only, not investment recommendations
- Use at Your Own Risk - The creators are not responsible for any trading losses
- Verify All Data - Always cross-check with official Bitkub sources before trading
- API Limitations - This tool may break if Bitkub changes their public API
β Official Bitkub Resources:
- Website: bitkub.com
- Official API: github.com/bitkub/bitkub-official-api-docs
- Support: support.bitkub.com
π― Super Easy Setup (30 seconds)
Option 1: Zero Downloads (Recommended)
{
"mcpServers": {
"bitkub": {
"command": "npx",
"args": ["bitkub-mcp-server@latest"]
}
}
}Option 2: One-Line Install
curl -fsSL https://raw.githubusercontent.com/xbklairith/bitkub-mcp/main/scripts/install.sh | bashWhere to Add Config
- macOS:
~/Library/Application Support/Claude/claude_desktop_config.json - Windows:
%APPDATA%\Claude\claude_desktop_config.json - Linux:
~/.config/Claude/claude_desktop_config.json
π Interactive Config Generator - Visual guide with copy-paste
Paste config β Restart Claude β Ask: "What's the Bitcoin price?" β Done! π
π οΈ Available Tools
| Tool | Description |
|------|-------------|
| π bitkub_ticker | Current prices for any trading pair |
| π bitkub_market_symbols | All 149+ available trading pairs |
| πͺ bitkub_coins | Cryptocurrency info with deposit/withdraw status |
| π bitkub_orderbook | Buy/sell order book depth |
| π± bitkub_trades | Recent trade history |
| π bitkub_servertime | Server timestamp |
| β‘ bitkub_batch_ticker | Multiple symbols with analysis |
| π bitkub_spread_analysis | Bid-ask spread analysis |
| π€ bitkub_export | Export data (CSV, JSON, table) |
π¬ Example Questions for Claude
Basic Queries:
- "What's the current Bitcoin price on Bitkub?"
- "Show me all available trading pairs"
- "Which coins can I deposit or withdraw?"
- "Get the order book for Ethereum"
Market Analysis:
- "Which cryptocurrencies have the highest volume?"
- "Show me the bid-ask spreads for major coins"
- "Which trading pairs have the tightest spreads?"
Advanced Analytics:
- "Compare BTC, ETH, and ADA performance"
- "Export the top 10 cryptocurrencies to a table"
- "Show me low-volume trading pairs"
β¨ Features
- β No API Keys - Uses public Bitkub endpoints
- β Real-time Data - Live market prices and updates
- β Smart Caching - Efficient with built-in rate limiting
- β Rich Analysis - Advanced market analytics
- β Multiple Formats - CSV, JSON, table exports
- β Zero Setup - Works instantly with npx
π§ For Developers
Quick Development Setup
git clone https://github.com/xbklairith/bitkub-mcp.git
cd bitkub-mcp
npm install && npm run build
npm run setup:claude # Auto-configure ClaudeDevelopment Commands
npm run dev # Development mode
npm test # Run tests
npm run lint # Lint and format
npm run typecheck # Type checkingDirect API Usage
# List tools
echo '{"jsonrpc": "2.0", "id": 1, "method": "tools/list"}' | node dist/index.js
# Get BTC price
echo '{"jsonrpc": "2.0", "id": 2, "method": "tools/call", "params": {"name": "bitkub_ticker", "arguments": {"symbol": "THB_BTC"}}}' | node dist/index.jsProject Structure
src/
βββ index.ts # MCP server entry point
βββ bitkub/client.ts # Bitkub API client
βββ tools/market/ # Market data tools
βββ utils/ # Cache & rate limiting
βββ types/ # TypeScript definitionsπ Examples
Run these after building:
node examples/basic-usage.js # Core functionality demo
node examples/market-monitor.js # Real-time BTC monitoring
node examples/advanced-analysis.js # Market analysis demoπ Troubleshooting
Claude doesn't respond to crypto questions?
- Restart Claude Desktop completely
- Check config file path for your OS
- Ensure config JSON is valid
Build/setup issues?
- Install Node.js 18+ from nodejs.org
- Try:
rm -rf node_modules && npm install
Config file doesn't exist?
- Create the file manually at the path shown above
- Use the interactive config generator
ποΈ Architecture
- TypeScript with strict mode
- MCP SDK for protocol compliance
- Axios for HTTP with smart caching
- Token bucket rate limiting
- Biome for linting/formatting
- Vitest for testing (18 tests, full coverage)
π License
MIT
π€ Contributing
- Fork the repository
- Create feature branch
- Run
npm test && npm run lint - Submit pull request
Ready to explore crypto data with Claude! π
Need help? Check the config generator or open an issue.
