API

Welcome to minerstat API center. This API document is designed for those interested in developing or improving their own monitoring systems.

Requirements

To use our APIs you don't need any special developer account. If you have paying account or minerstat+ there is more historical data available.

Response

minerstat API use the HTTPS protocols for requests. They return responses in JSON data format.

Base URL

The base URL is https://api.minerstat.com/v2/

Workers API

This endpoint returns a JSON object with all of your workers and their current mining details and information.

Request

https://api.minerstat.com/v2/stats/{ACCESS_KEY}

Parameters

Name Type Description
{ACCESS_KEY} string This is your unique access key. If you forgot what is the value, you can see it by hovering the mouse over your avatar in your minerstat dashboard or by checking the first e-mail we have sent you.

Example response

{"GPU-Rig001": {
	"hardware": [{
		"name": "NVIDIA TITAN V",
		"temp": 46,
		"fan": 88,
		"power": 81,
		"speed": 3.54120
	},{
		"name": "NVIDIA TITAN V",
		"temp": 43,
		"fan": 88,
		"power": 84,
		"speed": 3.35299
	}],
	"revenue": {
		"usd_day": 0.145,
		"usd_day_dual": 0,
		"usd_week": 1.015,
		"usd_month": 4.495,
		"usd_month_dual": 0,
		"btc_day": 1.9e-5,
		"btc_week": 0.000135,
		"btc_month": 0.000597,
		"coin": 0.00158222,
		"coin_dual": 0,
		"cprice": 91.518,
		"cprice_dual": 0,
		"usd_day_cpu": 0,
		"btc_day_cpu": 0
	},
	"mining": {
		"client": "ccminer-tpruvot",
		"client_cpu": "",
		"crypto": "DCR",
		"crypto_dual": "",
		"crypto_cpu": "",
		"pool": "dcr.suprnova.cc:3252",
		"pool_dual": null,
		"hashrate": {
			"hashrate": 6.89419,
			"hashrate_unit": "MH",
			"hashrate_dual": 0,
			"hashrate_unit_dual": null,
			"hashrate_cpu": 0,
			"hashrate_unit_cpu": null
		},
		"shares": {
			"accepted_share": 3010,
			"accepted_share_dual": 0,
			"rejected_share": 0,
			"rejected_share_dual": 0
		}
	},
	"info": {
		"type": "nvidia",
		"system": "win",
		"groups": "nvidia,msos",
		"status": "online",
		"status_cpu": "idle",
		"uptime": "23h 50min",
		"sync": 55,
		"time": "2018-05-31 10: 41: 13",
		"note": "0",
		"os": {
			"status": "online",
			"sync": false,
			"freespace": 0,
			"freemem": 0,
			"localip": "0.0.0.0",
			"remoteip": "0.0.0.0"
		}
	}
},
"ASIC-Worker": {
	"info": {
		"type": "asic",
		"system": "antminer",
		"groups": "antminer,asic",
		"status": "online",
		"uptime": "23h 57min",
		"sync": 1,
		"time": "2018-05-31 12: 55: 35",
		"note": "0",
		"os": {
			"localip": "0.0.0.0",
			"remoteip": "0.0.0.0"
		},
		"auth": {
			"user": "root",
			"pass": "admin"
		}
	},
	"mining": {
		"client": "bmminer",
		"crypto": "BTC",
		"pool": "stratumtcp: stratum.antpool.com: 3333",
		"hashrate": {
			"hashrate": 13.128,
			"hashrate_unit": "TH"
		},
		"shares": {
			"accepted_share": 8013,
			"rejected_share": 1
		}
	},
	"revenue": {
		"usd_day": 5.85,
		"usd_week": 40.92,
		"usd_month": 181.23,
		"btc_day": 0.00078,
		"btc_week": 0.00544,
		"btc_month": 0.02407,
		"coin": 0.00077455,
		"cprice": 7547.27
	},
	"hardware": [{
		"name": "Antminer",
		"temp": [
			56,
			60,
			64
		],
		"fan": [
			6120,
			4560
		],
		"chain": [
			4408,
			4358,
			4370
		]
	}]
},{
	...
}
Name Type Description
hardware array[] The list of all hardware in the mining rig. One worker can hold up to 16 GPUs.
hardware[i].name string Hardware's name.
hardware[i].temp (GPU) integer Hardware's temperature (°C).
hardware[i].fan (GPU) integer Hardware's fan (%).
hardware[i].power (GPU) real Hardware's power consumption (W).
hardware[i].speed (GPU) real Hardware's speed (units defined in mining section).
hardware[i].temp (ASIC) array[] The list of all temperatures for hardware (°C).
hardware[i].fan (ASIC) array[] The list of all fans for hardware (RPM or %).
hardware[i].chain (ASIC) array[] The list of all chains for hardware.
revenue object{} Information on current revenue status.
revenue.usd_day real Current USD/day profitability for main and dual coins.
revenue.usd_day_dual real Current USD/day profitability for dual coin.
revenue.usd_day_cpu real Current USD/day profitability for CPU coin.
revenue.usd_week real Current USD/week profitability for main and dual coins.
revenue.usd_month real Current USD/month profitability for main and dual coins.
revenue.usd_month_dual real Current USD/month profitability for dual coin.
revenue.btc_day real Current BTC/day profitability for main and dual coins.
revenue.btc_day_cpu real Current BTC/day profitability for CPU coin.
revenue.btc_week real Current BTC/week profitability for main and dual coins.
revenue.btc_month real Current BTC/month profitability for main and dual coins.
revenue.coin real Current amount of main coin mined in one day.
revenue.coin_dual real Current amount of dual coin mined in one day.
revenue.cprice real Current exchange rate of the main coin.
revenue.cprice_dual real Current exchange rate of the dual coin.
mining object{} Information on current mining status.
mining.client string Mining client that is used for mining main and/or dual coin.
mining.client_cpu string Mining client that is used for mining CPU coin.
mining.crypto string Main coin mined with GPU or ASIC.
mining.crypto_dual string Dual coin mined with GPU.
mining.crypto_cpu string Coin mined with CPU.
mining.pool string Address of the pool the worker is currently mining on.
mining.pool_dual string Address of the pool the worker is currently mining on with dual mining.
mining.hashrate object{} Information on current hashrates.
mining.hashrate.hashrate real Current hashrate of main algorithm.
mining.hashrate.hashrate_unit real Units of current hashrate.
mining.hashrate.hashrate_dual real Current hashrate of dual algorithm.
mining.hashrate.hashrate_unit_dual real Units of current dual hashrate.
mining.hashrate.hashrate_cpu real Current hashrate of CPU algorithm.
mining.hashrate.hashrate_unit_cpu real Units of current CPU hashrate.
mining.shares object{} Information on current shares.
mining.hashrate.shares.accepted_share integer Number of accepted shares for main algorithm
mining.hashrate.shares.rejected_share integer Number of rejected shares for main algorithm
mining.hashrate.shares.accepted_share_dual integer Number of accepted shares for dual algorithm
mining.hashrate.shares.rejected_share_dual integer Number of rejected shares for dual algorithm
info object{} Information on different mining settings.
info.type string Type of your worker, for example nvidia, amd, or asic.
info.system string Type of your system, for example windows, linux, or antminer.
info.groups string The list of all groups assigned to the worker.
info.status string Status of your worker, for example online, offline.
info.status_cpu string Status of your CPU, for example online, idle.
info.uptime string Worker's uptime in YYYY-MM-DD hh-mm-ss format.
info.note integer Information on any custom note for this worker: 0 when there is no note and 1 when there is a note.
info.os object{} Information on worker's OS.
info.os.status string Status of worker's OS, for example online or offline.
info.os.sync string Last sync.
info.os.freespace real Amount of free space in GB.
info.os.freemem real Amount of free memory in GB.
info.os.localip string Local IP address.
info.os.remoteip string Remote IP address.
info.auth (ASIC) object{} Information on worker's OS.
info.auth.user string Username required for ASIC identification.
info.auth.pass string Password required for ASIC identification.

Worker's details API

This endpoint returns a JSON object with current mining details and information for selected worker.

Request

https://api.minerstat.com/v2/stats/{ACCESS_KEY}/{WORKER_NAME}

Parameters

Name Type Description
{ACCESS_KEY} string This is your unique access key. If you forgot what is the value, you can see it by hovering the mouse over your avatar in your minerstat dashboard or by checking the first e-mail we have sent you.
{WORKER_NAME} string This is the name of your worker. API won't return any result if you didn't add a worker with this name in your minerstat dashboard.

Example response

The response is the same as one element of Workers API response.

Hashrate & Temperature API

This endpoint returns a JSON object with historical hashrate and temperature details for selected worker.

Request (UTC timezone)

https://api.minerstat.com/v2/stats-hashtemp/{ACCESS_KEY}/{WORKER_NAME}

Request (custom timezone)

https://api.minerstat.com/v2/stats-hashtemp/{ACCESS_KEY}/{WORKER_NAME}?timezone={TIMEZONE}

Parameters

Name Type Description
{ACCESS_KEY} string This is your unique access key. If you forgot what is the value, you can see it by hovering the mouse over your avatar in your minerstat dashboard or by checking the first e-mail we have sent you.
{WORKER_NAME} string This is the name of your worker. API won't return any result if you didn't add a worker with this name in your minerstat dashboard.
{TIMEZONE} string This parameter is optional and it will convert all results to custom timezone. Example: London/Europe.

Example response

{
"resultsHash": {
	"ETH": [
		[15276708, 121.5432],
		[15276714, 123.6354],
		[15276720, 125.1423],
		[15276726, 121.1432],
		...
	],
	"DCR: [
		[15276708, 6.09861],
		[15276714, 6.40408],
		[15276720, 6.83237],
		[15276726, 6.86901],
		...
	],
	...
},
"colors: "{
	"ETH": "#7b8fed",
	"DCR": "#5cddaf",
	...
},
"units": [
	"ETH": "MH",
	"DCR", "MH",
	...
],
"resultsTemp": [[
		[15276708, 59],
		[15276714, 60],
		[15276720, 60],
		[15276726, 59],
		...
	],[
		[15276708, 61],
		[15276714, 62],
		[15276720, 62],
		[15276726, 63],
		...
	],
	...
]
}
Name Type Description
resultsHash object{} List of all coins this worker mined and its hashrates.
resultsHash.{COIN} array[] Array of historical data in [timestamp, hashrate] format for coin with name {COIN}. Please note that timestamp must be multiplied by 100 to get UNIX timestamp number.
colors object{} List of all colors that represent the coins this worker mined.
colors.{COIN} string Color of the coin with name {COIN} in HEX format.
units object{} List of all units for the coins this worker mined.
units.{COIN} string Unit for coin with name {COIN}.
resultsTemp array[] List of all hardware this worker used for mining.
resultsTemp[i] array[] Array of historical data in [timestamp, temperature] format for i-th hardware. Please note that timestamp must be multiplied by 100 to get UNIX timestamp number.

