Difference between revisions of "BIP PoolAPI"

From Bitcoin Wiki
Jump to: navigation, search
Line 1: Line 1:
 
{| class="wikitable"
 
{| class="wikitable"
−
! Key !! Required !! Type !! Description
+
! Key !! Type !! Description
 
|-
 
|-
−
| version || {{Yes}} || Number || always 1
+
!colspan='3'| Root
 
|-
 
|-
−
| group || {{No}} || Object || information about the organizational pool
+
| version || Number || always 1
 
|-
 
|-
−
| collab || {{No}} || Array of Objects || information about each collaborative pool
+
| group || Object || information about the organizational pool
−
|}
 
−
 
 
−
Organizational pool:
 
−
{| class="wikitable"
 
−
! Key !! Required !! Type !! Description
 
 
|-
 
|-
−
| name || {{No}} || String || human-readable identifier for organizational pool
+
| collab || Array of Objects || information about each collaborative pool
 
|-
 
|-
−
| hashrate || {{No}} || Number || total hashrate of all mining in the organizational pool
+
!colspan='3'| Organizational pool
 
|-
 
|-
−
| miners || {{No}} || Array of Objects || information of specific miners
+
! Key !! Type !! Description
−
|}
 
−
 
 
−
Collaborative pool:
 
−
{| class="wikitable"
 
−
! Key !! Required !! Type !! Description
 
 
|-
 
|-
−
| name || {{No}} || String || human-readable identifier for collaborative pool
+
| name || String || human-readable identifier for organizational pool
 
|-
 
|-
−
| hashrate || {{No}} || Number || total hashrate of all mining in the same collaborative pool
+
| hashrate || Number || total hashrate of all mining in the organizational pool
 
|-
 
|-
−
| roundbegin || {{No}} || Number || time the current round began
+
| miners || Array of Objects || information of specific miners
 
|-
 
|-
−
| roundshares || {{No}} || Number || number of shares submitted to the current round
+
!colspan='3'| Collaborative pool
 
|-
 
|-
−
| fee || {{No}} || Number || fee (0.01 = 1%)
+
! Key !! Type !! Description
 
|-
 
|-
−
| rewardalgo || {{No}} || String || reward algorithm identifier
+
| name || String || human-readable identifier for collaborative pool
 
|-
 
|-
−
| miners || {{No}} || Array of Objects || information of specific miners
+
| hashrate || Number || total hashrate of all mining in the same collaborative pool
−
|}
 
−
 
 
−
Individual miner:
 
−
{| class="wikitable"
 
−
! Key !! Required !! Type !! Description
 
 
|-
 
|-
−
| id || {{No}} || String || unique identifier for a miner's account (shared across collaborative pools)
+
| roundbegin || Number || time the current round began
 
|-
 
|-
−
| name || {{No}} || String || human-readable identifier for miner
+
| roundshares || Number || number of shares submitted to the current round
 
|-
 
|-
−
| balances || {{No}} || Array of Objects || balance information
+
| fee || Number || fee (0.01 = 1%)
 
|-
 
|-
−
| hashrate || {{No}} || Number || total hashrate of all mining in the same collaborative pool
+
| rewardalgo || String || reward algorithm identifier
 
|-
 
|-
−
| lastactive || {{No}} || Number || time the miner was last seen active
+
| miners || Array of Objects || information of specific miners
 
|-
 
|-
−
| roundshares || {{No}} || Number || number of shares submitted to the current round
+
!colspan='3'| Individual miner
 
|-
 
|-
−
| workers || {{No}} || Array of Objects || information of specific workers
+
! Key !! Type !! Description
−
|}
 
−
 
 
−
Balance info:
 
−
{|
 
−
! Key !! Required !! Type !! Description
 
 
|-
 
|-
−
| currency || {{No}} || String || currency of balance
+
| id || String || unique identifier for a miner's account (shared across collaborative pools)
 
|-
 
|-
−
| balance || {{No}} || Number || amount currently stored at the pool
+
| name || String || human-readable identifier for miner
 
|-
 
|-
−
| estimate || {{No}} || Number || amount expected reward for the current round
+
| balances || Array of Objects || balance information
 
|-
 
|-
−
| paid || {{No}} || Number || amount that has been paid out ever
+
| hashrate || Number || total hashrate of all mining in the same collaborative pool
 
|-
 
|-
−
| lastpay || {{No}} || Number || amount of last payout
+
| lastactive || Number || time the miner was last seen active
 
|-
 
|-
−
| lastpaytime || {{No}} || Number || time of last payout
+
| roundshares || Number || number of shares submitted to the current round
 +
|-
 +
| workers || Array of Objects || information of specific workers
 +
|-
 +
!colspan='3'| Balance info
 +
|-
 +
! Key !! Type !! Description
 +
|-
 +
| currency || String || currency of balance
 +
|-
 +
| balance || Number || amount currently stored at the pool
 +
|-
 +
| estimate || Number || amount expected reward for the current round
 +
|-
 +
| paid || Number || amount that has been paid out ever
 +
|-
 +
| lastpay || Number || amount of last payout
 +
|-
 +
| lastpaytime || Number || time of last payout
 
|}
 
|}
  
 
Note: Bitcoin balances are in Satoshis
 
Note: Bitcoin balances are in Satoshis

Revision as of 20:46, 22 May 2012

Key Type Description
Root
version Number always 1
group Object information about the organizational pool
collab Array of Objects information about each collaborative pool
Organizational pool
Key Type Description
name String human-readable identifier for organizational pool
hashrate Number total hashrate of all mining in the organizational pool
miners Array of Objects information of specific miners
Collaborative pool
Key Type Description
name String human-readable identifier for collaborative pool
hashrate Number total hashrate of all mining in the same collaborative pool
roundbegin Number time the current round began
roundshares Number number of shares submitted to the current round
fee Number fee (0.01 = 1%)
rewardalgo String reward algorithm identifier
miners Array of Objects information of specific miners
Individual miner
Key Type Description
id String unique identifier for a miner's account (shared across collaborative pools)
name String human-readable identifier for miner
balances Array of Objects balance information
hashrate Number total hashrate of all mining in the same collaborative pool
lastactive Number time the miner was last seen active
roundshares Number number of shares submitted to the current round
workers Array of Objects information of specific workers
Balance info
Key Type Description
currency String currency of balance
balance Number amount currently stored at the pool
estimate Number amount expected reward for the current round
paid Number amount that has been paid out ever
lastpay Number amount of last payout
lastpaytime Number time of last payout

Note: Bitcoin balances are in Satoshis

Retrieved from "https://tests.bitcoin.it/w/index.php?title=BIP_PoolAPI&oldid=27064"