API methods and usage


All API v1 requests are HTTP POST requests. 1 satoshi = 10^-8 BTC. All responses are JSON with status attribute. status 200 means no error.

https://www.faucetfly.com/api/v1/send

Parameters

  • api_key - our API key from your site Dashboard
  • to - address to send coins to. It MUST be a valid address for selected currency, emails/usernames aren't supported.
  • amount - amount in satoshi to transfer.
  • referral - (optional) Set it to true if you're sending referral earnings. It's highly recommended, as it's shown to users on address check page.
  • currency - (optional) API name of selected currency (ex. "BTC"). Currently defaulting to BTC

Response fields

  • balance - Your balance in satoshi.
  • balance_bitcoin - Your balance for this currency in bitcoins (the same as balance divided by 10^8)

Example request

amount=1&to=12G4ax3KcMh1bQkpLrz5H12PbuAC2WZ95h&api_key=1bQkpLrz5H12PbuAC2WZ95h&currency=BTC

Example response

{
    "status":200,
    "balance":77519999889,
    "balance_bitcoin":"775.19999889"
}

https://www.faucetfly.com/api/v1/balance

Parameters

Response fields

  • balance - Your balance in satoshi.
  • balance_bitcoin - Your balance in bitcoin (the same as balance divided by 10^8)

Example request

api_key=1bQkpLrz5H12PbuAC2WZ95h

Example response

{
    "status":200,
    "balance":77519999889,
    "balance_bitcoin":"775.19999889"
}


{"status": 402, "message": "Insufficient funds."}

You don't have enough funds to make payment. Please login to deposit some coins to your own deposit address.

{"status": 403, "message": "Invalid API key."}

Provided API key is invalid. You can find your API keys in Sites "API token" page Sites.

{"status": 404, "message": "Invalid API request."}

You requested not existing method or you set parameters which are invalid, please check your parameters and try again.

{"status": 450, "message": "Owner of this faucet set a send limit, which was exceeded. Try again in 30 minutes."}

You reached send limits you've configured for your faucet. If you expected that, increase the limits in your sites configuration.