Skip to main content

/extended/v1/faucets/stx REST API Endpoint

Get STX testnet tokens.

Updated on
Oct 04, 2023

/extended/v1/faucets/stx 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 STX address.
stacking
boolean
Request the amount of STX tokens needed for individual address stacking.

Body Parameters

Content-Type
application/json
address
string
STX testnet address
stacking
boolean
Use required number of tokens for stacking

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
Don't have an account yet?
Create your QuickNode endpoint in seconds and start building
Get started for free