Skip to main content

/extended/v1/faucets/btc REST API Endpoint

Add testnet BTC tokens to address.

Updated on
Oct 4, 2023

/extended/v1/faucets/btc REST API Endpoint

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

Query Parameters

address
string
REQUIRED
A valid testnet BTC address.

Body Parameters

Content-Type
application/json
address
string
BTC testnet address

Returns

object
object
POST request that initiates a transfer of tokens to a specified testnet address
success
boolean
Indicates if the faucet call was successful.
txId
string
The transaction ID for the faucet call.
txRaw
string
Raw transaction in hex string representation.
Request
1
curl -X 'POST' \
2
'https://stacks-node-api.testnet.stacks.co/extended/v1/faucets/btc' \
3
-H 'Content-Type: application/json' \
4
--data '{
5
"address":"2N4M94S1ZPt8HfxydXzL2P7qyzgVq7MHWts"
6
}'
7
Don't have an account yet?
Create your QuickNode endpoint in seconds and start building
Get started for free