Skip to content

Bortlesboat/bitcoin-api

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

130 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Satoshi API

Satoshi API

Stop overpaying Bitcoin fees. Know when to send.

CI PyPI Downloads Python 3.10+ License Live API

Live Playground · Landing Page · PyPI · MCP Server · Discord Bot


Bad fee timing burns sats on every Bitcoin transaction. Satoshi API tells you when to send, what to pay, and whether to wait — combining multiple estimatesmartfee targets with real-time mempool state. Instead of just "4 sat/vB", you get "Fees are low. Good time to send." One pip install, self-hostable, open source.

Install & Run

pip install satoshi-api
export BITCOIN_RPC_USER=your_user BITCOIN_RPC_PASSWORD=your_password
satoshi-api
# API:  http://localhost:9332
# Docs: http://localhost:9332/docs

Example

curl http://localhost:9332/api/v1/fees/recommended | jq
{
  "data": {
    "recommendation": "Fees are low. Good time to send.",
    "estimates": { "high": 4, "medium": 2, "low": 1 }
  },
  "meta": { "timestamp": "...", "node_height": 939462, "chain": "main" }
}

Core Endpoints

Category Endpoints Highlights
Blocks 8 Latest block, by height/hash, stats, txids, header
Transactions 7 Decoded analysis, status, outspends, UTXO lookup, broadcast
Fees 7 Recommendations, landscape ("send now or wait?"), history, mempool-blocks
Mempool 5 Congestion score, fee buckets, recent entries
Mining 2 Hashrate, difficulty, next block template
Network 4 Peers, forks, difficulty, address validation
Streams 2 Real-time blocks & fees via SSE

...and more (prices, address lookups, exchange comparison). Full interactive docs at /docs.

For AI Agents

bitcoin-mcp — the first Bitcoin MCP server on the official Anthropic MCP Registry — lets AI agents check fees, verify payments, and monitor addresses without human babysitting. Saves developer time: no custom Bitcoin plumbing needed.

# Install and point at your Satoshi API instance
pip install bitcoin-mcp
SATOSHI_API_URL=https://bitcoinsapi.com bitcoin-mcp

Or connect to a local node directly:

{
  "mcpServers": {
    "bitcoin": { "command": "bitcoin-mcp" }
  }
}

Self-Hosting

pip install satoshi-api
satoshi-api  # runs on :9332

# Expose publicly (free HTTPS + DDoS protection)
cloudflared tunnel --url http://localhost:9332

See self-hosting guide for full production setup.

Contributing

Issues and PRs welcome. Run the test suite before submitting:

pip install -e ".[dev]"
pytest

License

Apache 2.0 — see LICENSE.