Skip to Content
Blockfrost APIsOverview

Blockfrost APIs

Yaci Store ships REST endpoints whose paths and response shapes follow the Blockfrost API .

The Blockfrost-compatible API Support is available since 3.0.0-beta3, and sub-modules now auto-enable with the parent flag.

Sub-modules

The Blockfrost extension is composed of nine sub-modules, each backing one resource group:

Sub-moduleProvides
addressAddress info, UTXOs, transactions
accountStake-account info, rewards, delegations, history
assetNative assets, policy listings, asset history
blockBlock lookup, block transactions, block addresses
epochEpoch info, protocol parameters, epoch stake
metadataTransaction metadata by label
scriptsScripts, datums, redeemers
transactionTransaction details, IO, certificates, withdrawals, and tx submit
utilTx execution-units evaluation and xpub-derived addresses

Each sub-module loads only when the parent extension is enabled, and can be disabled individually. See Configuration.

Modules in development

The following Blockfrost modules are still in development and will be added in later Yaci Store releases:

  • Pools
  • Governance
  • Network

Quickstart

1. Enable the extension in application.properties (or use the bundled blockfrost profile, which sets both lines for you):

store.extensions.blockfrost.enabled=true blockfrost.apiPrefix=/api/v1/blockfrost

blockfrost.apiPrefix has no default and is required — without it, the app fails to start.

2. Start yaci-store and let it sync.

3. Test the latest block to confirm the API is up:

curl http://localhost:8080/api/v1/blockfrost/blocks/latest

A JSON response with hash, slot, epoch, etc. means the extension is wired correctly.

API base path

All Blockfrost controllers are mapped under ${blockfrost.apiPrefix}. The blockfrost profile sets it to /api/v1/blockfrost so Blockfrost endpoints stay separate from yaci-store’s own /api/v1/... controllers. See Configuration → API base path.

Endpoint contracts

Request and response formats follow the official Blockfrost OpenAPI spec. Use docs.blockfrost.io  as the per-endpoint reference; this section only documents what is enabled and how to call it. See Supported Endpoints for the endpoint-group map.

Last updated on