Global statistics API

This endpoint returns a JSON object with your global profitability data.

Request

https://api.minerstat.com/v2/stats-global/{ACCESS_KEY}

Parameters

Name Type Description
{ACCESS_KEY} string This is your unique access key. If you forgot what is the value, you can see it by hovering the mouse over your avatar in your minerstat dashboard or by checking the first e-mail we have sent you.

Example response

{
"global": {
	"1525589401": 10.631468,
	"1525590001": 8.6616613,
	...
},
"groups": {
	"amd": {
		"1525589401": 0.0245212,
		"1525590001": 0.0286454,
		...		
	},
	"msos": {
		"1525589401": 1.2432413,
		"1525590001": 1.6542534,
		...				
	},
	"S9": {
		"1525589401": 4.6553434,
		"1525590001": 4.4323434,
		...				
	},
	...
},
"coins": {
	"ETH": {
		"1525589401": 2.2543542,
		"1525590001": 2.2486785,
		...		
	},
	"DCR": {
		"1525589401": 0.0546554,
		"1525590001": 0.0543538,
		...				
	},
	...	
},
"daily": {
	"1525564800": 9.6977841,
	"1525651200": 4.0620775,
	...
},
"daily_workers": {
	"1525564800": {
		"WRK01": 0,
		"WRK02": 0.4343212,
		"WRK03": 2.9832432,
		...
	},
	"1525651200": {
		"WRK01": 1.5234233,
		"WRK02": 0.5436349,
		"WRK03": 3.06774564,
		...		
	},	
	...
},
"daily_coins": {
	"1525564800": {
		"ETH": 2.43534523,
		"DCR": 0.06542397,
		"BTC": 0,
		...
	},
	"1525651200": {
		"ETH": 3.76577687,
		"DCR": 0.09876576,
		"BTC": 0,
		...	
	},	
	...	
}
}					
					
