REST API Documentation

Access real-time multipool and single pool bitcoin mining data with powerful, easy-to-use endpoints.


Overview

The Public Mining API provides real-time access to Bitcoin mining data, including multipool and single pool analytics, as well as mining data specific to regions like the EU and USA. The API allows users to retrieve hashrate data, pricing, energy consumption statistics, and more to optimize mining strategies.

Base URL: https://www.bitcoinminingcost.com/api/

Response Format: JSON

HTTP Method: GET (all endpoints)


Endpoints

Explore the available endpoints and their functionalities for retrieving real-time Bitcoin mining cost data.

Retrieve data across multiple mining pools.

Get data by price:

  • Endpoint: /multipool /by-price /:price /:asic
  • Description: Returns mining data filtered by electricity price and specific ASIC miner.
  • Parameters:
    • :price (float) - Electricity price per kWh.
    • :asic (string) - ASIC miner model.

Get data by state and sector:

  • Endpoint: /multipool /by-state /:state /:sector /:asic
  • Description: Retrieves multipool mining data filtered by state, energy sector, and ASIC miner.
  • Parameters:
    • :state (string) - US state abbreviation.
    • :sector (string) - Energy sector (e.g., residential, industrial).
    • :asic (string) - ASIC miner model.

Retrieve detailed data from specific mining pools.

Get data by price:

  • Endpoint: /singlepool /by-price /:pool /:asic /:price1 /:price2? /:price3?
  • Description: Provides mining data for a specific pool, filtered by ASIC and up to three electricity price points.
  • Parameters:
    • :pool (string) - Pool name.
    • :asic (string) - ASIC miner model.
    • :price1 (float) - Primary electricity price.
    • :price2 (float, optional) - Secondary price.
    • :price3 (float, optional) - Tertiary price.

Get data by state:

  • Endpoint: /singlepool /by-state /:state /:pool /:asic
  • Description: Returns mining data for a specific pool within a given state.
  • Parameters:
    • :state (string) - US state abbreviation.
    • :pool (string) - Pool name.
    • :asic (string) - ASIC miner model.

Access mining data for Europe.

Single Pool Data:

  • Endpoint: /eu /:sector /:pool /:asic
  • Description: Retrieves mining data from a specific pool in Europe, filtered by sector and ASIC.
  • Parameters:
    • :sector (string) - Energy sector.
    • :pool (string) - Pool name.
    • :asic (string) - ASIC miner model.

Multipool Data:

  • Endpoint: /eu /:sector /:asic
  • Description: Returns aggregated mining data across multiple pools in Europe.
  • Parameters:
    • :sector (string) - Energy sector.
    • :asic (string) - ASIC miner model.

Access mining data for the United States.

Single Pool Data:

  • Endpoint: /usa /:sector /:pool /:asic
  • Description: Retrieves mining data from a specific pool in the USA.
  • Parameters:
    • :sector (string) - Energy sector.
    • :pool (string) - Pool name.
    • :asic (string) - ASIC miner model.

Multipool Data:

  • Endpoint: /usa /:sector /:asic
  • Description: Returns aggregated mining data across multiple pools in the USA.
  • Parameters:
    • :sector (string) - Energy sector.
    • :asic (string) - ASIC miner model.

Request:

GET https://www.bitcoinminingcost.com/api/eu/industrial/antpool/antminer-s21-xp-immersion

Response:

 {
        "EUindustrial":
        {
            "AT":99620.70637412998,
            "BE":71187.79895560561,
            "BG":151312.5160011907,
            "HR":128035.52286534675,
            "CZ":99409.64555554073,
            "DK":77827.16927751343,
            "EE":90213.42417415162,
            "FI":1724.6684033293693,
            "FR":53356.174939364544,
            "DE":92058.698759532,
            "GR":142411.77976582653,
            "HU":137129.2289919925,
            "IE":79407.11026238158,
            "IT":0,
            "LV":90213.42417415162,
            "LT":84575.08516326714,
            "LU":70397.82846317154,
            "NL":75981.89469213305,
            "PL":107387.74449821471,
            "PT":48592.230748349844,
            "RO":133511.04353046237,
            "SK":129386.31210431797,
            "SI":121956.9712899761,
            "ES":42875.49771913222,
            "SE":21612.627823540064
        }
    }
                    

Legend

A comprehensive guide to all the variables used across the system for easy reference and understanding.

