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 Accounts API

Read-only endpoints to obtain Stacks account details

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

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

This API exposes 12 operations across 12 paths, and defines 1 schema. 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/.

12 operations 12 paths 1 schemas 12 GET

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 12

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

Accounts 12

Read-only endpoints to obtain Stacks account details

GET
/extended/v1/address/{principal}/stxdeprecated
Get account STX balance
get_account_stx_balance 3 params → 2004XX
GET
/extended/v1/address/{principal}/balancesdeprecated
Get account balances
get_account_balance 3 params → 2004XX
GET
/extended/v1/address/{principal}/transactionsdeprecated
Get account transactions
get_account_transactions 7 params → 2004XX
GET
/extended/v1/address/{principal}/{tx_id}/with_transfersdeprecated
Get account transaction information for specific transaction
get_single_transaction_with_transfers 2 params → 2004XX
GET
/extended/v1/address/{principal}/transactions_with_transfersdeprecated
Get account transactions including STX transfers for each transaction.
get_account_transactions_with_transfers 6 params → 2004XX
GET
/extended/v1/address/{principal}/assets
Get account assets
get_account_assets 5 params → 2004XX
GET
/extended/v1/address/{principal}/stx_inbound
Get inbound STX transfers
get_account_inbound 6 params → 2004XX
GET
/extended/v1/address/{principal}/nonces
Get the latest nonce used by an account
get_account_nonces 3 params → 2004XX
GET
/extended/v2/addresses/{principal}/balances/stx
Get principal STX balance
get_principal_stx_balance 2 params → 2004XX
GET
/extended/v2/addresses/{principal}/balances/ft
Get principal FT balances
get_principal_ft_balances 3 params → 2004XX
GET
/extended/v2/addresses/{principal}/balances/ft/{token}
Get principal FT balance
get_principal_ft_balance 2 params → 2004XX
GET
/v2/accounts/{principal}
Get account info
getAccountInfo 3 params → 200400404500

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. Each schema is shown below with its type and property counts.

AccountData

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hiro-accounts-api-openapi.yml Raw ↑

Other APIs Hiro publishes across the network.

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