BTC Testnet tokens

Delivers testnet BTC tokens to a specified address.

POST
/extended/v1/faucets/btc

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.

Request Body (Optional)

addressstring

BTC testnet address

Status codeDescription
200Success
403BTC Faucet not fully configured
500Faucet call failed
/extended/v1/faucets/btc

curl -X POST "https://api.mainnet.hiro.so/extended/v1/faucets/btc" \
  -d '{
  "address": "2N4M94S1ZPt8HfxydXzL2P7qyzgVq7MHWts"
}'

POST request that initiates a transfer of tokens to a specified testnet address

{
  "success": true,
  "txId": "string",
  "txRaw": "string"
}