mining monitor API

[gzelda]

Mining Monitor API

V1 Data

winnerPie:
[{"address":"SP06HBN5DHC55CKSWR32SZ7WQWBKZM8GXC5NWJ3P","number":8,"RR":"3.171"},{"address":"SP0B0EYFXNXK3A5XXD0QAQA09PVEY005ZZAWEKZE","number":17,"RR":"0.419"}...]

r1000:
[{"address":"SP137NZXD0BM4DM875ZH2HGDNPEBP6KW18RFXQ9W3","number":33,"RR":"-0.223"},{"address":"SP1R7EKK639BRCMJ3R1KC1RM7M0CF0X4S5ACNYSRE","number":171,"RR":"0.170"}...]

r100:
[{"address":"SP1R7EKK639BRCMJ3R1KC1RM7M0CF0X4S5ACNYSRE","number":14,"RR":"-0.144"},{"address":"SP2R0VR6CFDF533VX3S1XDSFCQN9E1K8C5WS5Q9JC","number":27,"RR":"0.312"}...]

current_burn_fee:
{"data_20":[2890000,2890000,2890000,2890000,2890000,2890000,2890000,2890000,2890000,2890000,2890000,2890000,2890000,2890000,2890000,1665000,2890000,2890000,2890000,2890000],"avg":2828750},"current_miner":{"data_20":[6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,3,6,6,6,6],"avg":5.85}}

minerTable:
[{"stacks_block_height":21543,"stx_address":"SP1R7EKK639BRCMJ3R1KC1RM7M0CF0X4S5ACNYSRE","btc_address":"1BFfc2e6Kk82ut7S3C5yaN3pWRxEFRLLu5","burn_fee":"490000"},{"stacks_block_height":21542,"stx_address":"SP3MKRB8AGZ1FTNCJAPWE13D7R4AD8CDDTRCVHS4V","btc_address":"1NGEXo4oKR563AoC2owwsb4YzGAJzUSndN","burn_fee":"400000"}...]

minersBurnFee20:
[{"height":21523,"address":"SP3MKRB8AGZ1FTNCJAPWE13D7R4AD8CDDTRCVHS4V","fee":400000},{"height":21523,"address":"SP4NM179GYGDC1ETPPC55BNPRSG9DZBM1T195PME","fee":250000}...]

burnFeeArea:
[{"height":20543,"burn_fee":410000,"address":"SP2R0VR6CFDF533VX3S1XDSFCQN9E1K8C5WS5Q9JC"},{"height":20544,"burn_fee":820000,"address":"SP2R0VR6CFDF533VX3S1XDSFCQN9E1K8C5WS5Q9JC"}...]

Overview

API	Comment
/api/v2/getOverviewData	get overview data for homepage
/api/v2/getSatsCommittedPerBlock	list total sats committed for each block
/api/v2/getTopBurnFeePerBlock	list top x burn fee in each block
/api/v2/getRewardDistribution	get reward distrubution for x blocks
/api/v2/getBlocks	get each block info
/api/v2/getBlockInfoByNumber	get block details by block number
/api/v2/getBriefMinerInfo	get brief miner info
/api/v2/getMinerInfoPerBlock	get miner info for each block
/api/v2/getMinerSatsCommittedPerBlock	get sats committed for the miner for each block
/api/v2/getMinerMiningHistory	get mining history for the miner
/api/v2/getMinersInfo	get miners info
/api/v2/getMiningInfo	get mining info
/api/v2/exportData	export mining monitor data
/api/v2/getTokenPrice	get token price for STX/USDT and BTC/USDT

Detail

/api/v2/getOverviewData

Request Params

null

Response Params

{
    "status": int,
    "msg": string,
    "err_msg": string,
    "data": struct
}

data

Name	Type	Comment
total_sats_committed	int	total sats committed for mining
reward_payout_interval	int	reward payout interval for mining
avg_tx_fees_per_block(TODO)	int	average transaction fees per block
last_tx_fees(TODO)	int	last transaction fees
active_miners	int	active miners
stx_block_height	int	current stacks chain block height
btc_block_height	int	current btc chain block height
next_stx_halving(TODO)	int	next halving days for STX
btc_hash_rate	float	btc hash rate right now

/api/v2/getSatsCommittedPerBlock

Request Params

null

Response Params

{
    "status": int,
    "msg": string,
    "err_msg": string,
    "data": []struct
}

data struct

Name	Type	Comment
block_number	int	block number
total_sats_committed	int	total sats committed in the block

/api/v2/getTopBurnFeePerBlock

Request Params

null

Response Params

{
    "status": int,
    "msg": string,
    "err_msg": string,
    "data": [{
    	 block_number: int
    	 miner_list: []struct
	  }]
}

topMinerList struct

