/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

1
curl -X 'POST' \
2
    'https://stacks-node-api.testnet.stacks.co/extended/v1/faucets/stx' \
3
    -H 'Content-Type: application/json' \
4
    --data '{
5
        "address":"ST3M7N9Q9HDRM7RVP1Q26P0EE69358PZZAZD7KMXQ"
6
    }'

Don't have an account yet?

Create your QuickNode endpoint in seconds and start building

Get started for free