API Reference
The Minka Ledger API is a RESTful interface for managing financial infrastructure — ledgers, wallets, intents, signers, and more. All operations use JSON request/response bodies and require proper authentication.
Base URL
https://{ledger-host}/api/v2Authentication
Most endpoints require a signed request or a bearer token. See Securing the Ledger for details on signers, circles, and access policies.
Resources
Browse endpoints by resource type:
Ledger
Manage ledger instances and their global settings.
Intent
Create and track balance movements between wallets.
Wallet
Manage balance containers with routes and limits.
Signer
Register cryptographic identities for signing records.
Bridge
Connect the ledger to external systems and banking cores.
Policy
Define access control, consensus, and scheduling rules.
Anchor
Link wallets to external identifiers like bank accounts.
Symbol
Define currencies and token types with decimal precision.
Circle
Group signers for shared permissions.
Effect
Trigger webhooks or bridge calls on ledger events.
Schema
Define validation rules for record custom fields.
Domain
Namespace records for multi-tenant isolation.
Report
Generate and retrieve ledger reports.
OAuth
Exchange client credentials for bearer access tokens.
Request Journaling
Inspect logs of API requests and responses to the ledger.
OpenAPI Specification
Download the full OpenAPI 3.1 specification for use with Postman, SDK generators, or other tooling.
Download openapi.yaml
Common Patterns
Every resource in the API follows the same record structure. Understanding these patterns once helps you work with any resource:
- Key Concepts — Records, handles, hashes, and the ledger data model
- Query Syntax — Filtering, sorting, and paginating list endpoints
- Error Reference — Error codes and troubleshooting