Name	Type	Comment
leader_key_address	string	stx address
burn_fee	int	miner's burn fee

/api/v2/getRewardDistribution

Request Params

Name	Type	Comment
latest_blocks	int	last N blocks(only support 100/1000)

Response Params

{
    "status": int,
    "msg": string,
    "err_msg": string,
    "data": []struct
}

data struct

Name	Type	Comment
stx_address	string	miner's stx address
actual_win	int	winning count for the miner

/api/v2/getBlocks

Request Params

null

Response Params

{
    "status": int,
    "msg": string,
    "err_msg": string,
    "data": []struct
}

data

Name	Type	Comment
block_number	int	block number
mined_at(TODO)	int	when was the block mined
sats_spent	int	how many sats was spent in the block
winner_address	string	winner address

/api/v2/getBlockInfoByNumber

Request Params

Name	Type	Comment
block_number	int	block number

Response Params

// TODO return rate

{
    "status": int,
    "msg": string,
    "err_msg": string,
    "data": struct {
    	miners_count: int, // how many miners in the block
    	total_burn_fee: int, // total burn fee in the block
    	miners_info: []struct{
            miner_address: string, // miner_address
        		burn_fee: int, // burn fee for the miner
            win_probability: float // winning probability for the miner
        }
      block_info: struct {
              is_stx_pending: bool, // pending status in STX
              is_btc_pending: bool, // pending status in BTC
              is_reward_pending: bool, // pending status for reward
              winning_address: string, // when mined, show winning address
              tx_id: string, // when mined, show transaction id in stacks
              block_height: int, // when mined, show block height
              stacks_awarded: int, // when mined, show stacks award
              winning_miner_burn_fee: int, // when mined, show winning miner burn fee
              return_rate: int, // return rate
          }
      block_status: int // block status(pending or mined)
	}
}

/api/v2/getBriefMinerInfo

Request Params

Name	Type	Comment
stx_address	string	miner's stx address

Response Params

{
    "status": int,
    "msg": string,
    "err_msg": string,
    "data": struct
}

data struct

Name	Type	Comment
total_blocks_won	int	total blocks won
total_stx_earned	int	total STX earned
total_sats_spent	int	total sats spent
return_rate	float	return rate

/api/v2/getMinerInfoPerBlock

Request Params

Name	Type	Comment
stx_address	string	miner's stx address

Response Params

{
    "status": int,
    "msg": string,
    "err_msg": string,
    "data": []struct
}

data struct

Name	Type	Comment
block_number	int	block number
block_status	int	block status: inactive 0 / lost 1/ won 2
tx_id	string	transaction id
btc_height	int	mapping to the height of BTC chain
stacks_reward	int	stacks reward
burn_fee	int	burn fee
return_rate	float	return rate

/api/v2/getMinerSatsCommittedPerBlock

Request Params

Name	Type	Comment
stx_address	string	miner's stx address

Response Params

{
    "status": int,
    "msg": string,
    "err_msg": string,
    "data": []struct
}

data struct

Name	Type	Comment
block_number	int	block number
total_sats_committed	int	total sats committed for the miner per block

/api/v2/getMinerMiningHistory

Request Params

Name	Type	Comment
stx_address	string	miner's stx address

Response Params

{
    "status": int,
    "msg": string,
    "err_msg": string,
    "data": []struct
}

data struct

Name	Type	Comment
block_number	int	block number
mined_at	int	when was block mined
sats_spent	int	sats spent in the block
block_status	int	block status(won / lost / inactive)

/api/v2/getMinersInfo

Request Params

null

Response Params

{
    "status": int,
    "msg": string,
    "err_msg": string,
    "data": []struct
}

data struct

Name	Type		Comment
stx_address	string		miner's address
total_burnfee	int		total burn fee
total_block_reward	int		total block reward
total_participation	int		total participation
total_blocks	int		total blocks
total_stx_reward	int		total stx reward

/api/v2/getMiningInfo

Request Params

Name	Type	Comment
latest_blocks	int	last N blocks(only support 100/ 1000)

Response Params

{
    "status": int,
    "msg": string,
    "err_msg": string,
    "data": struct{
    	total_sats_spent: int, // total sats spent
    	total_stx_reward: int, // total stx reward
    	miners_info: []struct
	}
}

minersInfo struct

Name	Type	Comment
stx_address	string	miner's address
total_sats_spent	int	total sats spent
total_stx_reward	int	total stx reward

/api/v2/exportData

Request Params

null

Response Params

data

//TODO: Not sure right now.

/api/v2/getTokenPrice

Request Params

null

Response Params

{
    "status": int,
    "msg": string,
    "err_msg": string,
    "data": []struct
}

data

Name	Type	Comment
token_name	string	token name
token_id	int	token type
token_price	float	token price