Glossary

After submitting the request information, F2Pool API server will return data, which carries fields as below, via the response 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 Hashrate 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 Miner Hashrate
Location 2 Last 1 hour's hashrate
Location 3 Stale rejected hashes of last 1 hours
Location 4 Hashrate of last 24 hours
Location 5 Stale rejected hashes of last 24 hours
Location 6 Recently submitted time
Location 7 Extra Fields
value_workers Historical income (Dictionary)
Miner 1 Historical income
Miner 2 Historical income

Request Examples

Access to all APIs is to access http://api.f2pool.com via HTTP, and all correct data returned are received in JSON format, as below:


curl http://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

    http://api.f2pool.com/bitcoin/user
  2. LTC - Litecoin

    http://api.f2pool.com/litecoin/user
  3. Grin - Cuckarood29

    http://api.f2pool.com/grin-29/user
  4. Grin - Cuckaroo31+

    http://api.f2pool.com/grin-31/user
  5. ZEC

    http://api.f2pool.com/zcash/user
  6. ZEN

    http://api.f2pool.com/zen/user
  7. ZCL

    http://api.f2pool.com/zclassic/user
  8. CKB

    http://api.f2pool.com/nervos/user
  9. ETH - Ethereum ( Username )

    http://api.f2pool.com/ethereum/user
  10. ETH - Ethereum ( Address )

    http://api.f2pool.com/eth/address
  11. ETC - Ethereum Classic

    http://api.f2pool.com/etc/address
  12. ZEC - Zcash

    http://api.f2pool.com/zec/address
  13. SC - Siacoin

    http://api.f2pool.com/sc/address
  14. SC - Siacoin Classic

    http://api.f2pool.com/siaclassic/address
  15. XMR - Monero

    http://api.f2pool.com/monero/address
  16. Dash - Dash

    http://api.f2pool.com/dash/address
  17. DCR - Decred

    http://api.f2pool.com/decred/address
  18. XZC - Zcoin

    http://api.f2pool.com/zcoin/address
  19. RVN - Ravencoin

    http://api.f2pool.com/raven/address
  20. MONA - Monacoin

    http://api.f2pool.com/monacoin/address
  21. GRV - Gravium

    http://api.f2pool.com/grv/address
  22. ZEN - ZenCash

    http://api.f2pool.com/zen/address
  23. ZCL - Zclassic

    http://api.f2pool.com/zclassic/address
  24. ETN - Electroneum

    http://api.f2pool.com/electroneum/address
  25. BTM - Bytom

    http://api.f2pool.com/btm/address
  26. PASC - PascalCoin

    http://api.f2pool.com/pasc/address
  27. PGN - Pigeoncoin

    http://api.f2pool.com/pigeon/address
  28. XDAG - Xdag

    http://api.f2pool.com/xdag/address
  29. LUX - Lux

    http://api.f2pool.com/lux/address
  30. HDAC - Hdac

    http://api.f2pool.com/hdac/address
  31. HYC - Hycon

    http://api.f2pool.com/hycon/address
  32. AE - aeternity

    http://api.f2pool.com/aeternity/address
  33. ZCR - ZCore

    http://api.f2pool.com/zcore/address
  34. XSC - HyperSpace

    http://api.f2pool.com/hyperspace/address
  35. BCHSV - BitcoinCash SV

    http://api.f2pool.com/bitcoin-sv/address
  36. BCHABC - BitcoinCash ABC

    http://api.f2pool.com/bitcoin-cash/address
  37. SUQA - Suqa

    http://api.f2pool.com/suqa/address
  38. DERO - Dero

    http://api.f2pool.com/dero/address
  39. ETP - Metaverse

    http://api.f2pool.com/metaverse/address
  40. HCASH - HCash

    http://api.f2pool.com/hcash/address
  41. GIN - GinCoin

    http://api.f2pool.com/gincoin/address
  42. AION - Aion

    http://api.f2pool.com/aion/address
  43. BEAM - Beam

    http://api.f2pool.com/beam/address

An erroneous response message 404: Not Found would be received in cases where any currency other than the above ones have been requested to F2Pool API server or where the parameter user/address is illegal. Note: The sender who has delivered frequent, repeated malicious requests to F2Pool API server will be blacklisted or receive an erroneous response message 503: GateWay Timeout.

Request for Single User’s Data

Single user Request URL:

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

Response:


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

Request for 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 URL:

http://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,
       ...
   }
}
                    

Note: When one-time query of multiuser data is being used, 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 for Hashrate Data of Miner over the Last 24 Hours

Computing power data of miner in history Request URL

http://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,
        ...
    }
}