MCP Server
Run the Bitcompare API as tools inside Claude Desktop, Claude Code, Claude.ai, and any other Model Context Protocol-compatible agent. 21 read-only tools covering rates, coins, prices, market stats, stablecoin stability, symbol resolution, the Bitcompare Earn Index, and Earn Intelligence (rate changes and product terms) — using the same API key and request quotas as REST.
Free API keys can call get_rates, get_rate_by_symbol and list_providers. Other tools, including get_rate_history, need a paid plan (Starter at $49/mo or above). Sign up for a key.
Two ways to connect
| Transport | When to use | Endpoint |
|---|---|---|
| Hosted (Streamable HTTP) | Any client that supports HTTP MCP — fastest setup, nothing to install | https://api.bitcompare.net/mcp |
| Local (stdio) | Claude Desktop, Claude Code, or any client that spawns subprocesses | npx @bitcompare/mcp-server |
Both connect to the same backend. Free tools and the 21-tool catalog require the updated hosted endpoint or npm 1.2.0; the published npm 1.1.0 package has 18 tools and requires Pro or Enterprise.
Setup
Claude Desktop
Edit ~/Library/Application Support/Claude/claude_desktop_config.json on macOS (or the equivalent on Windows/Linux):
claude_desktop_config.json
{
"mcpServers": {
"bitcompare": {
"command": "npx",
"args": ["-y", "@bitcompare/mcp-server"],
"env": {
"BITCOMPARE_API_KEY": "ck_live_..."
}
}
}
}
Restart Claude Desktop, then ask: "What's the best yield on BTC right now?" Claude picks up the get_rates tool and answers from live data.
Claude Code
Add to .claude/settings.local.json in your project:
.claude/settings.local.json
{
"mcpServers": {
"bitcompare": {
"command": "npx",
"args": ["-y", "@bitcompare/mcp-server"],
"env": {
"BITCOMPARE_API_KEY": "ck_live_..."
}
}
}
}
Hosted (Streamable HTTP)
Point any HTTP-MCP client at the hosted endpoint:
mcp config
{
"mcpServers": {
"bitcompare": {
"url": "https://api.bitcompare.net/mcp",
"headers": {
"Authorization": "Bearer ck_live_..."
}
}
}
}
You can also call it directly:
cURL
curl -X POST https://api.bitcompare.net/mcp \
-H "Authorization: Bearer ck_live_..." \
-H "Content-Type: application/json" \
-d '{"jsonrpc":"2.0","id":1,"method":"tools/list","params":{}}'
Tool catalog
Each tool calls a REST endpoint using your API key and request quotas. MCP tool access is listed below.
Rates
- get_rates — Current rates across providers, filterable by symbol, category, provider. →
GET /api/v1/rates - get_rate_by_symbol — All provider rates for a single coin. →
GET /api/v1/rates/{symbol} - get_rate_history — Historical rate timeseries (Pro: up to 365 days; Enterprise: up to 1825 days, bounded by available data). →
GET /api/v1/rates/{symbol}/history - list_providers — All rate providers, optionally filtered by category. →
GET /api/v1/providers
Coins
- get_coin — Full metadata: description, links, categories, market data, developer stats. →
GET /api/v1/coins/{coinId} - list_coins — Paginated coin list with optional name/symbol search. →
GET /api/v1/coins - top_coins — Top N coins by market cap. →
GET /api/v1/coins/top - similar_coins — Coins similar to a given coin. →
GET /api/v1/coins/{coinId}/similar - coin_history — Historical price timeseries in the nearest 1, 7, 30, 90 or 365-day window (default 7); no rate-history per-plan day clamp. →
GET /api/v1/coins/{coinId}/history
Prices
- get_price — Aggregated prices for one or more symbols. →
GET /api/v1/prices/summary - get_price_by_symbol — Aggregated price and per-provider prices for one symbol. →
GET /api/v1/prices/{symbol}
Market
- market_summary — Total market cap, dominance, 24h volume. →
GET /api/v1/global-stats/summary - fear_greed_index — Crypto Fear & Greed Index. →
GET /api/v1/global-stats/fear-greed - top_movers — Biggest 24h gainers and losers. →
GET /api/v1/global-stats/movers
Stablecoins
- stablecoin_index — Stability leaderboard ranked by peg deviation. →
GET /api/v1/stablecoins/index - stablecoin_peg_stability — Historical peg deviation for a stablecoin. →
GET /api/v1/stablecoins/peg-stability
Symbols
- resolve_symbol — Map exchange-specific tickers (e.g.
BTC,XBT,wBTC) to canonical coin IDs. →GET /api/v1/symbols/resolve - resolve_symbols_batch — Resolve many exchange tickers in a single call. →
POST /api/v1/symbols/resolve/batch
Benchmarks and Earn Intelligence
- stablecoin_earn_benchmark — Stablecoin yield benchmark and daily history. →
GET /api/v1/benchmarks/stablecoinor/api/v1/benchmarks/stablecoin/history - get_rate_changes — Rate-change observations. →
GET /api/v1/rates/changes - list_earn_products — Earn products and term variants. →
GET /api/v1/earn/products
The full machine-readable catalog with input/output schemas and example inputs lives at api.bitcompare.net/mcp/tools.json. The marketing page at bitcompare.net/mcp renders the same catalog with a richer UI.
Authentication
The MCP server uses the same ck_live_* keys as the REST API. Free keys can call get_rates, get_rate_by_symbol and list_providers. Every paid plan (Starter, Growth, Pro and Enterprise) can call all of the tools; history depth still follows your plan.
- stdio transport — set
BITCOMPARE_API_KEYin theenvblock of your client config - HTTP transport — send
Authorization: Bearer ck_live_...
See Authentication for full details on key lifecycle, rotation, and revocation.
Rate limits
MCP requests count against your plan's per-key request budget. The plan determines burst capacity and monthly volume:
| Plan | Requests/min | Monthly cap |
|---|---|---|
| Free (three tools) | 30 | 10,000 |
| Starter (three tools) | 60 | 50,000 |
| Growth (three tools) | 120 | 200,000 |
| Pro | 300 | 1,000,000 |
| Enterprise | Custom | Custom |
REST quota exhaustion returns 429 upstream; MCP reports the failure as a tool result with isError: true. See Rate Limiting.
Errors
The hosted authentication and plan gates return HTTP errors before dispatch, wrapped in JSON-RPC error envelopes with the original error code in error.data.originalCode. Tool execution errors are returned as MCP results with isError: true and a text message:
401 unauthorized— missing or invalidck_live_*key403 PLAN_UPGRADE_REQUIRED— a Free, Starter or Growth key tried a paid MCP tool404 not_found— symbol, coin, or provider does not exist429 rate_limited— plan burst or monthly budget exhausted500 server_error— upstream issue; safe to retry with exponential backoff
See Errors for the full error catalog.
Discovery
The agent-readable manifest at the apex is updated automatically as tools change:
- bitcompare.net/llms.txt — apex manifest
- api.bitcompare.net/llms.txt — full tool descriptions
- api.bitcompare.net/mcp/tools.json — JSON-Schema-typed catalog
The npm package is published at @bitcompare/mcp-server and listed on Smithery.
What's next?
- Try a Quickstart request to confirm your key works against REST
- Explore the Rates and Coins endpoints — the most common MCP tool targets
- Build a custom client against the same endpoint using the @modelcontextprotocol/sdk