API methods

» Checking account balance

URL: https://faucetsystem.com/api/v1/balance
Method: POST
Required parameters:
  • api_key - faucet API key from the Manage zone (e.g. "8125081ceef60e674247960cfe347150ef2a5e663d7dceae2dcd453f21c96b00").
Request sample
api_key=8125081ceef60e674247960cfe347150ef2a5e663d7dceae2dcd453f21c96b00
Response sample (json)
{
    "status":200,
    "balance":26589758,
    "balance_bitcoin":"0.26589758"
}

» Sending satoshi

URL: https://faucetsystem.com/api/v1/send
Method: POST
Required parameters:
  • api_key - faucet API key from the Manage zone (e.g. "8125081ceef60e674247960cfe347150ef2a5e663d7dceae2dcd453f21c96b00").
  • to - bitcoin address to send satoshis to (e.g. "3Nxwenay9Z8Lc9JBiywExpnEFiLp6Afp8v").
  • amount - payout amount in satoshi (e.g. "85").
Optional parameters:
  • referral - mark a payment as referral (e.g. "1", "true", "yes").
  • ip - the ip address of the user requesting the payout (need for AntibotInside) (e.g. "8.8.8.8").
Request sample
api_key=8125081ceef60e674247960cfe347150ef2a5e663d7dceae2dcd453f21c96b00&to=3Nxwenay9Z8Lc9JBiywExpnEFiLp6Afp8v&amount=85
api_key=8125081ceef60e674247960cfe347150ef2a5e663d7dceae2dcd453f21c96b00&to=3Nxwenay9Z8Lc9JBiywExpnEFiLp6Afp8v&amount=85&referral=true
api_key=8125081ceef60e674247960cfe347150ef2a5e663d7dceae2dcd453f21c96b00&to=3Nxwenay9Z8Lc9JBiywExpnEFiLp6Afp8v&amount=85&referral=true&ip=8.8.8.8
api_key=8125081ceef60e674247960cfe347150ef2a5e663d7dceae2dcd453f21c96b00&to=3Nxwenay9Z8Lc9JBiywExpnEFiLp6Afp8v&amount=85&ip=8.8.8.8
Response sample (json)
{
    "status":200,
    "balance":26589673,
    "balance_bitcoin":"0.26589673"
}

» Error codes

{"status": 402, "message": "Insufficient funds."}
{"status": 403, "message": "Invalid API key."}
{"status": 404, "message": "Invalid API method."}
{"status": 412, "message": "Invalid 'to' address."}
{"status": 440, "message": "Invalid amount."}
{"status": 450, "message": "Owner of this faucet set a send limit, which was exceeded. Try again in 30 minutes."}
{"status": 452, "message": "API access disabled."}
{"status": 501, "message": "FaucetSystem.com is in maintenance mode, try again in five minutes."}
{"status": 1001, "message": "Invalid Ip."}