Matura Docs
API & Integration

Read endpoints

Public read-model endpoints served from the Postgres projection.

Read endpoints are public (@Public()) and serve the projection built by the indexer worker, with chain read-through where needed. Money is returned as base-unit decimal strings; addresses are lowercased.

Method & pathReturns
GET /api/v1/healthLiveness.
GET /api/v1/health/readyReadiness (503 during first-boot reindex).
GET /api/v1/account/:walletAccount overview — balances and owned claims for a wallet.
GET /api/v1/activity/:walletChronological executions + settlements for a wallet.
GET /api/v1/vaultsActive vaults with mandate, capital, and pricing.
GET /api/v1/claims/:claimIdA single claim's state and financed-face.
GET /api/v1/executions/:executionIdA single execution's status.
POST /api/v1/quotes/previewA non-binding financing quote preview for a claim.

Example

curl https://api.usematura.xyz/api/v1/vaults
curl https://api.usematura.xyz/api/v1/account/0xabc...123

Notes

  • Readiness vs liveness: health checks should target /health for liveness; /health/ready returns 503 while the worker performs its first reindex, so use it only where that's intended.
  • Finality: reads reflect the indexer's projection, which advances on finalized blocks — see Indexer & worker.
  • Authenticated reads: GET /claims/issued (claims issued by the caller) requires a bearer token — see Write-preparation.

On this page