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

Endpoints for interacting with StackerDB instances.

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

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

This API exposes 5 operations across 5 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/.

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

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

StackerDB 5

Endpoints for interacting with StackerDB instances.

GET
/v2/stackerdb/{principal}/{contract_name}/{slot_id}
Get StackerDB chunk (latest version)
getStackerDbChunk 3 params → 200400404500
GET
/v2/stackerdb/{principal}/{contract_name}/{slot_id}/{slot_version}
Get StackerDB chunk (specific version)
getStackerDbChunkVersioned 4 params → 200400404500
GET
/v2/stackerdb/{principal}/{contract_name}
Get StackerDB metadata
getStackerDbMetadata 2 params → 200400404500
POST
/v2/stackerdb/{principal}/{contract_name}/chunks
Write StackerDB chunk
postStackerDbChunk 2 params body → 200400404500
GET
/v2/stackerdb/{principal}/{contract_name}/replicas
List StackerDB replicas
listStackerDbReplicas 2 params → 200400404500

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.

StackerDbMetadata
StackerDbChunkAckData
StackerDbChunkData
StackerDbReplicas

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hiro-stackerdb-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 Info API
Hiro Mempool API