industrial
commercial
residential
ALAlabama
AKAlaska
AZArizona
ARArkansas
CACalifornia
COColorado
CTConnecticut
DEDelaware
DCDistrict Of Columbia
FLFlorida
GAGeorgia
HIHawaii
IDIdaho
ILIllinois
INIndiana
IAIowa
KSKansas
KYKentucky
LALouisiana
MEMaine
MDMaryland
MAMassachusetts
MIMichigan
MNMinnesota
MSMississippi
MOMissouri
MTMontana
NENebraska
NVNevada
NHNew Hampshire
NJNew Jersey
NMNew Mexico
NYNew York
NCNorth Carolina
NDNorth Dakota
OHOhio
OKOklahoma
OROregon
PAPennsylvania
RIRhode Island
SCSouth Carolina
SDSouth Dakota
TNTennessee
TXTexas
UTUtah
VTVermont
VAVirginia
WAWashington
WVWest Virginia
WIWisconsin
WYWyoming
USUnited States
ATAustria
BEBelgium
BGBulgaria
HRCroatia
CYCyprus
CZCzech Republic
DKDenmark
EEEstonia
FIFinland
FRFrance
DEGermany
GRGreece
HUHungary
IEIreland
ITItaly
LVLatvia
LTLithuania
LULuxembourg
MTMalta
NLNetherlands
PLPoland
PTPortugal
RORomania
SKSlovakia
SISlovenia
ESSpain
SESweden
BGBulgaria
RORomania
HRCroatia
EEEstonia
FIFinland
aisen-a1-pro
antminer-s1
antminer-s2
antminer-s3-plus
antminer-s4
antminer-s5-plus
antminer-u1
antminer-u2-plus
antminer-u3
asicminer-be-blade
asicminer-be-cube
asicminer-be-prisma
asicminer-be-sapphire
asicminer-be-tube
avalon-batch-1
avalon-batch-2
avalon-batch-3
avalon-2
avalon-3
avalon-6
avalon-721
avalon-761
bfl-230gh-rack-mount
bfl-500gh-mini-rig-sc
bfl-monarch-700gh
bfl-sc-10-gh
bfl-sc-50-gh
bfl-sc-5gh
bfl-single-sc
bi-fury
bitfily-snow-panther-a1
bitfily-snow-panther-b1
bitfily-snow-panther-b1-plus
bitfury-b8
bitfury-tardis
antminer-r4
antminer-s11
antminer-s17-53th
antminer-s17-56th
antminer-s17-pro-50th
antminer-s17-pro-53th
antminer-s17-plus
antminer-s17e
antminer-s19
antminer-s19-hydro
antminer-s19-pro
antminer-s19-pro-hyd
antminer-s19-pro-plus-hyd
antminer-s19-pro-plus-plus
antminer-s19-xp
antminer-s19-xp-hyd
antminer-s19j-90th
antminer-s19j-pro-100th
antminer-s19j-pro-104th
antminer-s19j-pro-96th
antminer-s19j-pro-plus
antminer-s19j-xp
antminer-s19k-pro
antminer-s21
antminer-s21-hyd
antminer-s21-pro
antminer-s21-xp
antminer-s21-xp-hyd
antminer-s21-xp-immersion
antminer-s21e-xp-hyd-3u
antminer-s3
antminer-s5
antminer-s7
antminer-s7-ln
antminer-s9-11th
antminer-s9-12th
antminer-s9-13-5th
antminer-s9-13th
antminer-s9-14th
antminer-s9-hydro
antminer-s9-se
antminer-s9i-13th
antminer-s9i-14th
antminer-s9j
antminer-s9k
antminer-t17
antminer-t17-plus
antminer-t17e
antminer-t19-84th
antminer-t19-88th
antminer-t19-hydro-145th
antminer-t19-hydro-158th
antminer-t21
antminer-t9-11th
antminer-t9-12th
antminer-t9-plus
antminer-v9
bitmine-avalon-clone
black-arrow-prospero-x-1
black-arrow-prospero-x-3
blue-fury
bolon-miner-b11
btc-garden-am-v1-310gh
btc-garden-am-v1-616gh
avalon-a1566
avalon-a1566i
avalon-made-a1346
avalon-made-a1366
avalon-made-a1446
avalon-made-a1466
avalon-nano-3
avalonminer-1047
avalonminer-1066
avalonminer-1126-pro
avalonminer-1146-pro
avalonminer-1166-pro
avalonminer-1246
avalonminer-741
avalonminer-821
avalonminer-841
avalonminer-921
cointerra-terraminer-iv
drillbit
ebit-e10
ebit-e10d
ebit-e11
ebit-e11-plus
ebit-e11-plus-plus
ebit-e12
ebit-e12-plus
ebit-e9
ebit-e9-plus
ebit-e9-2
ebit-e9-3
ebit-e9i
ebit-e9-plus-plus
gmo-miner-b2
gmo-miner-b3
gpu1
gpu2
gpu3
gpu4
halong-mining-dragonmint-t1
hashbuster-micro
hashbuster-nano
hashcoins-apollo-v3
hashcoins-zeus-v3
hashfast-baby-jet
hashfast-sierra
hashfast-sierra-evo-3
holic-h22
holic-h28
innosilicon-t2-terminator
innosilicon-t2-turbo
innosilicon-t2-turbo-26th
innosilicon-t2-turbo-hf-plus
innosilicon-t2-turbo-plus32th
innosilicon-t3-39th
innosilicon-t3-43th
innosilicon-t3-50th
innosilicon-t3-plus-52th
innosilicon-t3-plus-57th
ipollo-b1l
klondike
knc-jupiter
knc-neptune
knc-saturn
kncminer-mercury
littlefury
metabank
whatsminer-m10
whatsminer-m10s
whatsminer-m20s
whatsminer-m21
whatsminer-m21s
whatsminer-m3
whatsminer-m30s
whatsminer-m30s-plus
whatsminer-m30s-plus-plus
whatsminer-m31s
whatsminer-m31s-plus
whatsminer-m32
whatsminer-m32s
whatsminer-m33s-plus-plus
whatsminer-m36s-plus
whatsminer-m3x
whatsminer-m50
whatsminer-m50s
whatsminer-m53
whatsminer-m53s
whatsminer-m56
whatsminer-m56s
whatsminer-m60
whatsminer-m60s
whatsminer-m60s-plus
whatsminer-m63
whatsminer-m63s
whatsminer-m66
whatsminer-m66s
nanofury-icefury
nanofury-nf2
pantech-sx6
pantech-wx6
redfury
rockminer-r-box
rockminer-r-box-110gh
rockminer-r3-box
rockminer-r4-box
rockminer-rocket-box
rockminer-t1
spondooliestech-sp10-dawson
spondooliestech-sp20-jackson
spondooliestech-sp30-yukon
spondooliestech-sp31-yukon
spondooliestech-sp35-yukon
strongu-hornbill-h8
strongu-hornbill-h8-pro
strongu-stu-u8
strongu-stu-u8-pro
terrahash-dx-large
terrahash-dx-mini
terrahash-klondike 16
terrahash-klondike 64
twinfury
whatsminer-m1
whatsminer-m2
175btc
1hash
1m1x
1thash
21inc
50btc
58coin
7pool
8baochi
a-xbt
aaopool
asicminer
antpool
arkpool
batpool
bcmonster
btcguild
btcnuggets
btctop
btccom
btcc
btcdig
btcserv
btpool
bwpool
binancepool
bitclub
bitfury
bitminter
bitcoinaffiliatenetwork
bitcoinindia
bitcoinukraine
bitcoincom
bitcoinrussia
bitfarms
bitparking
bitsolo
bixin
blockfills
braiinspool
bravomining
bytepool
ckpool
canoepool
cloudhashing
coinlab
cointerra
connectbtc
dcex
dcexploration
dpool
emcdpool
exxbw
eclipsemc
ekanembtc
eligius
eobot
f2pool
foundryusa
gbminers
ghashio
givemecoins
gogreenlight
haozhuzhu
hashpool
hhtt
hashbx
helix
hotpool
hummerpool
huobipool
kanopool
kncminer
kucoinpool
lubian
luxor
marapool
maxbtc
megabigpower
minerium
miningcity
miningkings
mtred
multipool
nmcbit
nexious
nicehash
novablock
okexpool
okkong
okminer
ozcoin
pegapool
phash
patels
polmine
poolin
rawpool
rigpool
sbicrypto
stminingcorp
secretsuperstar
sigmapool
solock
spiderpool
tatmaspool
tbdice
tangpool
telco214
terrapool
titan
trickysbtcpool
triplemining
ultimuspool
unomp
unknown
viabtc
wayi
waterhole
yourbtc.net
zulupool
bcpool
digitalbtc
digitalxmintsy
haominer
mmpool
mybtccoinpool
okpool
shawnp0wers
simplecoin
tiger
tigerpool
transactioncoinmining
ocean
secpool
neopool
carbonnegative
whitepool

Rate Limits

  • Free Tier: 20 requests per minute.

Exceeding the rate limit will result in a 429 Too Many Requests response.


Contact & Support

For further assistance, bug reports, or feature requests, contact us..