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

Read-only endpoints to obtain network, Proof-of-Transfer, Stacking, STX token, and node information

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

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

This API exposes 11 operations across 11 paths, and defines 4 schemas. 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/.

11 operations 11 paths 4 schemas 11 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 11

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

Info 11

Read-only endpoints to obtain network, Proof-of-Transfer, Stacking, STX token, and node information

GET
/extended
API status
get_status → 2004XX
GET
/extended/v1/stx_supply/
Get total and unlocked STX supply
get_stx_supply 2 params → 2004XX
GET
/extended/v1/stx_supply/total/plaindeprecated
Get total STX supply in plain text format
get_stx_supply_total_supply_plain → 2004XX
GET
/extended/v1/stx_supply/circulating/plaindeprecated
Get circulating STX supply in plain text format
get_stx_supply_circulating_plain → 2004XX
GET
/extended/v1/stx_supply/legacy_formatdeprecated
Get total and unlocked STX supply (results formatted the same as the legacy 1.0 API)
get_total_stx_supply_legacy_format 2 params → 2004XX
GET
/extended/v1/info/network_block_times
Get the network target block time
get_network_block_times → 2004XX
GET
/extended/v1/info/network_block_time/{network}
Get a given network's target block time
get_network_block_time_by_network 1 param → 2004XX
GET
/v2/info
Get Core API info
getNodeInfo → 200500
GET
/v2/pox
Get PoX details
getPoxInfo 1 param → 200400404500
GET
/v3/health
Query the health of the node.
getNodeHealth → 200400500
GET
/v2/neighbors
Get neighbor peers
getNetworkPeers → 200

Schemas 4

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

PoxInfo
GetHealth
NetworkPeers
NodeInfo

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hiro-info-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 Faucets API
Hiro Fees API
Hiro Fungible Tokens API
Hiro Mempool API
Hiro Microblocks API