FaucetsSTX Testnet Tokens

STX Testnet Tokens

Delivers testnet STX tokens to a specified address.

POST

/extended/v1/faucets/stx

Add 500 STX tokens to the specified testnet address. Testnet STX addresses begin with ST. If the stacking parameter is set to true, the faucet will add the required number of tokens for individual stacking to the specified testnet address.

The endpoint returns the transaction ID, which you can use to view the transaction in the Stacks Explorer. The tokens are delivered once the transaction has been included in an anchor block.

A common reason for failed faucet transactions is that the faucet has run out of tokens. If you are experiencing failed faucet transactions to a testnet address, you can get help in Discord.

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

Query Parameters

address
Required
string

A valid testnet address

Example: ST1PQHQKV0RJXZFY1DGX8MNSNYVE3VGZJSRTPGZGM

stackingboolean

Request the amount of STX tokens needed for individual address stacking

Example: true | false
Status codeDescription
200Success
500Faucet call failed
Terminal
curl -X POST \
  "https://api.testnet.hiro.so/extended/v1/faucets/stx?address=ST1PQHQKV0RJXZFY1DGX8MNSNYVE3VGZJSRTPGZGM" \
  -H 'Accept: application/json'

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

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

Last updated on

BTC Testnet Tokens

Blocks