Skip to main content

Add testnet BTC tokens to address

Add 1 BTC token to the specified testnet BTC address.

The endpoint returns the transaction ID, which you can use to view the transaction in a testnet Bitcoin block explorer. The tokens are delivered once the transaction has been included in a block.

Note: This is a testnet only endpoint. This endpoint will not work on the mainnet.

Query Parameters
address string REQUIRED

A valid testnet BTC address

Example: 2N4M94S1ZPt8HfxydXzL2P7qyzgVq7MHWts
Request Body
address string

BTC testnet address

Responses
200

Success

Schema OPTIONAL
success boolean

Indicates if the faucet call was successful

txId string OPTIONAL

The transaction ID for the faucet call

txRaw string OPTIONAL

Raw transaction in hex string representation

403

BTC Faucet not fully configured

Schema OPTIONAL
error string OPTIONAL
success boolean OPTIONAL
500

Faucet call failed