WARNING! THIS SITE IS ONLY FOR DEMONSTRATION PURPOSE! NO PAYMENTS WILL BE MADE.

Libraries


You can use one of our libraries:

  1. PHP Library - simple library, best choice if you already have a working faucet
  2. Faucet Script - ready to use faucet script, best choice if you don't have a faucet yet

API Methods


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.

Get balance

Request URL
  • http://bmpdemo.smartyscripts.com/api/v1/balance
Params
  • api_key A valid API Key from the website
Return Values
  • balance Your balance in satoshis (108)
Request Response
{
  "status": 200,
  "balance": 100000000
}

Send Payment

Request URL
  • http://bmpdemo.smartyscripts.com/api/v1/send
Params
  • api_key A valid API Key from the website
  • amount Amount that you want to send in satoshis (10^8). For example: 50
  • address The address which you wanna pay amount to
  • referral Indicate if this is a normal or referral payment. Set to true for a referral payment.
Return Values
  • balance The balance remaining after you paid up (in satoshis).
Request Response
{
  "status": 200,
  "balance": 100000000
}

Error Codes

Code Message Solution
400 Missing API Key Provide an API Key in your request
400 Missing address and/or amount fields Provide an address and amount in your request
400 Invalid amount format Provide an integer amount(without dot/comma) in your request
401 Request not authorized by API settings Setup the correct IP address of your hosting on Faucet Settings
403 Insufficient funds Deposit funds in your account
404 Invalid or inactive API Key Verify if your API Key is correct and active. Contact us if you need help