Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Hiro Faucets API

Endpoints to request STX or BTC tokens (not possible on Mainnet)

Hiro Faucets API is one of 26 APIs that Hiro publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Faucets. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 3 operations across 3 paths. It is described by OpenAPI 3.0.3, at version 1.0.3.

Requests are made against 2 base URLs: https://api.hiro.so/, https://api.testnet.hiro.so/.

3 operations 3 paths 0 schemas 1 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0.3
Base URL
https://api.mainnet.hiro.so
Resource Areas
1

Paths & Operations 3

Across 3 paths, the API surfaces 3 operations — 1 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Faucets 3

Endpoints to request STX or BTC tokens (not possible on Mainnet)

POST
/extended/v1/faucets/btc
Add regtest BTC tokens to address
run_faucet_btc 3 params body → 2004XX
GET
/extended/v1/faucets/btc/{address}
Get BTC balance for address
get_btc_balance 1 param → 2004XX
POST
/extended/v1/faucets/stx
Get STX testnet tokens
run_faucet_stx 2 params body → 2004XX

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hiro-faucets-api-openapi.yml Raw ↑

Other APIs Hiro publishes across the network.

Hiro Chainhooks API
Hiro Platform API
Hiro Accounts API
Hiro Atlas API
Hiro Blocks API
Hiro Blocks Proposals API
Hiro Burn Blocks API
Hiro Fees API
Hiro Fungible Tokens API
Hiro Info API
Hiro Mempool API
Hiro Microblocks API