HanzCEO / FaucetPayJS

NodeJS Based API collection of FaucetPay.io

Home Page:https://www.npmjs.com/package/faucetpayjs

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

FaucetPayJS

NodeJS Based API collection of FaucetPay.io

Installation

npm i --save faucetpayjs

API Endpoints

How to start

const { API } = require('FaucetPayJS');
const myAPI = new API(process.env.API_KEY);
myAPI.getBalance().then(data => {
	console.dir(data)
});

Response

{
  status: 200,
  message: 'OK',
  currency: 'BTC',
  balance: '174',
  balance_bitcoin: '0.00000174'
}

API Methods

Get Balance

API.getBalance(currency='BTC')
Aliases
API.balance

List Currencies

API.getCurrencies()
Aliases
API.currencies
API.checkCurrencies

Check If Address Linked

API.checkAddress(address, currency='BTC')
Aliases
API.isAddressExist
API.findAddress

Send Funds

API.send(amount, to, currency='BTC', referral=false, ipaddress='0.0.0.0')
Aliases
API.tip
API.transfer
API.withdraw

API.withdrawto

List Your Faucet's Payout

API.payouts(currency='BTC', count=100)
Aliases
API.getPayouts
API.listPayouts
API.recentPayouts

List Faucets on Faucet List

API.faucetlist()
Aliases
API.faucetList
API.listFaucet
API.faucetLists
API.listFaucets
API.fetchFaucet
API.fetchFaucets
API.retrieveFaucets
API.fetchRotator

End Notes

Thank you for visiting this page! Appreciate my works by Following, being a Stargazer, Contribute to the project or Donate me via cryptocurrency down below

BTC, ETH, LTC, BCH, DASH, DGB, FEY via FaucetPay (username: Hanz)
DOGE : DFazapEWQNFBDMRN4Soo4iGDRgdqKqUSfR
WAVES : use alias (hanz, hanzhaxors, haxors)

About

NodeJS Based API collection of FaucetPay.io

https://www.npmjs.com/package/faucetpayjs

License:ISC License


Languages

Language:JavaScript 100.0%