Name Type Description
global object{} Historical data with global profitability in USD for all workers. Data is saved every 30 minutes for free user and every 10 minutes for paying and minerstat+ users.
groups object{} List of all groups assigned to workers. You can add custom groups to worker in your minerstat dashboard.
groups.{GROUP} object{} Historical data with global profitability in USD for all workers from group with name {GROUP}. Data is saved every 30 minutes for free user and every 10 minutes for paying and minerstat+ users.
coins object{} List of all coins that were mined with user's account.
coins.{COIN} object{} Historical data with global profitability in USD for all workers that mined coin with name {COIN}. Data is saved every 30 minutes for free user and every 10 minutes for paying and minerstat+ users.
daily object{} Historical data with average daily profitability in USD for all workers by day.
daily_workers object{} Historical data with average daily profitability in USD by day by workers.
daily_workers.{TIMESTAMP} object{} List of all workers that mined on the day that starts with timestamp {TIMESTAMP} and their average profitability in USD for that day.
daily_coins object{} Historical data with average daily profitability in USD by day by coins.
daily_coins.{TIMESTAMP} object{} List of all coins that were mined on the day that starts with timestamp {TIMESTAMP} and their average profitability data for that day.
daily_coins.{TIMESTAMP}.{COIN} array[] Average profitabilty data for coin with name {COIN} on day that starts with {TIMESTAMP} in format [profitability_sum, count, amount_sum]. Daily average profitability of {COIN} in USD is calculated as profitability_sum/count and daily average amount of mined coins as amount_sum/count.

