Developer Platform

BitcoinMiningCost documentation

Endpoint-level documentation for widgets, Pro data APIs, and Enterprise raw surfaces. The canonical contract is the downloadable OpenAPI 3.1 document.

OAS 3.1
Manage API keys
$ api.bitcoinminingcost.com

API reference

Bitcoin Mining Intelligence Platform

This documentation covers every externally accessible surface of the BitcoinMiningCost platform — from copy-paste embeddable widgets to raw institutional data APIs. The goal is to give miners, quant funds, and infrastructure analysts a single, reliable reference they can integrate against without guessing.

Every endpoint is documented with its access tier, authentication method, full parameter list, a copy-ready code example in three languages, and a real response shape. The same OpenAPI 3.1 document that powers this page can be downloaded from the header above and imported directly into Postman, Insomnia, or any toolchain that reads the spec.

Compare break-even cost across 260+ ASICsModel profitability by US state or EU countryBacktest mining economics with 4+ years of daily dataAutomate fleet decisions with programmatic access

Quick start

01

Get an API key

Subscribe to a Pro or Business plan, then create a key from your profile. Keys are prefixed bmc_pro_.

02

Send your first request

Pass your key in the x-api-key header. The efficiency endpoint needs no path parameters — it's the easiest first call.

03

Explore the surfaces

Use the sidebar to navigate Pro and Enterprise endpoints. Every endpoint page shows live parameters, examples, and response shapes.

curl -X GET 'https://api.bitcoinminingcost.com/v1/pro/efficiency?limit=30' \
-H 'x-api-key: bmc_pro_xxxxxxxxxxxxxxxxxxxx'

API surfaces

Free

Widgets

Embeddable script and iframe components that publish live mining-cost data on any website — no API key required for the end reader.

  • Mining KPI widget
  • Live BTC cost indicator
  • Scope: global, US, EU
  • 4 languages
Pro / Business

Pro API

Dashboard-grade analytics endpoints for miners, funds, and analysts. Returns curated, policy-scoped time series across cost surfaces, pools, and regions.

  • US state × sector cost surfaces
  • EU country cost surfaces
  • Multi-pool & single-pool comparison
  • Mining calculator (BTC output + cost basis)
  • Efficiency index history
Business

Enterprise API

Raw historical ASIC output surfaces for institutional integrations. Full per-pool column sets, override parameters, and high quota limits.

  • Raw BTC/kWh per ASIC model
  • Raw BTC/day per ASIC model
  • Pool fee & efficiency overrides
  • Hashrate (TH) override
  • Canonical slug reference endpoints

Data coverage

260+
ASIC models tracked
50
US states × 3 sectors
30+
European countries
30+
Mining pools compared
4yr+
Daily historical depth
2
API tiers (Pro & Business)

Rate limits

Limits are enforced per API key. Monthly quotas reset on the 1st of each month at 00:00 UTC. A 429 response includes a quota object with your current usage and reset date.

LimitDefault (Pro)Notes
Per minute60 requestsBurst protection. Exceeding returns 429 immediately.
Per day2,000 requestsRolling 24-hour window.
Per month10,000 requestsResets on the 1st. Quota object included in 429 response.
Concurrency5 in-flightSimultaneous open connections per key.