Difference between revisions of "BIP PoolAPI"

From Bitcoin Wiki
Jump to: navigation, search
Line 16: Line 16:
 
|-
 
|-
 
| hashrate || {{No}} || Number || total hashrate of all mining in the organizational pool
 
| hashrate || {{No}} || Number || total hashrate of all mining in the organizational pool
 +
|-
 +
| miners || {{No}} || Array of Objects || information of specific miners
 
|}
 
|}
  
Line 41: Line 43:
 
| name || {{No}} || String || human-readable identifier for miner
 
| name || {{No}} || String || human-readable identifier for miner
 
|-
 
|-
| balance || {{No}} || Number || amount of Bitcoins (in Satoshis) currently stored at the pool
+
| balances || {{No}} || Array of Objects || balance information
|-
 
| estimate || {{No}} || Number || amount of Bitcoins expected reward for the current round
 
 
|-
 
|-
 
| hashrate || {{No}} || Number || total hashrate of all mining in the same collaborative pool
 
| hashrate || {{No}} || Number || total hashrate of all mining in the same collaborative pool
Line 53: Line 53:
 
| workers || {{No}} || Array of Objects || information of specific workers
 
| workers || {{No}} || Array of Objects || information of specific workers
 
|}
 
|}
 +
 +
Balance info:
 +
{|
 +
! Key !! Required !! Type !! Description
 +
|-
 +
| currency || {{No}} || String || currency of balance
 +
|-
 +
| balance || {{No}} || Number || amount currently stored at the pool
 +
|-
 +
| estimate || {{No}} || Number || amount expected reward for the current round
 +
|-
 +
| paid || {{No}} || Number || amount that has been paid out ever
 +
|-
 +
| lastpay || {{No}} || Number || amount of last payout
 +
|-
 +
| lastpaytime || {{No}} || Number || time of last payout
 +
|}
 +
 +
Note: Bitcoin balances are in Satoshis

Revision as of 20:41, 22 May 2012

Key Required Type Description
version Yes Number always 1
group No Object information about the organizational pool
collab No Array of Objects information about each collaborative pool

Organizational pool:

Key Required Type Description
name No String human-readable identifier for organizational pool
hashrate No Number total hashrate of all mining in the organizational pool
miners No Array of Objects information of specific miners

Collaborative pool:

Key Required Type Description
name No String human-readable identifier for collaborative pool
hashrate No Number total hashrate of all mining in the same collaborative pool
roundbegin No Number time the current round began
roundshares No Number number of shares submitted to the current round
miners No Array of Objects information of specific miners

Individual miner:

Key Required Type Description
id No String unique identifier for a miner's account (shared across collaborative pools)
name No String human-readable identifier for miner
balances No Array of Objects balance information
hashrate No Number total hashrate of all mining in the same collaborative pool
lastactive No Number time the miner was last seen active
roundshares No Number number of shares submitted to the current round
workers No Array of Objects information of specific workers

Balance info:

Key Required Type Description
currency No String currency of balance
balance No Number amount currently stored at the pool
estimate No Number amount expected reward for the current round
paid No Number amount that has been paid out ever
lastpay No Number amount of last payout
lastpaytime No Number time of last payout

Note: Bitcoin balances are in Satoshis