Per worker statistics API

This endpoint returns a JSON object with your profitability data for selected worker.

Request (UTC timezone)

https://api.minerstat.com/v2/stats-worker/{ACCESS_KEY}/{WORKER_NAME}

Request (custom timezone)

https://api.minerstat.com/v2/stats-worker/{ACCESS_KEY}/{WORKER_NAME}?timezone={TIMEZONE}

Parameters

Name Type Description
{ACCESS_KEY} string This is your unique access key. If you forgot what is the value, you can see it by hovering the mouse over your avatar in your minerstat dashboard or by checking the first e-mail we have sent you.
{WORKER_NAME} string This is the name of your worker. API won't return any result if you didn't add a worker with this name in your minerstat dashboard.
{TIMEZONE} string This parameter is optional and it will convert all results to custom timezone. Example: London/Europe.

Example response

{
"data": [
	"Worker001",
	[
		"nvidia",
		"msos",
		...
	],
	[
		[15276708, ["ETC",0.051,16.64]],
		[15276714, ["ETC",0.052,16.62]],
		...
	]
],
"colors": {
	"ETH": "#7b8fed",
	...
},
"temperature": [[
		[15276708, 59],
		[15276714, 60],
		[15276720, 60],
		[15276726, 59],
		...
	],[
		[15276708, 61],
		[15276714, 62],
		[15276720, 62],
		[15276726, 63],
		...
	],
	...
],
"efficiency": [
	[15276708, 1],
	[15276714, 1],
	[15276720, 0.98],
	[15276726, 0.99],
	...
]
}					
					
Name Type Description
data array[] Basic information on worker. First element in array is worker's name, second element in array is array of all groups for this worker, and third element is historical profitability data and exchange rate for the coin that was mined.
colors object{} List of all colors that represent the coins this worker mined.
colors.{COIN} string Color of the coin with name {COIN} in HEX format.
temperature array[] List of all hardware this worker used for mining.
temperature[i] array[] Array of historical data in [timestamp, temperature] format for i-th hardware. Please note that timestamp must be multiplied by 100 to get UNIX timestamp number.
efficiency array[] Array of historical data in [timestamp, efficiency] format. Please note that timestamp must be multiplied by 100 to get UNIX timestamp number.

Balance statistics API

This endpoint returns a JSON object with your balance data on different pools and wallets.

Request

https://api.minerstat.com/v2/stats-balance/{ACCESS_KEY}

Parameters

Name Type Description
{ACCESS_KEY} string This is your unique access key. If you forgot what is the value, you can see it by hovering the mouse over your avatar in your minerstat dashboard or by checking the first e-mail we have sent you.

Example response

{
"pools":{
	"1526106613":{
		"Ethermine (ETH)":{
			"ETH": 0.00107382,
			...
		},
		...
	},
	"1526107745":{
		"Ethermine (ETH)":{
			"ETH": 0.00110999,
			...
		},
		...
	},
	...	
},
"wallets":{
	"1526106613":{
		"Kraken":{
			"BTC": 0.00107382,
			"ETH": 0.75434543,
			...
		},
		"Blockchain (BTC)":{
			"BTC": 0.20254544,
			...
		},
		...
	},
	"1526107745":{
		"Kraken":{
			"BTC": 0.00107382,
			"ETH": 0.75434543,
			...
		},
		"Blockchain (BTC)":{
			"BTC": 0.20254544,
			...
		},
		...
	},
	...	
}
}
					
Name Type Description
pools object{} List of all timestamps when pools were monitored.
pools.{TIMESTAMP} object{} List of all pools that were monitored at timestamp {TIMESTAMP}.
pools.{TIMESTAMP}.{POOL} object{} List of all coins and their balances that were monitored at timestamp {TIMESTAMP} on pool {POOL}.
wallets object{} List of all timestamps when wallets were monitored.
wallets.{TIMESTAMP} object{} List of all wallets that were monitored at timestamp {TIMESTAMP}.
wallets.{TIMESTAMP}.{WALLET} object{} List of all coins and their balances that were monitored at timestamp {TIMESTAMP} on wallet {WALLET}.

Jump to