Glossary

After submitting the request, the F2Pool API server will return the data with the following fields, in JSON format.

Field Description
balance Unpaid balance
paid Paid balance
payout_history Payouts history
value Total revenue
value_last_day Revenue of last 24 hours
stale_hashes_rejected_last_day Stale rejected hashes of last 24 hours
hashes_last_day Hashes of last 24 hours
hashrate Current hashrate
hashrate_history Hashes history of last 24 hours
worker_length Workers quantity
worker_length_online Online workers quantity
List Field
workers Workers data (List)
Location 0 Worker name
Location 1 Hashrate
Location 2 Last 1 hour's hashrate
Location 3 Rejected shares of past 1 hour
Location 4 Hashrate of last 24 hours
Location 5 Stale rejected hashes of last 24 hours
Location 6 Recently submitted shares
Location 7 Extra Fields
value_workers Historical income (Dictionary)
Miner 1 Historical income
Miner 2 Historical income

Request Examples

Access the API from https://api.f2pool.com via HTTP, and view the data in JSON format, as below:


curl https://api.f2pool.com/bitcoin/user

{
    "balance": 0.000045036645168645,
    "hashes_last_day": 0,
    "value": 0.000045036645168645,
    "stale_hashes_rejected_last_day": 0,
    "workers": [["minerx01", 12650560751040, 0, 0, 1084452716521979904, 2533274790395904, "2018-06-19T10:02:19.810789Z", false]],
    "value_workers": {"08ddb9f4552c": 4.211575399188521691, "018": 4.211575399188521691},
    "value_last_day": 0,
    "hashrate_history": {
        "2017-12-21T11:40:00Z": 0
    },
    "stale_hashes_rejected_last_hour": 0,
    "paid": 0,
    "hashes_last_hour": 0,
    "worker_length_online": 0,
    "payout_history": [["2017-11-01T00:00:00Z", "8f8fba3134ce15e9b0001e67cba93c4a2250445310b5cdada1ac676b5a19b8b9", 1.010047060000000000000000]],
    "worker_length": 0,
    "hashrate": 0
}
                    

Requesting user data in different currencies requires accessing the server through a different URL. Currently, you can get data in the following currencies:

  1. BTC - Bitcoin

    https://api.f2pool.com/bitcoin/user
  2. BCH - Bitcoin Cash

    https://api.f2pool.com/bitcoin-cash/user
  3. LTC - Litecoin

    https://api.f2pool.com/litecoin/user
  4. ETH - Ethereum( Username )

    https://api.f2pool.com/ethereum/user
  5. ETC - Ethereum Classic

    https://api.f2pool.com/ethereum-classic/user
  6. ETHW - ethw

    https://api.f2pool.com/ethereumpow/user
  7. ETHF - etf

    https://api.f2pool.com/ethereumfair/user
  8. ZEC - Zcash

    https://api.f2pool.com/zec/user
  9. ZEN - Horizen

    https://api.f2pool.com/zen/user
  10. DASH - Dash

    https://api.f2pool.com/dash/user
  11. HNS - Handshake

    https://api.f2pool.com/handshake/user
  12. KDA - Kadena

    https://api.f2pool.com/kadena/user
  13. CKB - Nervos CKB

    https://api.f2pool.com/nervos/user
  14. RVN - Ravencoin( Username )

    https://api.f2pool.com/raven/user
  15. CFX - Conflux

    https://api.f2pool.com/conflux/user
  16. ERG - Ergo

    https://api.f2pool.com/ergo/user
  17. MEER - Meer

    https://api.f2pool.com/qitmeer-meer/user
  18. ALEO - Aleo

    https://api.f2pool.com/aleo-test3/user
  19. ETH - Ethereum( Address )

    https://api.f2pool.com/eth/address
  20. SC - Siacoin

    https://api.f2pool.com/siacoin-new/address
  21. DCR - Decred

    https://api.f2pool.com/decred/address
  22. CHI - CHI-Xaya

    https://api.f2pool.com/xaya/address
  23. DGB-SHA256D - DigiByte

    https://api.f2pool.com/digibyte-sha256d/address
  24. DGB-SCRYPT - DigiByte

    https://api.f2pool.com/digibyte-scrypt/address
  25. DGB-SKEIN - DigiByte

    https://api.f2pool.com/digibyte-skein/address
  26. DGB-QUBIT - DigiByte

    https://api.f2pool.com/digibyte-qubit/address
  27. DGB-ODOCRYPT - DigiByte

    https://api.f2pool.com/digibyte-odo/address
  28. XVG-BLACK2S - Verge

    https://api.f2pool.com/verge-blake2s/address
  29. XVG-SCRYPT - Verge

    https://api.f2pool.com/verge-scrypt/address
  30. XVG-X17 - Verge

    https://api.f2pool.com/verge-x17/address
  31. XVG-LYRA2REV2 - Verge

    https://api.f2pool.com/verge-lyra/address
  32. XVG-GROESTL - Verge

    https://api.f2pool.com/verge-groestl/address
  33. RVN - Ravencoin( Address )

    https://api.f2pool.com/ravenp/address

An error message 404: Not Found will be displayed when any currencies other than those listed above have been requested from the F2Pool API server, or where the parameter user/address is illegal. Please note: Anyone who has delivered frequent, repeated malicious requests to the F2Pool API server will be blacklisted or receive an error message 503: GateWay Timeout.

Request Single User’s Data

Single user request:

https://api.f2pool.com/{currency}/{user}

Response:


{
    "balance": 0.000045036645168645,
    "hashes_last_day": 0,
    ...
}
                        

Request Multiple Users’ Data

F2Pool API allows requesting for detailed data of a single user or of multiple users at one time. Below is the URL for requesting for multiple users’ data:

Multiple users request:

https://api.f2pool.com/{currency}/{user1}?multi_account={user1}&multi_account={user2}

Response:


{
   user1:{
       "balance": 0.000045036645168645,
       "hashes_last_day": 0,
       ...
   },
   user2:{
       "balance": 0.000045036645168645,
       "hashes_last_day": 0,
       ...
   }
}
                    

Please note: When a one-time query of multi-user data is requested, the parameters in URL: {currency}, to which a legal currency account (or a legal address of an anonymous currency) shall be appended, otherwise the system will return: 404: Not Found.

Request Miner’s Hashrate Data of the Past 24 Hours

Historical miner hashrate data request:

https://api.f2pool.com/{currency}/{user}/{worker_name}

Response:


{
    "hashrate_history": {
        "2017-12-21T18:50:00Z": 22906492245,
        "2017-12-21T19:00:00Z": 16950804262,
        "2017-12-21T19:10:00Z": 20157713176,
        ...
    }
}